ilMDLifecycle Class Reference

Inheritance diagram for ilMDLifecycle:

Collaboration diagram for ilMDLifecycle:

Public Member Functions
	getPossibleSubelements ()
	getContributeIds ()
	getContribute (int $a_contribute_id)
	addContribute ()
	setStatus (string $a_status)
	getStatus ()
	setVersion (string $a_version)
	getVersion ()
	setVersionLanguage (ilMDLanguageItem $lng_obj)
	getVersionLanguage ()
	getVersionLanguageCode ()
	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	_getId (int $a_rbac_id, int $a_obj_id)

Private Attributes
const	STATUS_TRANSLATION
	Compatibility fix for legacy MD classes for new db tables. More...
const ilMDLanguageItem	$version_language = null
string	$version = ""
string	$status = ""

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

Detailed Description

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

Member Function Documentation

__getFields()

ilMDLifecycle::__getFields

(

)

Returns

array<string, array<string, mixed>>

Compatibility fix for legacy MD classes for new db tables

Definition at line 166 of file class.ilMDLifecycle.php.

References ilMDBase\getObjId(), ilMDBase\getObjType(), ilMDBase\getRBACId(), getStatus(), getVersion(), and getVersionLanguageCode().

Referenced by save(), and update().

                                 : array
    {
        $status = (string) array_search(
            $this->getStatus(),
            self::STATUS_TRANSLATION
        );

        return array(
            'rbac_id' => array('integer', $this->getRBACId()),
            'obj_id' => array('integer', $this->getObjId()),
            'obj_type' => array('text', $this->getObjType()),
            'lifecycle_status' => array('text', $status),
            'meta_version' => array('text', $this->getVersion()),
            'version_language' => array('text', $this->getVersionLanguageCode())
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getId()

static ilMDLifecycle::_getId ( int  $a_rbac_id, int  $a_obj_id  )

static

Definition at line 239 of file class.ilMDLifecycle.php.

References $DIC, $ilDB, $res, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilMD\getLifecycle().

                                                                : int
    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = "SELECT meta_lifecycle_id FROM il_meta_lifecycle " .
            "WHERE rbac_id = " . $ilDB->quote($a_rbac_id, 'integer') . " " .
            "AND obj_id = " . $ilDB->quote($a_obj_id, 'integer');

        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return (int) $row->meta_lifecycle_id;
        }
        return 0;
    }

Here is the caller graph for this function:

addContribute()

ilMDLifecycle::addContribute

(

)

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

References ilMDBase\getMetaId(), ilMDBase\getObjId(), ilMDBase\getObjType(), and ilMDBase\getRBACId().

                                   : ilMDContribute
    {
        $con = new ilMDContribute($this->getRBACId(), $this->getObjId(), $this->getObjType());
        $con->setParentId($this->getMetaId());
        $con->setParentType('meta_lifecycle');

        return $con;
    }

Here is the call graph for this function:

delete()

ilMDLifecycle::delete

(

)

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

