ilMDLocation Class Reference

Inheritance diagram for ilMDLocation:

Collaboration diagram for ilMDLocation:

Public Member Functions
	setLocation (string $a_location)
	getLocation ()
	setLocationType (string $a_location_type)
	getLocationType ()
	save ()
	update ()
	delete ()
	__getFields ()
	read ()
	toXML (ilXmlWriter $writer)
Public Member Functions inherited from ilMDBase
	__construct (int $a_rbac_id=0, int $a_obj_id=0, string $a_type='')
	constructor More...
	read ()
	setRBACId (int $a_id)
	getRBACId ()
	setObjId (int $a_id)
	getObjId ()
	setObjType (string $a_type)
	getObjType ()
	setMetaId (int $a_meta_id, bool $a_read_data=true)
	getMetaId ()
	setParentType (string $a_parent_type)
	getParentType ()
	setParentId (int $a_id)
	getParentId ()
	setExportMode (bool $a_export_mode=true)
	getExportMode ()
	validate ()
	update ()
	save ()
	delete ()
	toXML (ilXmlWriter $writer)

Static Public Member Functions
static	_getIds (int $a_rbac_id, int $a_obj_id, int $a_parent_id, string $a_parent_type)

Private Attributes
string	$location = ''
string	$location_type = ''

Additional Inherited Members
Protected Attributes inherited from ilMDBase
ilLogger	$log
ilDBInterface	$db

Detailed Description

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

Member Function Documentation

__getFields()

ilMDLocation::__getFields

(

)

Returns

array<string, array<string, mixed>>

Definition at line 88 of file class.ilMDLocation.php.

                                 : array
    {
        return array(
            'rbac_id' => array('integer', $this->getRBACId()),
            'obj_id' => array('integer', $this->getObjId()),
            'obj_type' => array('text', $this->getObjType()),
            'parent_type' => array('text', $this->getParentType()),
            'parent_id' => array('integer', $this->getParentId()),
            'location' => array('text', $this->getLocation()),
            'location_type' => array('text', $this->getLocationType())
        );
    }

References getLocation(), getLocationType(), ilMDBase\getObjId(), ilMDBase\getObjType(), ilMDBase\getParentId(), ilMDBase\getParentType(), and ilMDBase\getRBACId().

Referenced by save(), and update().

Here is the call graph for this function:

Here is the caller graph for this function:

_getIds()

static ilMDLocation::_getIds ( int  $a_rbac_id, int  $a_obj_id, int  $a_parent_id, string  $a_parent_type  )

static

Returns

int[]

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

                                                                                                          : array
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $query = "SELECT meta_location_id FROM il_meta_location " .
            "WHERE rbac_id = " . $ilDB->quote($a_rbac_id, 'integer') . " " .
            "AND obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " " .
            "AND parent_id = " . $ilDB->quote($a_parent_id, 'integer') . " " .
            "AND parent_type = " . $ilDB->quote($a_parent_type, 'text');
 
        $res = $ilDB->query($query);
        $ids = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $ids[] = (int) $row->meta_location_id;
        }
        return $ids;
    }

References $DIC, $ilDB, $query, $res, ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().

Referenced by ilMDTechnical\getLocationIds().

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilMDLocation::delete

(

)

Reimplemented from ilMDBase.

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

                            : bool
    {
        if ($this->getMetaId()) {
            $query = "DELETE FROM il_meta_location " .
                "WHERE meta_location_id = " . $this->db->quote($this->getMetaId(), 'integer');
            $res = $this->db->manipulate($query);
 
            return true;
        }
        return false;
    }

References $query, $res, and ilMDBase\getMetaId().

Here is the call graph for this function:

getLocation()

ilMDLocation::getLocation

(

)

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

                                 : string
    {
        return $this->location;
    }

References $location.

Referenced by __getFields(), and toXML().

Here is the caller graph for this function:

getLocationType()

ilMDLocation::getLocationType

(

)

Definition at line 47 of file class.ilMDLocation.php.

                                     : string
    {
        return $this->location_type;
    }

References $location_type.

Referenced by __getFields(), and toXML().

Here is the caller graph for this function:

read()

ilMDLocation::read

(

)

Reimplemented from ilMDBase.

Definition at line 101 of file class.ilMDLocation.php.

                          : bool
    {
        if ($this->getMetaId()) {
            $query = "SELECT * FROM il_meta_location " .
                "WHERE meta_location_id = " . $this->db->quote($this->getMetaId(), 'integer');
 
            $res = $this->db->query($query);
            while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
                $this->setRBACId((int) $row->rbac_id);
                $this->setObjId((int) $row->obj_id);
                $this->setObjType($row->obj_type);
                $this->setParentId((int) $row->parent_id);
                $this->setParentType($row->parent_type);
                $this->setLocation($row->location ?? '');
                $this->setLocationType($row->location_type ?? '');
            }
        }
        return true;
    }

References $query, $res, ilDBConstants\FETCHMODE_OBJECT, ilMDBase\getMetaId(), setLocation(), setLocationType(), ilMDBase\setObjId(), ilMDBase\setObjType(), ilMDBase\setParentId(), ilMDBase\setParentType(), and ilMDBase\setRBACId().

Here is the call graph for this function:

save()

ilMDLocation::save

(

)

Reimplemented from ilMDBase.

Definition at line 52 of file class.ilMDLocation.php.

                          : int
    {
        $fields = $this->__getFields();
        $fields['meta_location_id'] = array('integer', $next_id = $this->db->nextId('il_meta_location'));
 
        if ($this->db->insert('il_meta_location', $fields)) {
            $this->setMetaId($next_id);
            return $this->getMetaId();
        }
        return 0;
    }

References __getFields(), ilMDBase\getMetaId(), and ilMDBase\setMetaId().

Here is the call graph for this function:

setLocation()

ilMDLocation::setLocation

(

string

$a_location

)

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

                                                   : void
    {
        $this->location = $a_location;
    }

Referenced by read().

Here is the caller graph for this function:

setLocationType()

ilMDLocation::setLocationType

(

string

$a_location_type

)

Definition at line 42 of file class.ilMDLocation.php.

                                                            : void
    {
        $this->location_type = $a_location_type;
    }

Referenced by read().

Here is the caller graph for this function:

toXML()

ilMDLocation::toXML

(

ilXmlWriter

$writer

)

Reimplemented from ilMDBase.

Definition at line 121 of file class.ilMDLocation.php.

                                              : void
    {
        $writer->xmlElement(
            'Location',
            array(
                'Type' => $this->getLocationType() ?: 'LocalFile'
            ),
            $this->getLocation()
        );
    }

References getLocation(), getLocationType(), and ilXmlWriter\xmlElement().

Here is the call graph for this function:

update()

ilMDLocation::update

(

)

Reimplemented from ilMDBase.

Definition at line 64 of file class.ilMDLocation.php.

                            : bool
    {
        return $this->getMetaId() && $this->db->update(
            'il_meta_location',
            $this->__getFields(),
            array("meta_location_id" => array('integer', $this->getMetaId()))
        );
    }

References __getFields(), and ilMDBase\getMetaId().

Here is the call graph for this function:

Field Documentation

$location

string ilMDLocation::$location = ''

private

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

Referenced by getLocation().

$location_type

string ilMDLocation::$location_type = ''

private

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

Referenced by getLocationType().

---

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

• Services/MetaData/classes/class.ilMDLocation.php