Class ilBiblFieldFactory. More...

Inheritance diagram for ilBiblFieldFactory:

Collaboration diagram for ilBiblFieldFactory:

Public Member Functions

__construct (\ilBiblTypeInterface $type)

ilBiblFieldFactory constructor. More...

getType ()

Returns: \ilBiblTypeInterface

More...

getFieldByTypeAndIdentifier (int $type, string $identifier)

Parameters

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

Returns: \ilBiblFieldInterface

Exceptions

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

findOrCreateFieldByTypeAndIdentifier (int $type, string $identifier)

Parameters

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

Returns: \ilBiblFieldInterface

Exceptions

ilException if a wrong $type is passed More...

getAvailableFieldsForObjId (int $obj_id)

@inheritDoc More...

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

@inheritDoc More...

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

@inheritDoc More...

findOrCreateFieldOfAttribute (ilBiblAttributeInterface $attribute)

@inheritDoc More...

forcePosition (ilBiblFieldInterface $field)

@inheritDoc More...

Public Member Functions inherited from ilBiblFieldFactoryInterface

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)

Protected Attributes
	$type

Private Member Functions
	getNextFreePosition (ilBiblFieldInterface $field)

	getARInstance ($type, $identifier)

	checkType ($type)

	getCollectionForFilter (ilBiblTypeInterface $type, ilBiblTableQueryInfoInterface $queryInfo=null)

Detailed Description

Class ilBiblFieldFactory.

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

Definition at line 8 of file class.ilBiblFieldFactory.php.

Constructor & Destructor Documentation

◆ __construct()

ilBiblFieldFactory::__construct ( \ilBiblTypeInterface $type )

ilBiblFieldFactory constructor.

Parameters

\ilBiblTypeInterface $type

Definition at line 22 of file class.ilBiblFieldFactory.php.

    {
        $this->type = $type;
    }

References $type.

Member Function Documentation

◆ checkType()

ilBiblFieldFactory::checkType ( $type )

private

Parameters

$type

Exceptions

ilException

Definition at line 221 of file class.ilBiblFieldFactory.php.

    {
        switch ($type) {
            case ilBiblTypeFactoryInterface::DATA_TYPE_BIBTEX:
            case ilBiblTypeFactoryInterface::DATA_TYPE_RIS:
                break;
            default:
                throw new ilException("bibliografic type not found");
        }
    }

References $type, ilBiblTypeFactoryInterface\DATA_TYPE_BIBTEX, and ilBiblTypeFactoryInterface\DATA_TYPE_RIS.

Referenced by findOrCreateFieldByTypeAndIdentifier(), and getFieldByTypeAndIdentifier().

Here is the caller graph for this function:

◆ filterAllFieldsForType()

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

@inheritDoc

Implements ilBiblFieldFactoryInterface.

Definition at line 119 of file class.ilBiblFieldFactory.php.

                                                                                                                       : array
    {
        return $this->getCollectionForFilter($type, $queryInfo)->get();
    }

References getCollectionForFilter().

Here is the call graph for this function:

◆ filterAllFieldsForTypeAsArray()

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

@inheritDoc

Implements ilBiblFieldFactoryInterface.

Definition at line 128 of file class.ilBiblFieldFactory.php.

                                                                                                                              : array
    {
        return $this->getCollectionForFilter($type, $queryInfo)->getArray();
    }

References getCollectionForFilter().

Here is the call graph for this function:

◆ findOrCreateFieldByTypeAndIdentifier()

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

Parameters

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

Returns: \ilBiblFieldInterface

Exceptions

ilException if a wrong $type is passed

Implements ilBiblFieldFactoryInterface.

Definition at line 73 of file class.ilBiblFieldFactory.php.

                                                                                        : ilBiblFieldInterface
    {
        $this->checkType($type);
        $inst = $this->getARInstance($type, $identifier);
        if (!$inst) {
            $inst = new ilBiblField();
            $inst->setIdentifier($identifier);
            $inst->setDataType($type);
            $inst->setIsStandardField((bool) $this->getType()->isStandardField($identifier));
            $inst->create();
        }
        $inst->setDataType($type);
        $inst->setIdentifier($identifier);
        $inst->setIsStandardField((bool) $this->getType()->isStandardField($identifier));
        $inst->update();
 
        return $inst;
    }

