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

Collaboration diagram for ilBiblEntryFactory:

Public Member Functions
	__construct (ilBiblFieldFactoryInterface $field_factory, \ilBiblTypeInterface $file_type, ilBiblOverviewModelFactoryInterface $overview_factory)
	ilBiblEntryFactory constructor. More...
	loadParsedAttributesByEntryId (int $entry_id)
	findByIdAndTypeString (int $id, string $type_string)
	findOrCreateEntry (int $id, int $bibliographic_obj_id, string $entry_type)
	createEntry (int $bibliographic_obj_id, string $entry_type)
	getEmptyInstance ()
	filterEntriesForTable (int $object_id, ilBiblTableQueryInfo $info=null)
	filterEntryIdsForTableAsArray (int $object_id, ?ilBiblTableQueryInfo $info=null)
	deleteEntryById (int $id)
	deleteEntriesById (int $object_id)
	getAllAttributesByEntryId (int $id)
	getFileType ()
	setFileType (string $file_type)
	setAttributes (array $attributes)
	getAttributes ()

Protected Attributes
int	$bibliographic_obj_id
int	$entry_id
string	$type
array	$attributes
ilBiblTypeInterface	$file_type
ilBiblFieldFactoryInterface	$field_factory
ilBiblOverviewModelFactoryInterface	$overview_factory
ilDBInterface	$db

Private Member Functions
	getARInstance (int $id)

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 ilBiblEntryFactory

Author

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

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

Constructor & Destructor Documentation

__construct()

ilBiblEntryFactory::__construct	(	ilBiblFieldFactoryInterface	$field_factory,
		\ilBiblTypeInterface	$file_type,
		ilBiblOverviewModelFactoryInterface	$overview_factory
	)

ilBiblEntryFactory constructor.

Definition at line 39 of file class.ilBiblEntryFactory.php.

References $DIC, $field_factory, $file_type, and $overview_factory.

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

Member Function Documentation

createEntry()

ilBiblEntryFactory::createEntry	(	int	$bibliographic_obj_id,
		string	$entry_type
	)

Implements ilBiblEntryFactoryInterface.

Definition at line 108 of file class.ilBiblEntryFactory.php.

Referenced by findOrCreateEntry().

                                                                              : \ilBiblEntryInterface
    {
        $inst = new ilBiblEntry();
        $inst->setDataId($bibliographic_obj_id);
        $inst->setEntryType($entry_type);
        $inst->create();

        return $inst;
    }

Here is the caller graph for this function:

deleteEntriesById()

ilBiblEntryFactory::deleteEntriesById

(

int

$object_id

)

Implements ilBiblEntryFactoryInterface.

Definition at line 197 of file class.ilBiblEntryFactory.php.

                                                     : void
    {
        $this->db->manipulateF("DELETE FROM il_bibl_entry WHERE data_id = %s", ['integer'], [$object_id]);
    }

deleteEntryById()

ilBiblEntryFactory::deleteEntryById

(

int

$id

)

Implements ilBiblEntryFactoryInterface.

Definition at line 189 of file class.ilBiblEntryFactory.php.

References ActiveRecord\where().

                                            : void
    {
        $entry = ilBiblEntry::where(array('id' => $id))->first();
        if ($entry instanceof ilBiblEntry) {
            $entry->delete();
        }
    }

Here is the call graph for this function:

filterEntriesForTable()

ilBiblEntryFactory::filterEntriesForTable	(	int	$object_id,
		ilBiblTableQueryInfo	$info = null
	)

Returns

[]

Implements ilBiblEntryFactoryInterface.

Definition at line 132 of file class.ilBiblEntryFactory.php.

References $entry_id, filterEntryIdsForTableAsArray(), and findByIdAndTypeString().

                                                                                            : array
    {
        $entries = $this->filterEntryIdsForTableAsArray($object_id, $info);
        $entry_objects = [];
        foreach ($entries as $entry_id => $entry) {
            $entry_objects[$entry_id] = $this->findByIdAndTypeString($entry['type'], $entry['id']);
        }

        return $entry_objects;
    }

Here is the call graph for this function:

filterEntryIdsForTableAsArray()

