ilBiblFieldFactory Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilBiblFieldFactory:

Collaboration diagram for ilBiblFieldFactory:

Public Member Functions
	__construct (\ilBiblTypeInterface $type)
	ilBiblFieldFactory constructor. More...
	getType ()
	getFieldByTypeAndIdentifier (int $type, string $identifier)
	Parameters int $type MUST be ilBiblTypeFactoryInterface::DATA_TYPE_RIS or ilBiblTypeFactoryInterface::DATA_TYPE_BIBTEX Exceptions More...
	findOrCreateFieldByTypeAndIdentifier (int $type, string $identifier)
	Parameters int $type MUST be ilBiblTypeFactoryInterface::DATA_TYPE_RIS or ilBiblTypeFactoryInterface::DATA_TYPE_BIBTEX Exceptions More...
	getAvailableFieldsForObjId (int $obj_id)
	filterAllFieldsForType (ilBiblTypeInterface $type, ilBiblTableQueryInfoInterface $queryInfo=null)
	filterAllFieldsForTypeAsArray (ilBiblTypeInterface $type, ilBiblTableQueryInfoInterface $queryInfo=null)
	findOrCreateFieldOfAttribute (ilBiblAttributeInterface $attribute)
	forcePosition (ilBiblFieldInterface $field)
Public Member Functions inherited from ilBiblFieldFactoryInterface
	findById (int $id)

Protected Attributes
ilBiblTypeInterface	$type

Private Member Functions
	getNextFreePosition (ilBiblFieldInterface $field)
	getARInstance (int $type, string $identifier)
	getCollectionForFilter (ilBiblTypeInterface $type, ilBiblTableQueryInfoInterface $queryInfo=null)

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilBiblFieldFactory

Author

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

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

Constructor & Destructor Documentation

__construct()

ilBiblFieldFactory::__construct

(

\ilBiblTypeInterface

$type

)

ilBiblFieldFactory constructor.

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

References $type.

    {
        $this->type = $type;
    }

Member Function Documentation

filterAllFieldsForType()

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

Implements ilBiblFieldFactoryInterface.

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

References getCollectionForFilter().

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

Here is the call graph for this function:

filterAllFieldsForTypeAsArray()

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

Implements ilBiblFieldFactoryInterface.

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

References getCollectionForFilter().

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

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

Exceptions

Implements ilBiblFieldFactoryInterface.

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

References getARInstance(), and getType().

Referenced by getAvailableFieldsForObjId().

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

        return $inst;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

findOrCreateFieldOfAttribute()

ilBiblFieldFactory::findOrCreateFieldOfAttribute

(

ilBiblAttributeInterface

$attribute

)

Implements ilBiblFieldFactoryInterface.

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

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

                                                                                     : 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;
    }

Here is the call graph for this function:

forcePosition()

ilBiblFieldFactory::forcePosition

(

ilBiblFieldInterface

$field

)

Implements ilBiblFieldFactoryInterface.

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

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

                                                              : 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();
    }

Here is the call graph for this function:

getARInstance()

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

private

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

References ActiveRecord\where().

Referenced by findOrCreateFieldByTypeAndIdentifier(), and getFieldByTypeAndIdentifier().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getAvailableFieldsForObjId()

ilBiblFieldFactory::getAvailableFieldsForObjId

(

int

$obj_id

)

Implements ilBiblFieldFactoryInterface.

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

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

                                                           : 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;
    }

Here is the call graph for this function:

getCollectionForFilter()

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

private

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

References ActiveRecord\getCollection(), and ilBiblTypeInterface\getId().

Referenced by filterAllFieldsForType(), and filterAllFieldsForTypeAsArray().

                                                                                                                       : \ActiveRecordList
    {
        $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;
    }

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

Exceptions

PhpIncompatibleReturnTypeInspection

Implements ilBiblFieldFactoryInterface.

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

References getARInstance().

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

        return $inst;
    }

Here is the call graph for this function:

getNextFreePosition()

ilBiblFieldFactory::getNextFreePosition ( ilBiblFieldInterface  $field )

private

Parameters

ilBiblFieldInterface

$field

Returns

int

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

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

                                                                     : 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;
    }

Here is the call graph for this function:

getType()

ilBiblFieldFactory::getType

(

)

Implements ilBiblFieldFactoryInterface.

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

References $id, $type, ilBiblFieldFactoryInterface\findById(), and ActiveRecord\findOrFail().

Referenced by findOrCreateFieldByTypeAndIdentifier().

                             : ilBiblTypeInterface
    {
        return $this->type;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$type

ilBiblTypeInterface ilBiblFieldFactory::$type

protected

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

Referenced by __construct(), and getType().

---

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

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