References $type, checkType(), getARInstance(), and getType().

Referenced by getAvailableFieldsForObjId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findOrCreateFieldOfAttribute()

ilBiblFieldFactory::findOrCreateFieldOfAttribute ( ilBiblAttributeInterface $attribute )

@inheritDoc

Implements ilBiblFieldFactoryInterface.

Definition at line 137 of file class.ilBiblFieldFactory.php.

                                                                                      : ilBiblFieldInterface
    {
        $field = ilBiblField::where(['identifier' => $attribute->getName()])->first();
        if ($field === null) {
            $field = new ilBiblField();
            $field->setIdentifier($attribute->getName());
            $field->setDataType($this->type->getId());
            $field->setIsStandardField($this->type->isStandardField($attribute->getName()));
            $field->create();
        } else {
            $field->setDataType($this->type->getId());
            $field->update();
        }
 
        return $field;
    }

References ilBiblAttributeInterface\getName(), and ActiveRecord\where().

Here is the call graph for this function:

◆ forcePosition()

ilBiblFieldFactory::forcePosition ( ilBiblFieldInterface $field )

@inheritDoc

Implements ilBiblFieldFactoryInterface.

Definition at line 158 of file class.ilBiblFieldFactory.php.

                                                               : int
    {
        global $DIC;
        $tablename = ilBiblField::TABLE_NAME;
        $q = "UPDATE {$tablename} SET position = position + 1 WHERE data_type = %s AND position >= %s;";
        $DIC->database()->manipulateF(
            $q,
            ['integer', 'integer'],
            [
                $field->getDataType(),
                $field->getPosition(),
            ]
        );
        $field->store();
        $DIC->database()->query("SET @i=0");
        $DIC->database()->manipulateF(
            "UPDATE {$tablename} SET position = (@i := @i + 1) WHERE data_type = %s ORDER BY position",
            ['integer'],
            [
                $field->getDataType(),
            ]
        );
 
        return (int) $field->getPosition();
    }

References $DIC, ilBiblFieldInterface\getDataType(), ilBiblFieldInterface\getPosition(), ilBiblFieldInterface\store(), and ilBiblField\TABLE_NAME.

Here is the call graph for this function:

◆ getARInstance()

ilBiblFieldFactory::getARInstance	(	$type,
		$identifier
	)

private

Parameters

int	$type
string	$identifier

Returns: \ilBiblField

Definition at line 210 of file class.ilBiblFieldFactory.php.

    {
        return ilBiblField::where(["identifier" => $identifier, "data_type" => $type])->first();
    }

References $type, and ActiveRecord\where().

Referenced by findOrCreateFieldByTypeAndIdentifier(), and getFieldByTypeAndIdentifier().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAvailableFieldsForObjId()

ilBiblFieldFactory::getAvailableFieldsForObjId ( int $obj_id )

@inheritDoc

Implements ilBiblFieldFactoryInterface.

Definition at line 96 of file class.ilBiblFieldFactory.php.

                                                            : array
    {
        global $DIC;
        $sql
            = "SELECT DISTINCT(il_bibl_attribute.name), il_bibl_data.file_type FROM il_bibl_data 
                                        JOIN il_bibl_entry ON il_bibl_entry.data_id = il_bibl_data.id
                                        JOIN il_bibl_attribute ON il_bibl_attribute.entry_id = il_bibl_entry.id
                                WHERE il_bibl_data.id = %s;";
 
        $result = $DIC->database()->queryF($sql, ['integer'], [$obj_id]);
 
        $data = [];
        while ($d = $DIC->database()->fetchObject($result)) {
            $data[] = $this->findOrCreateFieldByTypeAndIdentifier($d->file_type, $d->name);
        }
 
        return $data;
    }

References $d, $data, $DIC, $result, and findOrCreateFieldByTypeAndIdentifier().

Here is the call graph for this function:

◆ getCollectionForFilter()