ilBiblEntryFactory::filterEntryIdsForTableAsArray	(	int	$object_id,
		?ilBiblTableQueryInfo	$info = null
	)

Implements ilBiblEntryFactoryInterface.

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

References $q.

Referenced by filterEntriesForTable().

                                                                                                     : array
    {
        $types = ["integer"];
        $values = [$object_id];

        $filters = $info->getFilters();
        if (!empty($filters)) {
            $q = "SELECT (e.id), e.type FROM il_bibl_entry AS e WHERE data_id = %s";
            foreach ($filters as $filter) {
                $value = $filter->getFieldValue();
                if (!$value) {
                    continue;
                }
                if ($filter->getOperator() === "IN" && is_array($filter->getFieldValue())) {
                    $types[] = "text";
                    $values[] = $filter->getFieldName();
                    $q .= " AND e.id IN (SELECT a.entry_id FROM il_bibl_attribute AS a WHERE a.name = %s AND " . $this->db->in("a.value", $value, false, "text") . ")";
                } else {
                    $types[] = "text";
                    $values[] = $filter->getFieldName();
                    $types[] = "text";
                    $values[] = "{$value}";
                    $q .= " AND e.id IN (SELECT a.entry_id FROM il_bibl_attribute AS a WHERE a.name = %s AND a.value {$filter->getOperator()} %s )";
                }
            }
        } else {
            $q = "SELECT DISTINCT (e.id), e.type FROM il_bibl_entry AS e
                JOIN il_bibl_attribute AS a ON a.entry_id = e.id
                        WHERE data_id = %s";
        }
        $entries = [];
        $set = $this->db->queryF($q, $types, $values);

        $i = 0;
        while ($rec = $this->db->fetchAssoc($set)) {
            $entries[$i]['entry_id'] = $rec['id'];
            $entries[$i]['entry_type'] = $rec['type'];
            $i++;
        }

        return $entries;
    }

Here is the caller graph for this function:

findByIdAndTypeString()

ilBiblEntryFactory::findByIdAndTypeString	(	int	$id,
		string	$type_string
	)

PhpIncompatibleReturnTypeInspection

Implements ilBiblEntryFactoryInterface.

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

References ActiveRecord\where().

