ilBiblAttributeFactory 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 ilBiblAttributeFactory:

Collaboration diagram for ilBiblAttributeFactory:

Public Member Functions
	__construct (protected \ilBiblFieldFactoryInterface $field_factory)
	getPossibleValuesForFieldAndObject (ilBiblFieldInterface $field, int $object_id)
	@inheritDoc More...
	getAttributesForEntry (ilBiblEntryInterface $entry)
	@inheritDoc More...
	sortAttributesArray (array $attributes)
	sortAttributes (array $attributes)
	createAttribute (string $name, string $value, int $entry_id)
	@inheritDoc More...
	getPossibleValuesForFieldAndObject (ilBiblFieldInterface $field, int $object_id)
	getAttributesForEntry (ilBiblEntryInterface $entry)
	sortAttributes (array $attributes)
	sortAttributesArray (array $attributes)
	createAttribute (string $name, string $value, int $entry_id)

Protected Attributes
ilDBInterface	$db

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 ilBiblAttributeFactory

Author

: Benjamin Seglias bs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 23 of file class.ilBiblAttributeFactory.php.

Constructor & Destructor Documentation

__construct()

ilBiblAttributeFactory::__construct

(

protected \ilBiblFieldFactoryInterface

$field_factory

)

Definition at line 27 of file class.ilBiblAttributeFactory.php.

    {
        global $DIC;
        $this->db = $DIC->database();
    }

References $DIC.

Member Function Documentation

createAttribute()

ilBiblAttributeFactory::createAttribute	(	string	$name,
		string	$value,
		int	$entry_id
	)

@inheritDoc

Implements ilBiblAttributeFactoryInterface.

Definition at line 100 of file class.ilBiblAttributeFactory.php.

                                                                               : bool
    {
        $ilBiblAttribute = new ilBiblAttribute();
        $ilBiblAttribute->setName($name);
        $ilBiblAttribute->setValue($value);
        $ilBiblAttribute->setEntryId($entry_id);
        $ilBiblAttribute->store();
 
        $this->field_factory->findOrCreateFieldOfAttribute($ilBiblAttribute);
 
        return true;
    }

getAttributesForEntry()

ilBiblAttributeFactory::getAttributesForEntry

(

ilBiblEntryInterface

$entry

)

@inheritDoc

Implements ilBiblAttributeFactoryInterface.

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

                                                                      : array
    {
        return ilBiblAttribute::where(['entry_id' => $entry->getId()])->get();
    }

References ilBiblEntryInterface\getId(), and ActiveRecord\where().

Here is the call graph for this function:

getPossibleValuesForFieldAndObject()

ilBiblAttributeFactory::getPossibleValuesForFieldAndObject	(	ilBiblFieldInterface	$field,
		int	$object_id
	)

@inheritDoc

Implements ilBiblAttributeFactoryInterface.

Definition at line 36 of file class.ilBiblAttributeFactory.php.

                                                                                                   : array
    {
        $q = "SELECT DISTINCT(a.value) FROM il_bibl_data AS d
JOIN il_bibl_entry AS e ON e.data_id = d.id
JOIN il_bibl_attribute AS a on a.entry_id = e.id
WHERE a.name = %s AND d.id = %s";
 
        $res = $this->db->queryF($q, ['text', 'integer'], [
            $field->getIdentifier(),
            $object_id,
        ]);
        $result = [];
        while ($data = $this->db->fetchObject($res)) {
            $result[$data->value] = $data->value;
        }
 
        return $result;
    }

References $data, $q, $res, and ilBiblFieldInterface\getIdentifier().

Here is the call graph for this function:

sortAttributes()

ilBiblAttributeFactory::sortAttributes

(

array

$attributes

)

Parameters

\ilBiblAttributeInterface[]

$attributes

Returns

\ilBiblAttributeInterface[]

Implements ilBiblAttributeFactoryInterface.

Definition at line 75 of file class.ilBiblAttributeFactory.php.

                                                     : array
    {
        $sorted = [];
        $type_id = $this->field_factory->getType()->getId();
        $max = 0;
        foreach ($attributes as $attribute) {
            if (!$attribute->getName()) {
                continue;
            }
            $field = $this->field_factory->findOrCreateFieldByTypeAndIdentifier($type_id, $attribute->getName());
            $position = $field->getPosition();
            $position = $position ?: $max + 1;
 
            $max = (max($position, $max));
            $sorted[$position] = $attribute;
        }
 
        ksort($sorted);
 
        return $sorted;
    }

sortAttributesArray()

ilBiblAttributeFactory::sortAttributesArray

(

array

$attributes

)

Implements ilBiblAttributeFactoryInterface.

Definition at line 63 of file class.ilBiblAttributeFactory.php.

                                                          : array
    {
        $type_id = $this->field_factory->getType()->getId();
        uksort($attributes, function ($key_a, $key_b) use ($type_id): int {
            $field_a = $this->field_factory->findOrCreateFieldByTypeAndIdentifier($type_id, $key_a);
            $field_b = $this->field_factory->findOrCreateFieldByTypeAndIdentifier($type_id, $key_b);
 
            return $field_a->getPosition() - $field_b->getPosition();
        });
 
        return $attributes;
    }

Field Documentation

$db

ilDBInterface ilBiblAttributeFactory::$db

protected

Definition at line 25 of file class.ilBiblAttributeFactory.php.

---

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

• components/ILIAS/Bibliographic/classes/Attribute/class.ilBiblAttributeFactory.php