ilBiblFieldFactory::getCollectionForFilter	(	ilBiblTypeInterface	$type,
		ilBiblTableQueryInfoInterface	$queryInfo = `null`
	)

private

Parameters

\ilBiblTypeInterface	$type
\ilBiblTableQueryInfoInterface	$queryInfo

Returns: \ActiveRecordList

Definition at line 239 of file class.ilBiblFieldFactory.php.

    {
        $collection = ilBiblField::getCollection();
 
        $collection->where(array('data_type' => $type->getId()));
 
        if ($queryInfo) {
            $sorting_column = $queryInfo->getSortingColumn() ? $queryInfo->getSortingColumn() : null;
            $offset = $queryInfo->getOffset() ? $queryInfo->getOffset() : 0;
            $sorting_direction = $queryInfo->getSortingDirection();
            $limit = $queryInfo->getLimit();
            if ($sorting_column) {
                $collection->orderBy($sorting_column, $sorting_direction);
            }
            $collection->limit($offset, $limit);
 
            foreach ($queryInfo->getFilters() as $queryFilter) {
                switch ($queryFilter->getFieldName()) {
                    default:
                        $collection->where(array($queryFilter->getFieldName() => $queryFilter->getFieldValue()), $queryFilter->getOperator());
                        break;
                }
            }
        }
 
        return $collection;
    }

References $type, and ActiveRecord\getCollection().

Referenced by filterAllFieldsForType(), and filterAllFieldsForTypeAsArray().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFieldByTypeAndIdentifier()

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

Parameters

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

Returns: \ilBiblFieldInterface

Exceptions

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

Implements ilBiblFieldFactoryInterface.

Definition at line 58 of file class.ilBiblFieldFactory.php.

                                                                               : ilBiblFieldInterface
    {
        $this->checkType($type);
        $inst = $this->getARInstance($type, $identifier);
        if (!$inst) {
            throw new ilException("bibliografic identifier {$identifier} not found");
        }
 
        return $inst;
    }

References checkType(), and getARInstance().

Here is the call graph for this function:

◆ getNextFreePosition()

ilBiblFieldFactory::getNextFreePosition ( ilBiblFieldInterface $field )

private

Parameters

ilBiblFieldInterface $field

Returns: int

Definition at line 192 of file class.ilBiblFieldFactory.php.

                                                                      : int
    {
        global $DIC;
        $tablename = ilBiblField::TABLE_NAME;
        $q = "SELECT MAX(position) + 1 as next_position FROM {$tablename} WHERE data_type = %s;";
        $res = $DIC->database()->queryF($q, ['integer'], [$field->getDataType()]);
        $data = $DIC->database()->fetchObject($res);
 
        return (int) $data->next_position;
    }

References $data, $DIC, $res, ilBiblFieldInterface\getDataType(), and ilBiblField\TABLE_NAME.

Here is the call graph for this function:

◆ getType()

ilBiblFieldFactory::getType ( )

Returns: \ilBiblTypeInterface

Implements ilBiblFieldFactoryInterface.

Definition at line 31 of file class.ilBiblFieldFactory.php.

                              : ilBiblTypeInterface
    {
        return $this->type;
    }

References $type.

Referenced by findOrCreateFieldByTypeAndIdentifier().

Here is the caller graph for this function:

Field Documentation

◆ $type

ilBiblFieldFactory::$type

protected

Definition at line 14 of file class.ilBiblFieldFactory.php.

Referenced by __construct(), checkType(), findOrCreateFieldByTypeAndIdentifier(), getARInstance(), getCollectionForFilter(), and getType().

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

Modules/Bibliographic/classes/Field/class.ilBiblFieldFactory.php

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkType()

◆ filterAllFieldsForType()

◆ filterAllFieldsForTypeAsArray()

◆ findOrCreateFieldByTypeAndIdentifier()

◆ findOrCreateFieldOfAttribute()

◆ forcePosition()

◆ getARInstance()

◆ getAvailableFieldsForObjId()

◆ getCollectionForFilter()

◆ getFieldByTypeAndIdentifier()

◆ getNextFreePosition()

◆ getType()

Field Documentation

◆ $type