ilMDLifecycle Class Reference

Inheritance diagram for ilMDLifecycle:

Collaboration diagram for ilMDLifecycle:

Public Member Functions
	getPossibleSubelements ()
&	getContributeIds ()
&	getContribute ($a_contribute_id)
&	addContribute ()
	setStatus ($a_status)
	getStatus ()
	setVersion ($a_version)
	getVersion ()
	setVersionLanguage ($lng_obj)
&	getVersionLanguage ()
	getVersionLanguageCode ()
	save ()
	update ()
	delete ()
	__getFields ()
	read ()
	toXML (&$writer)
&	getContributeIds ()
&	getContribute ($a_contribute_id)
&	addContribute ()
	setStatus ($a_status)
	getStatus ()
	setVersion ($a_version)
	getVersion ()
	setVersionLanguage ($lng_obj)
&	getVersionLanguage ()
	getVersionLanguageCode ()
	save ()
	update ()
	delete ()
	__getFields ()
	read ()
	toXML (&$writer)
	_getId ($a_rbac_id, $a_obj_id)
Public Member Functions inherited from ilMDBase
	__construct ( $a_rbac_id=0, $a_obj_id=0, $a_type=0)
	setRBACId ($a_id)
	getRBACId ()
	setObjId ($a_id)
	getObjId ()
	setObjType ($a_type)
	getObjType ()
	setMetaId ($a_meta_id, $a_read_data=true)
	getMetaId ()
	setParentType ($a_parent_type)
	getParentType ()
	setParentId ($a_id)
	getParentId ()
	setExportMode ($a_export_mode=true)
	getExportMode ()
	validate ()
	update ()
	save ()
	delete ()
	toXML (&$writer)
	__construct ( $a_rbac_id=0, $a_obj_id=0, $a_type=0)
	setRBACId ($a_id)
	getRBACId ()
	setObjId ($a_id)
	getObjId ()
	setObjType ($a_type)
	getObjType ()
	setMetaId ($a_meta_id, $a_read_data=true)
	getMetaId ()
	setParentType ($a_parent_type)
	getParentType ()
	setParentId ($a_id)
	getParentId ()
	validate ()
	update ()
	save ()
	delete ()
	toXML (&$writer)

Static Public Member Functions
static	_getId ($a_rbac_id, $a_obj_id)

Additional Inherited Members
Data Fields inherited from ilMDBase
	$rbac_id
	$obj_id
	$obj_type
	$export_mode = false
Protected Attributes inherited from ilMDBase
	$log

Detailed Description

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

Member Function Documentation

__getFields() [1/2]

ilMDLifecycle::__getFields

(

)

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

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

    {
        return array('rbac_id'  => $this->getRBACId(),
                     'obj_id'   => $this->getObjId(),
                     'obj_type' => ilUtil::prepareDBString($this->getObjType()),
                     'lifecycle_status' => ilUtil::prepareDBString($this->getStatus()),
                     'meta_version'             => ilUtil::prepareDBString($this->getVersion()),
                     'version_language' => ilUtil::prepareDBString($this->getVersionLanguageCode()));
    }

Here is the call graph for this function:

__getFields() [2/2]

ilMDLifecycle::__getFields

(

)

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

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