Referenced by filterEntriesForTable().

                                                                       : ilBiblEntryInterface
    {
        return ilBiblEntry::where(array('id' => $id))->first();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

findOrCreateEntry()

ilBiblEntryFactory::findOrCreateEntry	(	int	$id,
		int	$bibliographic_obj_id,
		string	$entry_type
	)

Implements ilBiblEntryFactoryInterface.

Definition at line 92 of file class.ilBiblEntryFactory.php.

References createEntry(), and getARInstance().

                                                                                             : \ilBiblEntryInterface
    {
        $inst = $this->getARInstance($id);
        if (!$inst) {
            $inst = $this->createEntry($bibliographic_obj_id, $entry_type);
        }
        $inst->setDataId($bibliographic_obj_id);
        $inst->setEntryType($entry_type);
        $inst->update();

        return $inst;
    }

Here is the call graph for this function:

getAllAttributesByEntryId()

ilBiblEntryFactory::getAllAttributesByEntryId

(

int

$id

)

Returns

[]

Definition at line 205 of file class.ilBiblEntryFactory.php.

References ActiveRecord\where().

Referenced by loadParsedAttributesByEntryId().

                                                      : array
    {
        return ilBiblAttribute::where(array('entry_id' => $id))->get();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getARInstance()

ilBiblEntryFactory::getARInstance ( int  $id )

private

PhpIncompatibleReturnTypeInspection

Definition at line 123 of file class.ilBiblEntryFactory.php.

References ActiveRecord\where().

Referenced by findOrCreateEntry().

                                           : ?\ilBiblEntry
    {
        return ilBiblEntry::where(["ïd" => $id])->first();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAttributes()

ilBiblEntryFactory::getAttributes

(

)

Returns

string[]

Deprecated:

REFACTOR nach refactoring von loadAttributes Methoden die getAttributes verwenden entsprechend anpassen. (Statt Array Objekte verwenden)

Definition at line 232 of file class.ilBiblEntryFactory.php.

References $attributes.

                                   : array
    {
        return $this->attributes;
    }

getEmptyInstance()

ilBiblEntryFactory::getEmptyInstance

(

)

Implements ilBiblEntryFactoryInterface.

Definition at line 118 of file class.ilBiblEntryFactory.php.

                                      : \ilBiblEntry
    {
        return new ilBiblEntry();
    }

getFileType()

ilBiblEntryFactory::getFileType

(

)

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

References $file_type.

                                 : \ilBiblTypeInterface
    {
        return $this->file_type;
    }

loadParsedAttributesByEntryId()

ilBiblEntryFactory::loadParsedAttributesByEntryId

(

int

$entry_id

)

Implements ilBiblEntryFactoryInterface.

Definition at line 51 of file class.ilBiblEntryFactory.php.

References ilBiblTypeFactoryInterface\DATA_TYPE_RIS, getAllAttributesByEntryId(), and ActiveRecord\where().

                                                                : array
    {
        $ilBiblEntry = ilBiblEntry::where(array('id' => $entry_id))->first();
        $attributes = $this->getAllAttributesByEntryId($entry_id);

        if ($this->file_type->getId() == ilBiblTypeFactoryInterface::DATA_TYPE_RIS) {
            //for RIS-Files also add the type;
            $type = $ilBiblEntry->getType();
        } else {
            $type = 'default';
        }
        $parsed_attributes = array();
        foreach ($attributes as $attribute) {
            $value = $this->secure($attribute->getValue());
            // surround links with <a href="">
            // Allowed signs in URL: a-z A-Z 0-9 . ? & _ / - ~ ! ' * ( ) + , : ; @ = $ # [ ] %
            $value = preg_replace('!(http)(s)?:\/\/[a-zA-Z0-9.?&_/\-~\!\'\*()+,:;@=$#\[\]%]+!', "<a href=\"\\0\" target=\"_blank\">\\0</a>", $value);



            $attribute->setValue($value);
            $parsed_attributes[strtolower($this->file_type->getStringRepresentation() . '_' . $type . '_' . $attribute->getName())] = $value;

            $this->field_factory->findOrCreateFieldOfAttribute($attribute);
        }

        return $parsed_attributes;
    }

Here is the call graph for this function:

setAttributes()

ilBiblEntryFactory::setAttributes

(

array

$attributes

)

Parameters

ilBiblFieldInterface[]

$attributes

Definition at line 223 of file class.ilBiblEntryFactory.php.

References $attributes.

                                                    : void
    {
        $this->attributes = $attributes;
    }

setFileType()

ilBiblEntryFactory::setFileType

(

string

$file_type

)

Definition at line 215 of file class.ilBiblEntryFactory.php.

References $file_type.

                                                  : void
    {
        $this->file_type = $file_type;
    }

Field Documentation

$attributes

array ilBiblEntryFactory::$attributes

protected

Definition at line 29 of file class.ilBiblEntryFactory.php.

Referenced by getAttributes(), and setAttributes().

$bibliographic_obj_id

int ilBiblEntryFactory::$bibliographic_obj_id

protected

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

$db

ilDBInterface ilBiblEntryFactory::$db

protected

Definition at line 33 of file class.ilBiblEntryFactory.php.

$entry_id

int ilBiblEntryFactory::$entry_id

protected

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

Referenced by filterEntriesForTable().

$field_factory

ilBiblFieldFactoryInterface ilBiblEntryFactory::$field_factory

protected

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

Referenced by __construct().

$file_type

ilBiblTypeInterface ilBiblEntryFactory::$file_type

protected

Definition at line 30 of file class.ilBiblEntryFactory.php.

Referenced by __construct(), getFileType(), and setFileType().

$overview_factory

ilBiblOverviewModelFactoryInterface ilBiblEntryFactory::$overview_factory

protected

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

Referenced by __construct().

$type

string ilBiblEntryFactory::$type

protected

Definition at line 28 of file class.ilBiblEntryFactory.php.

---

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

• components/ILIAS/Bibliographic/classes/Entry/class.ilBiblEntryFactory.php