ilBiblEntryFactory Class Reference

Class ilBiblEntryFactory. 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 ($entry_id)
	findByIdAndTypeString ($id, $type_string)
	findOrCreateEntry ($id, $bibliographic_obj_id, $entry_type)
	createEntry ($bibliographic_obj_id, $entry_type)
	getEmptyInstance ()
	filterEntriesForTable ($object_id, ilBiblTableQueryInfo $info=null)
	filterEntryIdsForTableAsArray ($object_id, ilBiblTableQueryInfo $info=null)
	deleteEntryById ($id)
	getAllEntries ($object_id)
	Read all entries from the database. More...
	getEntryById ($id)
	Get entry from the database. More...
	getAllAttributesByEntryId ($id)
	getFileType ()
	setFileType ($file_type)
	setAttributes ($attributes)
	getAttributes ()

Protected Attributes
	$bibliographic_obj_id
	$entry_id
	$type
	$attributes
	$file_type
	$field_factory
	$overview_factory

Private Member Functions
	getARInstance ($id)

Detailed Description

Class ilBiblEntryFactory.

Author

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

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

Constructor & Destructor Documentation

__construct()

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

ilBiblEntryFactory constructor.

Parameters

ilBiblFieldFactoryInterface	$field_factory
ilBiblTypeInterface	$file_type

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

References $field_factory, $file_type, and $overview_factory.

    {
        $this->file_type = $file_type;
        $this->field_factory = $field_factory;
        $this->overview_factory = $overview_factory;
    }

Member Function Documentation

createEntry()

ilBiblEntryFactory::createEntry	(		$bibliographic_obj_id,
			$entry_type
	)

Implements ilBiblEntryFactoryInterface.

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

References $bibliographic_obj_id.

Referenced by findOrCreateEntry().

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

        return $inst;
    }

Here is the caller graph for this function:

deleteEntryById()

ilBiblEntryFactory::deleteEntryById

(

$id

)

Parameters

int

$id

Implements ilBiblEntryFactoryInterface.

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

References ActiveRecord\where().

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

Here is the call graph for this function:

filterEntriesForTable()

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

Implements ilBiblEntryFactoryInterface.

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

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

    {
        $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	(		$object_id,
		ilBiblTableQueryInfo	$info = null
	)

Implements ilBiblEntryFactoryInterface.

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

References $DIC, and $i.

Referenced by filterEntriesForTable().

    {
        global $DIC;

        $types = ["integer"];
        $values = [$object_id];

        if ($info instanceof ilBiblTableQueryInfo) {
            $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 " . $DIC->database()->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 = array();
        $set = $DIC->database()->queryF($q, $types, $values);

        $i = 0;
        while ($rec = $DIC->database()->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	(		$id,
			$type_string
	)

Implements ilBiblEntryFactoryInterface.

Definition at line 119 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	(		$id,
			$bibliographic_obj_id,
			$entry_type
	)

Implements ilBiblEntryFactoryInterface.

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

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

    {
        $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

(

$id

)

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

References ActiveRecord\where().

Referenced by loadParsedAttributesByEntryId().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getAllEntries()

ilBiblEntryFactory::getAllEntries

(

$object_id

)

Read all entries from the database.

Parameters

int

$object_id

Returns

[]

Implements ilBiblEntryFactoryInterface.

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

References ActiveRecord\where().

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

Here is the call graph for this function:

getARInstance()

ilBiblEntryFactory::getARInstance (   $id )

private

Parameters

int

$id

Returns

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

References ActiveRecord\where().

Referenced by findOrCreateEntry().

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

References $attributes.

    {
        return $this->attributes;
    }

getEmptyInstance()

ilBiblEntryFactory::getEmptyInstance

(

)

Implements ilBiblEntryFactoryInterface.

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

    {
        return new ilBiblEntry();
    }

getEntryById()

ilBiblEntryFactory::getEntryById

(

$id

)

Get entry from the database.

Parameters

int

$object_id

Returns

Implements ilBiblEntryFactoryInterface.

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

References ActiveRecord\where().

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

Here is the call graph for this function:

getFileType()

ilBiblEntryFactory::getFileType

(

)

Returns

string

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

References $file_type.

    {
        return $this->file_type;
    }

loadParsedAttributesByEntryId()

ilBiblEntryFactory::loadParsedAttributesByEntryId

(

$entry_id

)

Implements ilBiblEntryFactoryInterface.

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

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

    {
        $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

(

$attributes

)

Parameters

$attributes

ilBiblFieldInterface[]

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

References $attributes.

    {
        $this->attributes = $attributes;
    }

setFileType()

ilBiblEntryFactory::setFileType

(

$file_type

)

Parameters

string

$file_type

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

References $file_type.

    {
        $this->file_type = $file_type;
    }

Field Documentation

$attributes

ilBiblEntryFactory::$attributes

protected

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

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

$bibliographic_obj_id

ilBiblEntryFactory::$bibliographic_obj_id

protected

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

Referenced by createEntry(), and findOrCreateEntry().

$entry_id

ilBiblEntryFactory::$entry_id

protected

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

Referenced by filterEntriesForTable(), and loadParsedAttributesByEntryId().

$field_factory

ilBiblEntryFactory::$field_factory

protected

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

Referenced by __construct().

$file_type

ilBiblEntryFactory::$file_type

protected

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

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

$overview_factory

ilBiblEntryFactory::$overview_factory

protected

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

Referenced by __construct().

$type

ilBiblEntryFactory::$type

protected

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

Referenced by loadParsedAttributesByEntryId().

---

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

• Modules/Bibliographic/classes/Entry/class.ilBiblEntryFactory.php