IsisConnector Class Reference

Inheritance diagram for IsisConnector:

List of all members.

Public Member Functions
	getRows ($field)
	getValues ($field)
	getItem ($field, $item, $row=0)
	getItems ($field, $item)
	getMainItem ($field, $row=0)
	getMainItems ($field)
	getSubfield ($field, $subfield, $row=0)
	getSubfields ($field, $subfield)
	explodeSubfield ($field, $subfield, $row)
	explodeItem ($field, $item, $row)
	filterSubfield ($field, $subfield, $row)
	hasItem ($field, $item, $row=0)
	hasMainItem ($field, $row)
	hasSubfield ($field, $subfield, $row)
	existingItemKeys ($field, $row=0)
	hasFieldSubfieldCondition ($field, $subfield, $key, $subkey)
	specialItem ($field, $subfield, $return= 'boolean')

---

Detailed Description

IsisConnector: provides an easy interface to connect an application with Cinisis.

---

Member Function Documentation

IsisConnector::existingItemKeys	(	$	field,
		$	row = 0
	)

Return the existing key items for a result.

Parameters:

	$field	Field data.
	$row	Row number.

Returns:

Array with existing item keys

Todo:

Test.

IsisConnector::explodeItem	(	$	field,
		$	item,
		$	row
	)

Explode brackets for a given item, avoiding null entries.

Parameters:

	$field	Field data.
	$item	Item.
	$row	Row number.

Returns:

Exploded item data.

IsisConnector::explodeSubfield	(	$	field,
		$	subfield,
		$	row
	)

Explode brackets for a given subfield, avoiding null entries.

Parameters:

	$field	Field data.
	$subfield	Subfield.
	$row	Row number.

Returns:

Exploded subfield data.

IsisConnector::filterSubfield	(	$	field,
		$	subfield,
		$	row
	)

Filter brackets for a given subfield.

Parameters:

	$field	Field data.
	$subfield	Subfield.
	$row	Row number.

Returns:

Filterd subfield data.

IsisConnector::getItem	(	$	field,
		$	item,
		$	row = 0
	)

Get both main field or subfields from a given field and row.

Parameters:

	$field	field array.
	$item	item name (field or subfield).
	$row	row number.

Returns:

Item data.

IsisConnector::getItems	(	$	field,
		$	item
	)

Get all rows both main field or subfields from a given field.

Parameters:

	$field	field array.
	$item	item name (field or subfield).

Returns:

Item data.

IsisConnector::getMainItem	(	$	field,
		$	row = 0
	)

Get the value of a given field.

Parameters:

	$field	Field array.
	$row	Optional row number if repetitive field.

Returns:

Field data.

IsisConnector::getMainItems

(

$

field

)

Get all values of a given field.

Parameters:

$field

Field array.

Returns:

Field data.

IsisConnector::getRows

(

$

field

)

Get the number of resulting rows for a given field.

Parameters:

$field

Field array.

Returns:

Number of rows.

IsisConnector::getSubfield	(	$	field,
		$	subfield,
		$	row = 0
	)

Get the value of a given subfield.

Parameters:

	$field	Field array.
	$subfield	Subfield name.
	$row	Row number if repetitive data.

Returns:

Subfield data.

IsisConnector::getSubfields	(	$	field,
		$	subfield
	)

Get all values of a given subfield.

Parameters:

	$field	Field array.
	$subfield	Subfield name.

Returns:

Subfield data.

IsisConnector::getValues

(

$

field

)

Get all values of a given field.

Parameters:

$field

Field array.

Returns:

Field data.

IsisConnector::hasFieldSubfieldCondition	(	$	field,
		$	subfield,
		$	key,
		$	subkey
	)

Check if a field and subfield match a given condition.

Parameters:

	$field	Field data.
	$subfield	Subfield.
	$key	Field key.
	$subkey	Subfield key.

Returns:

True if condition match, false otherwise.

IsisConnector::hasItem	(	$	field,
		$	item,
		$	row = 0
	)

Check if a field result has an item.

Parameters:

	$field	Field data.
	$item	Item code ('main' for the main item).
	$row	Row number.

Returns:

True if result has the main item, false otherwise.

IsisConnector::hasMainItem	(	$	field,
		$	row
	)

Check if a field result has a main item.

Parameters:

	$field	Field data.
	$row	Row number.

Returns:

True if result has the main item, false otherwise.

IsisConnector::hasSubfield	(	$	field,
		$	subfield,
		$	row
	)

Check if a field result and row has a given subfield.

Parameters:

	$field	Field data.
	$subfield	Subfield.
	$row	Row number.

Returns:

True if result has the subfield, false otherwise.

IsisConnector::specialItem	(	$	field,
		$	subfield,
		$	return = 'boolean'
	)

Deal with special items.

Parameters:

	$field	Field data from ISIS database schema.
	$subfield	Subfield name.
	$return	Specify return type.

Returns:

True if special subfield, false otherwise of special return type

---

The documentation for this class was generated from the following file:

• classes/IsisConnector.php