Referenced by save().

    {
        return array('rbac_id'  => array('integer',$this->getRBACId()),
                     'obj_id'   => array('integer',$this->getObjId()),
                     'obj_type' => array('text',$this->getObjType()),
                     'lifecycle_status' => array('text',$this->getStatus()),
                     '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() [1/2]

ilMDLifecycle::_getId	(		$a_rbac_id,
			$a_obj_id
	)

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

References $ilDB, $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

    {
        global $ilDB;

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


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

_getId() [2/2]

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

static

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

References $ilDB, $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilMD\getLifecycle().

    {
        global $ilDB;

        $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 $row->meta_lifecycle_id;
        }
        return false;
    }

Here is the caller graph for this function:

addContribute() [1/2]

& ilMDLifecycle::addContribute

(

)

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

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

    {
        include_once 'Services/Migration/DBUpdate_426/classes/class.ilMDContribute.php';

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

addContribute() [2/2]

& ilMDLifecycle::addContribute

(

)

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

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

    {
        include_once 'Services/MetaData/classes/class.ilMDContribute.php';

        $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() [1/2]

ilMDLifecycle::delete

(

)

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

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

    {
        global $ilDB;
        
        // 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 = " . $ilDB->quote($this->getMetaId());
            
            $this->db->query($query);
            
            return true;
        }
        return false;
    }

Here is the call graph for this function:

delete() [2/2]

ilMDLifecycle::delete

(

)

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

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

    {
        global $ilDB;
        
        // 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 = " . $ilDB->quote($this->getMetaId(), 'integer');
            $res = $ilDB->manipulate($query);
            return true;
        }
        return false;
    }

Here is the call graph for this function:

getContribute() [1/2]

& ilMDLifecycle::getContribute

(

$a_contribute_id

)

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

    {
        include_once 'Services/Migration/DBUpdate_426/classes/class.ilMDContribute.php';
        
        if (!$a_contribute_id) {
            return false;
        }
        $con = new ilMDContribute();
        $con->setMetaId($a_contribute_id);

        return $con;
    }

getContribute() [2/2]

& ilMDLifecycle::getContribute

(

$a_contribute_id

)

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

Referenced by delete(), and toXML().

    {
        include_once 'Services/MetaData/classes/class.ilMDContribute.php';
        
        if (!$a_contribute_id) {
            return false;
        }
        $con = new ilMDContribute();
        $con->setMetaId($a_contribute_id);

        return $con;
    }

Here is the caller graph for this function:

getContributeIds() [1/2]

& ilMDLifecycle::getContributeIds

(

)

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

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

    {
        include_once 'Services/Migration/DBUpdate_426/classes/class.ilMDContribute.php';

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

Here is the call graph for this function:

getContributeIds() [2/2]

& ilMDLifecycle::getContributeIds

(

)

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

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

Referenced by delete(), and toXML().

    {
        include_once 'Services/MetaData/classes/class.ilMDContribute.php';

        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

(

)

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

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

        return $subs;
    }

getStatus() [1/2]

ilMDLifecycle::getStatus

(

)

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

    {
        return $this->status;
    }

getStatus() [2/2]

ilMDLifecycle::getStatus

(

)

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

Referenced by __getFields(), and toXML().

    {
        return $this->status;
    }

Here is the caller graph for this function:

getVersion() [1/2]

ilMDLifecycle::getVersion

(

)

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

References $version.

    {
        return $this->version;
    }

getVersion() [2/2]

ilMDLifecycle::getVersion

(

)

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

References $version.

Referenced by __getFields(), and toXML().

    {
        return $this->version;
    }

Here is the caller graph for this function:

getVersionLanguage() [1/2]

& ilMDLifecycle::getVersionLanguage

(

)

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

    {
        return $this->version_language;
    }

getVersionLanguage() [2/2]

& ilMDLifecycle::getVersionLanguage

(

)

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

    {
        return $this->version_language;
    }

getVersionLanguageCode() [1/2]

ilMDLifecycle::getVersionLanguageCode

(

)

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

    {
        if (is_object($this->version_language)) {
            return $this->version_language->getLanguageCode();
        }
        return false;
    }

getVersionLanguageCode() [2/2]

ilMDLifecycle::getVersionLanguageCode

(

)

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

Referenced by __getFields(), and toXML().

    {
        if (is_object($this->version_language)) {
            return $this->version_language->getLanguageCode();
        }
        return false;
    }

Here is the caller graph for this function:

read() [1/2]

ilMDLifecycle::read

(

)

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

References $ilDB, $query, $res, $row, ilDBConstants\FETCHMODE_OBJECT, ilMDBase\getMetaId(), ilMDBase\setObjId(), ilMDBase\setObjType(), ilMDBase\setRBACId(), setStatus(), setVersion(), setVersionLanguage(), and ilUtil\stripSlashes().

    {
        global $ilDB;
                
        include_once 'Services/Migration/DBUpdate_426/classes/class.ilMDLanguageItem.php';

        if ($this->getMetaId()) {
            $query = "SELECT * FROM il_meta_lifecycle " .
                "WHERE meta_lifecycle_id = " . $ilDB->quote($this->getMetaId());

            $res = $this->db->query($query);
            while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
                $this->setRBACId($row->rbac_id);
                $this->setObjId($row->obj_id);
                $this->setObjType($row->obj_type);
                $this->setStatus(ilUtil::stripSlashes($row->lifecycle_status));
                $this->setVersion(ilUtil::stripSlashes($row->meta_version));
                $this->setVersionLanguage(new ilMDLanguageItem($row->version_language));
            }
        }
        return true;
    }

Here is the call graph for this function:

read() [2/2]

ilMDLifecycle::read

(

)

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

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

    {
        global $ilDB;
        
        include_once 'Services/MetaData/classes/class.ilMDLanguageItem.php';

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

            $res = $this->db->query($query);
            while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
                $this->setRBACId($row->rbac_id);
                $this->setObjId($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() [1/2]

ilMDLifecycle::save

(

)

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

References ilMDBase\getMetaId(), ilDBConstants\MDB2_AUTOQUERY_INSERT, and ilMDBase\setMetaId().

    {
        if ($this->db->autoExecute(
            'il_meta_lifecycle',
            $this->__getFields(),
            ilDBConstants::MDB2_AUTOQUERY_INSERT
        )) {
            $this->setMetaId($this->db->getLastInsertId());

            return $this->getMetaId();
        }
        return false;
    }

Here is the call graph for this function:

save() [2/2]

ilMDLifecycle::save

(

)

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

References $ilDB, __getFields(), array, ilMDBase\getMetaId(), and ilMDBase\setMetaId().

    {
        global $ilDB;
        
        $fields = $this->__getFields();
        $fields['meta_lifecycle_id'] = array('integer',$next_id = $ilDB->nextId('il_meta_lifecycle'));
        
        if ($this->db->insert('il_meta_lifecycle', $fields)) {
            $this->setMetaId($next_id);
            return $this->getMetaId();
        }
        return false;
    }

Here is the call graph for this function:

setStatus() [1/2]

ilMDLifecycle::setStatus

(

$a_status

)

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

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

                // no break
            default:
                return false;
        }
    }

setStatus() [2/2]

ilMDLifecycle::setStatus

(

$a_status

)

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

Referenced by read().

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

                // no break
            default:
                return false;
        }
    }

