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 (protected \ilBiblFieldFactoryInterface $field_factory, protected \ilBiblTypeInterface $file_type, protected \ilBiblOverviewModelFactoryInterface $overview_factory)
	ilBiblEntryFactory constructor. More...

	loadParsedAttributesByEntryId (int $entry_id)
	@inheritDoc More...

	findByIdAndTypeString (int $id, string $type_string)
	@inheritDoc More...

	findOrCreateEntry (int $id, int $bibliographic_obj_id, string $entry_type)
	@inheritDoc More...

	createEntry (int $bibliographic_obj_id, string $entry_type)
	@inheritDoc More...

	getEmptyInstance ()

	filterEntriesForTable (int $object_id, ?ilBiblTableQueryInfo $info=null)

	filterEntryIdsForTableAsArray (int $object_id, ?ilBiblTableQueryInfo $info=null)
	@inheritDoc More...

	deleteEntryById (int $id)

	deleteEntriesById (int $object_id)

	getAllAttributesByEntryId (int $id)

	getFileType ()

	setFileType (string $file_type)

	setAttributes (array $attributes)

	getAttributes ()

	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)

	loadParsedAttributesByEntryId (int $entry_id)
	Reads all the entrys attributes from database. More...

Protected Attributes
int	$bibliographic_obj_id

int	$entry_id

string	$type

array	$attributes

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 23 of file class.ilBiblEntryFactory.php.

Constructor & Destructor Documentation

◆ __construct()

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

ilBiblEntryFactory constructor.

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

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

References $DIC.

Member Function Documentation

◆ createEntry()

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

@inheritDoc

Implements ilBiblEntryFactoryInterface.

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

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

References $bibliographic_obj_id.

Referenced by findOrCreateEntry().

Here is the caller graph for this function:

◆ deleteEntriesById()

ilBiblEntryFactory::deleteEntriesById ( int $object_id )

Implements ilBiblEntryFactoryInterface.

Definition at line 187 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 179 of file class.ilBiblEntryFactory.php.

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

References $id, and ActiveRecord\where().

Here is the call graph for this function:

◆ filterEntriesForTable()

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

Returns: \ilBiblEntryInterface[]

Implements ilBiblEntryFactoryInterface.

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

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

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

Here is the call graph for this function:

◆ filterEntryIdsForTableAsArray()

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

@inheritDoc

Implements ilBiblEntryFactoryInterface.

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

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

References $info, and $q.

Referenced by filterEntriesForTable().

Here is the caller graph for this function:

◆ findByIdAndTypeString()

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

@inheritDoc

@noinspection PhpIncompatibleReturnTypeInspection

Implements ilBiblEntryFactoryInterface.

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

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

References $id, and ActiveRecord\where().

Referenced by filterEntriesForTable().

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
	)

@inheritDoc

Implements ilBiblEntryFactoryInterface.

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

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

References $bibliographic_obj_id, createEntry(), and getARInstance().

Here is the call graph for this function:

◆ getAllAttributesByEntryId()

ilBiblEntryFactory::getAllAttributesByEntryId ( int $id )

Returns: \ilBiblAttribute[]

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

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

References $id, and ActiveRecord\where().

Referenced by loadParsedAttributesByEntryId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getARInstance()

ilBiblEntryFactory::getARInstance ( int $id )

private

@noinspection PhpIncompatibleReturnTypeInspection

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

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

References $id, and ActiveRecord\where().

Referenced by findOrCreateEntry().

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 222 of file class.ilBiblEntryFactory.php.

                                   : array
    {
        return $this->attributes;
    }

References $attributes.

◆ getEmptyInstance()

ilBiblEntryFactory::getEmptyInstance ( )

Implements ilBiblEntryFactoryInterface.

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

                                      : \ilBiblEntry
    {
        return new ilBiblEntry();
    }

◆ getFileType()

ilBiblEntryFactory::getFileType ( )

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

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

◆ loadParsedAttributesByEntryId()

ilBiblEntryFactory::loadParsedAttributesByEntryId ( int $entry_id )

@inheritDoc

Implements ilBiblEntryFactoryInterface.

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

                                                                : array
    {
        $ilBiblEntry = ilBiblEntry::where(['id' => $entry_id])->first();
        $attributes = $this->getAllAttributesByEntryId($entry_id);
 
        $type = $this->file_type->getId() == ilBiblTypeFactoryInterface::DATA_TYPE_RIS ? $ilBiblEntry->getType() : 'default';
        $parsed_attributes = [];
        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;
    }

References $attributes, $entry_id, $type, ilBiblTypeFactoryInterface\DATA_TYPE_RIS, getAllAttributesByEntryId(), and ActiveRecord\where().

Here is the call graph for this function:

◆ setAttributes()

ilBiblEntryFactory::setAttributes ( array $attributes )

Parameters

ilBiblFieldInterface[] $attributes

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

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

References $attributes.

◆ setFileType()

ilBiblEntryFactory::setFileType ( string $file_type )

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

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

Field Documentation

◆ $attributes

array ilBiblEntryFactory::$attributes

protected

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

Referenced by getAttributes(), loadParsedAttributesByEntryId(), and setAttributes().

◆ $bibliographic_obj_id

int ilBiblEntryFactory::$bibliographic_obj_id

protected

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

Referenced by createEntry(), and findOrCreateEntry().

◆ $db

ilDBInterface ilBiblEntryFactory::$db

protected

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

◆ $entry_id

int ilBiblEntryFactory::$entry_id

protected

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

Referenced by filterEntriesForTable(), and loadParsedAttributesByEntryId().

◆ $type

string ilBiblEntryFactory::$type

protected

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

Referenced by loadParsedAttributesByEntryId().

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

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

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createEntry()

◆ deleteEntriesById()

◆ deleteEntryById()

◆ filterEntriesForTable()

◆ filterEntryIdsForTableAsArray()

◆ findByIdAndTypeString()

◆ findOrCreateEntry()

◆ getAllAttributesByEntryId()

◆ getARInstance()

◆ getAttributes()

◆ getEmptyInstance()

◆ getFileType()

◆ loadParsedAttributesByEntryId()

◆ setAttributes()

◆ setFileType()

Field Documentation

◆ $attributes

◆ $bibliographic_obj_id

◆ $db

◆ $entry_id

◆ $type