ilBiblFieldFactoryInterface Interface Reference

Interface ilBiblFieldFactoryInterface. More...

Inheritance diagram for ilBiblFieldFactoryInterface:

Collaboration diagram for ilBiblFieldFactoryInterface:

Public Member Functions
	getFieldByTypeAndIdentifier (int $type, string $identifier)
	findOrCreateFieldByTypeAndIdentifier (int $type, string $identifier)
	getAvailableFieldsForObjId (int $obj_id)
	filterAllFieldsForType (ilBiblTypeInterface $type, ilBiblTableQueryInfoInterface $queryInfo=null)
	filterAllFieldsForTypeAsArray (ilBiblTypeInterface $type, ilBiblTableQueryInfoInterface $queryInfo=null)
	getType ()
	findById (int $id)
	findOrCreateFieldOfAttribute (ilBiblAttributeInterface $attribute)
	forcePosition (ilBiblFieldInterface $field)

Detailed Description

Interface ilBiblFieldFactoryInterface.

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 8 of file interface.ilBiblFieldFactoryInterface.php.

Member Function Documentation

filterAllFieldsForType()

ilBiblFieldFactoryInterface::filterAllFieldsForType	(	ilBiblTypeInterface	$type,
		ilBiblTableQueryInfoInterface	$queryInfo = null
	)

Parameters

\ilBiblTypeInterface	$type
\ilBiblTableQueryInfoInterface	$queryInfo

Returns

\ilBiblField[]

Implemented in ilBiblFieldFactory.

filterAllFieldsForTypeAsArray()

ilBiblFieldFactoryInterface::filterAllFieldsForTypeAsArray	(	ilBiblTypeInterface	$type,
		ilBiblTableQueryInfoInterface	$queryInfo = null
	)

Parameters

\ilBiblTypeInterface	$type
\ilBiblTableQueryInfoInterface | null	$queryInfo

Returns

array

Implemented in ilBiblFieldFactory.

findById()

ilBiblFieldFactoryInterface::findById

(

int

$id

)

Parameters

int

$id

Returns

\ilBiblFieldInterface

findOrCreateFieldByTypeAndIdentifier()

ilBiblFieldFactoryInterface::findOrCreateFieldByTypeAndIdentifier	(	int	$type,
		string	$identifier
	)

Parameters

int	$type	MUST be ilBiblTypeFactoryInterface::DATA_TYPE_RIS or ilBiblTypeFactoryInterface::DATA_TYPE_BIBTEX
string	$identifier

Exceptions

ilException if a wrong $type is passed

Returns

\ilBiblFieldInterface

Implemented in ilBiblFieldFactory.

findOrCreateFieldOfAttribute()

ilBiblFieldFactoryInterface::findOrCreateFieldOfAttribute

(

ilBiblAttributeInterface

$attribute

)

Parameters

\ilBiblAttributeInterface

$attribute

Returns

\ilBiblFieldInterface

Implemented in ilBiblFieldFactory.

forcePosition()

ilBiblFieldFactoryInterface::forcePosition

(

ilBiblFieldInterface

$field

)

Parameters

ilBiblFieldInterface

$field

Returns

int new position

Implemented in ilBiblFieldFactory.

getAvailableFieldsForObjId()

ilBiblFieldFactoryInterface::getAvailableFieldsForObjId

(

int

$obj_id

)

Parameters

int

$obj_id

Returns

ilBiblFieldInterface[] instances of all known standard-fields for the given type

Implemented in ilBiblFieldFactory.

getFieldByTypeAndIdentifier()

ilBiblFieldFactoryInterface::getFieldByTypeAndIdentifier	(	int	$type,
		string	$identifier
	)

Parameters

int	$type	MUST be ilBiblTypeFactoryInterface::DATA_TYPE_RIS or ilBiblTypeFactoryInterface::DATA_TYPE_BIBTEX
string	$identifier

Exceptions

ilException if a wrong $type is passed or field is not found

Returns

\ilBiblFieldInterface

Implemented in ilBiblFieldFactory.

getType()

ilBiblFieldFactoryInterface::getType

(

)

Returns

\ilBiblTypeInterface

Implemented in ilBiblFieldFactory.

---

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

• Modules/Bibliographic/interfaces/Field/interface.ilBiblFieldFactoryInterface.php