Here is the caller graph for this function:

setVersion() [1/2]

ilMDLifecycle::setVersion

(

$a_version

)

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

    {
        $this->version = $a_version;
    }

setVersion() [2/2]

ilMDLifecycle::setVersion

(

$a_version

)

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

Referenced by read().

    {
        $this->version = $a_version;
    }

Here is the caller graph for this function:

setVersionLanguage() [1/2]

ilMDLifecycle::setVersionLanguage

(

$lng_obj

)

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

    {
        if (is_object($lng_obj)) {
            $this->version_language =&$lng_obj;
        }
    }

setVersionLanguage() [2/2]

ilMDLifecycle::setVersionLanguage

(

$lng_obj

)

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

Referenced by read().

    {
        if (is_object($lng_obj)) {
            $this->version_language =&$lng_obj;
        }
    }

Here is the caller graph for this function:

toXML() [1/2]

ilMDLifecycle::toXML

(

&

$writer

)

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

References $id, array, getContribute(), getContributeIds(), getStatus(), getVersion(), and getVersionLanguageCode().

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

        // contribute
        foreach ($this->getContributeIds() as $id) {
            $con =&$this->getContribute($id);
            $con->toXML($writer);
        }

        $writer->xmlEndTag('Lifecycle');
    }

Here is the call graph for this function:

toXML() [2/2]

ilMDLifecycle::toXML

(

&

$writer

)

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

References $id, array, getContribute(), getContributeIds(), ilMDBase\getObjId(), ilMDBase\getRBACId(), getStatus(), getVersion(), and getVersionLanguageCode().

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

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

Here is the call graph for this function:

update() [1/2]

ilMDLifecycle::update

(

)

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

References $ilDB, ilMDBase\getMetaId(), and ilDBConstants\MDB2_AUTOQUERY_UPDATE.

    {
        global $ilDB;
        
        if ($this->getMetaId()) {
            if ($this->db->autoExecute(
                'il_meta_lifecycle',
                $this->__getFields(),
                ilDBConstants::MDB2_AUTOQUERY_UPDATE,
                "meta_lifecycle_id = " . $ilDB->quote($this->getMetaId())
            )) {
                return true;
            }
        }
        return false;
    }

Here is the call graph for this function:

update() [2/2]

ilMDLifecycle::update

(

)

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

References $ilDB, array, and ilMDBase\getMetaId().

    {
        global $ilDB;
        
        if ($this->getMetaId()) {
            if ($this->db->update(
                'il_meta_lifecycle',
                $this->__getFields(),
                array("meta_lifecycle_id" => array('integer',$this->getMetaId()))
            )) {
                return true;
            }
        }
        return false;
    }

Here is the call graph for this function:

---

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

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