References $id, $res, getContribute(), getContributeIds(), and ilMDBase\getMetaId().

                            : bool
    {
        // Delete 'contribute'
        foreach ($this->getContributeIds() as $id) {
            $con = $this->getContribute($id);
            $con->delete();
        }

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

Here is the call graph for this function:

getContribute()

ilMDLifecycle::getContribute

(

int

$a_contribute_id

)

Definition at line 62 of file class.ilMDLifecycle.php.

References null.

Referenced by delete(), and toXML().

                                                       : ?ilMDContribute
    {
        if (!$a_contribute_id) {
            return null;
        }
        $con = new ilMDContribute();
        $con->setMetaId($a_contribute_id);

        return $con;
    }

Here is the caller graph for this function:

getContributeIds()

ilMDLifecycle::getContributeIds

(

)

Returns

int[]

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

References ilMDContribute\_getIds(), ilMDBase\getMetaId(), ilMDBase\getObjId(), and ilMDBase\getRBACId().

Referenced by delete(), and toXML().

                                      : array
    {
        return ilMDContribute::_getIds($this->getRBACId(), $this->getObjId(), $this->getMetaId(), 'meta_lifecycle');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPossibleSubelements()

ilMDLifecycle::getPossibleSubelements

(

)

Returns

array<string, string>

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

                                            : array
    {
        $subs['Contribute'] = 'meta_contribute';

        return $subs;
    }

getStatus()

ilMDLifecycle::getStatus

(

)

Definition at line 95 of file class.ilMDLifecycle.php.

References $status.

Referenced by __getFields(), and toXML().

                               : string
    {
        return $this->status;
    }

Here is the caller graph for this function:

getVersion()

ilMDLifecycle::getVersion

(

)

Definition at line 105 of file class.ilMDLifecycle.php.

References $version.

Referenced by __getFields(), and toXML().

                                : string
    {
        return $this->version;
    }

Here is the caller graph for this function:

getVersionLanguage()

ilMDLifecycle::getVersionLanguage

(

)

Definition at line 115 of file class.ilMDLifecycle.php.

References $version_language.

                                        : ilMDLanguageItem
    {
        return $this->version_language;
    }

getVersionLanguageCode()

ilMDLifecycle::getVersionLanguageCode

(

)

Definition at line 120 of file class.ilMDLifecycle.php.

Referenced by __getFields(), and toXML().

                                            : string
    {
        return is_object($this->version_language) ? $this->version_language->getLanguageCode() : '';
    }

Here is the caller graph for this function:

read()

ilMDLifecycle::read

(

)

Compatibility fix for legacy MD classes for new db tables

Definition at line 186 of file class.ilMDLifecycle.php.

References $res, ilDBConstants\FETCHMODE_OBJECT, ilMDBase\getMetaId(), ilMDBase\setObjId(), ilMDBase\setObjType(), ilMDBase\setRBACId(), setStatus(), setVersion(), and setVersionLanguage().

                          : bool
    {
        if ($this->getMetaId()) {
            $query = "SELECT * FROM il_meta_lifecycle " .
                "WHERE meta_lifecycle_id = " . $this->db->quote($this->getMetaId(), 'integer');

            $res = $this->db->query($query);
            while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
                if (key_exists($row->lifecycle_status ?? '', self::STATUS_TRANSLATION)) {
                    $row->lifecycle_status = self::STATUS_TRANSLATION[$row->lifecycle_status ?? ''];
                }

                $this->setRBACId((int) $row->rbac_id);
                $this->setObjId((int) $row->obj_id);
                $this->setObjType($row->obj_type ?? '');
                $this->setStatus($row->lifecycle_status ?? '');
                $this->setVersion($row->meta_version ?? '');
                $this->setVersionLanguage(new ilMDLanguageItem($row->version_language ?? ''));
            }
        }
        return true;
    }

Here is the call graph for this function:

save()

ilMDLifecycle::save

(

)

Definition at line 125 of file class.ilMDLifecycle.php.

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

                          : int
    {
        $fields = $this->__getFields();
        $fields['meta_lifecycle_id'] = array('integer', $next_id = $this->db->nextId('il_meta_lifecycle'));

        if ($this->db->insert('il_meta_lifecycle', $fields)) {
            $this->setMetaId($next_id);
            return $this->getMetaId();
        }
        return 0;
    }

Here is the call graph for this function:

setStatus()

ilMDLifecycle::setStatus

(

string

$a_status

)

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

Referenced by read().

                                               : void
    {
        switch ($a_status) {
            case 'Draft':
            case 'Final':
            case 'Revised':
            case 'Unavailable':
                $this->status = $a_status;
                break;
        }
    }

Here is the caller graph for this function:

setVersion()

ilMDLifecycle::setVersion

(

string

$a_version

)

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

Referenced by read().

                                                 : void
    {
        $this->version = $a_version;
    }

Here is the caller graph for this function:

setVersionLanguage()

ilMDLifecycle::setVersionLanguage

(

ilMDLanguageItem

$lng_obj

)

Definition at line 110 of file class.ilMDLifecycle.php.

Referenced by read().

                                                                 : void
    {
        $this->version_language = $lng_obj;
    }

Here is the caller graph for this function:

toXML()

ilMDLifecycle::toXML

(

ilXmlWriter

$writer

)

Definition at line 212 of file class.ilMDLifecycle.php.

References $id, getContribute(), getContributeIds(), ilMDBase\getObjId(), ilMDBase\getRBACId(), getStatus(), getVersion(), getVersionLanguageCode(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

                                              : void
    {
        $writer->xmlStartTag('Lifecycle', array(
            'Status' => $this->getStatus() ?: 'Draft'
        ));
        $writer->xmlElement(
            'Version',
            array(
                'Language' => $this->getVersionLanguageCode() ?: 'en'
            ),
            $this->getVersion()
        );

        // contribute
        $contributes = $this->getContributeIds();
        foreach ($contributes as $id) {
            $con = $this->getContribute($id);
            $con->toXML($writer);
        }
        if (!count($contributes)) {
            $con = new ilMDContribute($this->getRBACId(), $this->getObjId());
            $con->toXML($writer);
        }
        $writer->xmlEndTag('Lifecycle');
    }

Here is the call graph for this function:

update()

ilMDLifecycle::update

(

)

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

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

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

Here is the call graph for this function:

Field Documentation

$status

string ilMDLifecycle::$status = ""

private

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

Referenced by getStatus().

$version

string ilMDLifecycle::$version = ""

private

Definition at line 41 of file class.ilMDLifecycle.php.

Referenced by getVersion().

$version_language

const ilMDLanguageItem ilMDLifecycle::$version_language = null

private

Definition at line 40 of file class.ilMDLifecycle.php.

Referenced by getVersionLanguage().

STATUS_TRANSLATION

const ilMDLifecycle::STATUS_TRANSLATION

private

Initial value:

= [
        'draft' => 'Draft'

Compatibility fix for legacy MD classes for new db tables.

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

---

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

• components/ILIAS/MetaData/classes/class.ilMDLifecycle.php