ilMDCopyrightSelectionEntry Class Reference

Collaboration diagram for ilMDCopyrightSelectionEntry:

Public Member Functions
	__construct ($a_entry_id)
	Constructor. More...
	getUsage ()
	get usage More...
	getEntryId ()
	get entry id More...
	getIsDefault ()
	Get if the entry is default No setter for this. More...
	setOutdated ($a_value)
	Set copyright element as outdated and not usable anymore. More...
	getOutdated ()
	setTitle ($a_title)
	set title More...
	getTitle ()
	get title More...
	setDescription ($a_desc)
	set description More...
	getDescription ()
	get description More...
	setCopyright ($a_copyright)
	set copyright More...
	getCopyright ()
	get copyright More...
	setCosts ($a_costs)
	set costs More...
	getCosts ()
	get costs More...
	setLanguage ($a_lang_key)
	set language More...
	getLanguage ()
	get language More...
	setCopyrightAndOtherRestrictions ($a_status)
	set copyright and other restrictions More...
	getCopyrightAndOtherRestrictions ()
	get copyright and other restrictions More...
	setOrderPosition ($a_position)
	Set the order position in the table of copyrights. More...
	getOrderPosition ()
	Get the order position in the table of copyrights. More...
	add ()
	Add entry. More...
	update ()
	update More...
	delete ()
	delete More...
	validate ()
	validate More...

Static Public Member Functions
static	_getEntries ()
	get entries More...
static	lookupCopyyrightTitle ($a_cp_string)
	Lookup copyright title. More...
static	_lookupCopyright ($a_cp_string)
	lookup copyright by entry id More...
static	lookupCopyrightByText ($copyright_text)
static	_extractEntryId ($a_cp_string)
	extract entry id More...
static	isEntry ($a_cp_string)
static	getDefault ()
	Get default. More...
static	createIdentifier ($a_entry_id)
	Create identifier for entry id. More...

Protected Member Functions
	getNextOrderPosition ()

Protected Attributes
	$logger = null
	$db
	$outdated
	$order_position

Private Member Functions
	read ()
	Read entry. More...

Private Attributes
	$entry_id
	$title
	$decription
	$copyright
	$costs
	$language
	$copyright_and_other_restrictions

Detailed Description

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilMDCopyrightSelectionEntry::__construct

(

$a_entry_id

)

Constructor.

public

Parameters

int

entry id

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

References $DIC, $GLOBALS, and read().

    {
        global $DIC;
        
        
        $this->logger = $GLOBALS['DIC']->logger()->meta();
        $this->db = $GLOBALS['DIC']->database();
        $this->entry_id = $a_entry_id;
        $this->read();
    }

Here is the call graph for this function:

Member Function Documentation

_extractEntryId()

static ilMDCopyrightSelectionEntry::_extractEntryId (   $a_cp_string )

static

extract entry id

public

Parameters

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

References IL_INST_ID.

Referenced by ilMDCopyrightSelectionGUI\fillTemplate(), ilMDKeywordExposer\getContentModification(), ilCopyrightInputGUI\insert(), and ilMDEditorGUI\listQuickEditCopyright().

    {
        if (!preg_match('/il_copyright_entry__([0-9]+)__([0-9]+)/', $a_cp_string, $matches)) {
            return 0;
        }
        if ($matches[1] != IL_INST_ID) {
            return 0;
        }
        return $matches[2] ? $matches[2] : 0;
    }

Here is the caller graph for this function:

_getEntries()

static ilMDCopyrightSelectionEntry::_getEntries ( )

static

get entries

Returns

ilMDCopyrightSelectionEntry[] public

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

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

Referenced by ilCronOerHarvester\addCustomSettingsToForm(), ilMDCopyrightSelectionGUI\fillTemplate(), ilContainerFilterUtil\getContainerRecordTitle(), ilCopyrightInputGUI\insert(), ilMDEditorGUI\listQuickEditCopyright(), and ilMDCopyrightTableGUI\parseSelections().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = "SELECT entry_id FROM il_md_cpr_selections ORDER BY is_default DESC, position ASC";
        $res = $ilDB->query($query);

        $entries = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $entries[] = new ilMDCopyrightSelectionEntry($row->entry_id);
        }
        return $entries;
    }

Here is the caller graph for this function:

_lookupCopyright()

static ilMDCopyrightSelectionEntry::_lookupCopyright (   $a_cp_string )

static

lookup copyright by entry id

public

Parameters

string

copyright string il_copyright_entry__IL_INST_ID__ENTRY_ID

Definition at line 130 of file class.ilMDCopyrightSelectionEntry.php.

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

Referenced by ilMDUtils\_parseCopyright(), and ilMDRights\toXML().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        if (!$entry_id = self::_extractEntryId($a_cp_string)) {
            return $a_cp_string;
        }
                
        $query = "SELECT copyright FROM il_md_cpr_selections " .
            "WHERE entry_id = " . $ilDB->quote($entry_id) . " ";
        $res = $ilDB->query($query);
        $row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT);
        return $row->copyright ? $row->copyright : '';
    }

Here is the caller graph for this function:

add()

ilMDCopyrightSelectionEntry::add

(

)

Add entry.

public

Definition at line 437 of file class.ilMDCopyrightSelectionEntry.php.

References $DIC, $ilDB, getCopyright(), getCopyrightAndOtherRestrictions(), getCosts(), getDescription(), getLanguage(), getNextOrderPosition(), and getTitle().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $next_id = $ilDB->nextId('il_md_cpr_selections');
        
        $ilDB->insert('il_md_cpr_selections', array(
            'entry_id' => array('integer',$next_id),
            'title' => array('text',$this->getTitle()),
            'description' => array('clob',$this->getDescription()),
            'copyright' => array('clob',$this->getCopyright()),
            'language' => array('text',$this->getLanguage()),
            'costs' => array('integer',$this->getCosts()),
            'cpr_restrictions' => array('integer',$this->getCopyrightAndOtherRestrictions()),
            'position' => array('integer', $this->getNextOrderPosition())
        ));
        $this->entry_id = $next_id;
        return true;
    }

Here is the call graph for this function:

createIdentifier()

static ilMDCopyrightSelectionEntry::createIdentifier (   $a_entry_id )

static

Create identifier for entry id.

Parameters

$a_entry_id

Returns

string

Definition at line 561 of file class.ilMDCopyrightSelectionEntry.php.

References IL_INST_ID.

Referenced by ilMDUtils\_getDefaultCopyright(), and ilMDRights\parseDescriptionFromImport().

    {
        return 'il_copyright_entry__' . IL_INST_ID . '__' . $a_entry_id;
    }

Here is the caller graph for this function:

delete()

ilMDCopyrightSelectionEntry::delete

(

)

delete

public

Definition at line 492 of file class.ilMDCopyrightSelectionEntry.php.

References $DIC, $ilDB, $query, $res, and getEntryId().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = "DELETE FROM il_md_cpr_selections " .
            "WHERE entry_id = " . $this->db->quote($this->getEntryId(), 'integer') . " ";
        $res = $ilDB->manipulate($query);
    }

Here is the call graph for this function:

getCopyright()

ilMDCopyrightSelectionEntry::getCopyright

(

)

get copyright

publi

Definition at line 331 of file class.ilMDCopyrightSelectionEntry.php.

References $copyright.

Referenced by add(), and update().

    {
        return $this->copyright;
    }

Here is the caller graph for this function:

getCopyrightAndOtherRestrictions()

ilMDCopyrightSelectionEntry::getCopyrightAndOtherRestrictions

(

)

get copyright and other restrictions

public

Parameters

Definition at line 399 of file class.ilMDCopyrightSelectionEntry.php.

Referenced by add(), and update().

    {
        // Fixed
        return true;
    }

Here is the caller graph for this function:

getCosts()

ilMDCopyrightSelectionEntry::getCosts

(

)

get costs

public

Definition at line 353 of file class.ilMDCopyrightSelectionEntry.php.

References $costs.

Referenced by add(), and update().

    {
        return $this->costs;
    }

Here is the caller graph for this function:

getDefault()

static ilMDCopyrightSelectionEntry::getDefault ( )

static

Get default.

Definition at line 254 of file class.ilMDCopyrightSelectionEntry.php.

References $db, $DIC, $query, $res, and ilDBConstants\FETCHMODE_DEFAULT.

Referenced by ilMDUtils\_getDefaultCopyright(), and ilMDEditorGUI\listQuickEditCopyright().

    {
        global $DIC;

        $db = $DIC->database();

        $query = "SELECT entry_id FROM il_md_cpr_selections " .
            "WHERE is_default = " . $db->quote(1, 'integer');

        $res = $db->query($query);
        $row = $res->fetchRow(ilDBConstants::FETCHMODE_DEFAULT);

        return $row['entry_id'];
    }

Here is the caller graph for this function:

getDescription()

ilMDCopyrightSelectionEntry::getDescription

(

)

get description

public

Definition at line 309 of file class.ilMDCopyrightSelectionEntry.php.

Referenced by add(), and update().

    {
        return $this->description;
    }

Here is the caller graph for this function:

getEntryId()

ilMDCopyrightSelectionEntry::getEntryId

(

)

get entry id

public

Parameters

Definition at line 214 of file class.ilMDCopyrightSelectionEntry.php.

References $entry_id.

Referenced by delete(), read(), and update().

    {
        return $this->entry_id;
    }

Here is the caller graph for this function:

getIsDefault()

ilMDCopyrightSelectionEntry::getIsDefault

(

)

Get if the entry is default No setter for this.

Definition at line 223 of file class.ilMDCopyrightSelectionEntry.php.

References $query, $res, and ilDBConstants\FETCHMODE_DEFAULT.

    {
        $query = "SELECT is_default FROM il_md_cpr_selections " .
            "WHERE entry_id = " . $this->db->quote($this->entry_id, 'integer');

        $res = $this->db->query($query);
        $row = $res->fetchRow(ilDBConstants::FETCHMODE_DEFAULT);
        
        return $row['is_default'];
    }

getLanguage()

ilMDCopyrightSelectionEntry::getLanguage

(

)

get language

public

Definition at line 376 of file class.ilMDCopyrightSelectionEntry.php.

References $language.

Referenced by add(), and update().

    {
        return $this->language;
    }

Here is the caller graph for this function:

getNextOrderPosition()

ilMDCopyrightSelectionEntry::getNextOrderPosition ( )

protected

Definition at line 423 of file class.ilMDCopyrightSelectionEntry.php.

References $query, $res, and ilDBConstants\FETCHMODE_ASSOC.

Referenced by add().

    {
        $query = "SELECT count(entry_id) total FROM il_md_cpr_selections";
        $res = $this->db->query($query);
        $row = $res->fetchRow(ilDBConstants::FETCHMODE_ASSOC);

        return $row['total'] + 1;
    }

Here is the caller graph for this function:

getOrderPosition()

ilMDCopyrightSelectionEntry::getOrderPosition

(

)

Get the order position in the table of copyrights.

Returns

int

Definition at line 418 of file class.ilMDCopyrightSelectionEntry.php.

References $order_position.

Referenced by update().

    {
        return $this->order_position;
    }

Here is the caller graph for this function:

getOutdated()

ilMDCopyrightSelectionEntry::getOutdated

(

)

Returns

int

Definition at line 246 of file class.ilMDCopyrightSelectionEntry.php.

References $outdated.

Referenced by update().

    {
        return $this->outdated;
    }

Here is the caller graph for this function:

getTitle()

ilMDCopyrightSelectionEntry::getTitle

(

)

get title

public

Definition at line 287 of file class.ilMDCopyrightSelectionEntry.php.

References $title.

Referenced by add(), update(), and validate().

    {
        return $this->title;
    }

Here is the caller graph for this function:

getUsage()

ilMDCopyrightSelectionEntry::getUsage

(

)

get usage

public

Parameters

Definition at line 202 of file class.ilMDCopyrightSelectionEntry.php.

    {
        return $this->usage;
    }

isEntry()

static ilMDCopyrightSelectionEntry::isEntry (   $a_cp_string )

static

Definition at line 187 of file class.ilMDCopyrightSelectionEntry.php.

Referenced by ilMDUtils\_parseCopyright().

                                                 : bool
    {
        if (!preg_match('/il_copyright_entry__([0-9]+)__([0-9]+)/', $a_cp_string)) {
            return false;
        }
        return true;
    }

Here is the caller graph for this function:

lookupCopyrightByText()

static ilMDCopyrightSelectionEntry::lookupCopyrightByText (   $copyright_text )

static

Parameters

$copyright_text

Returns

int

Exceptions

ilDatabaseException

Definition at line 152 of file class.ilMDCopyrightSelectionEntry.php.

References $db, $DIC, $query, $res, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilMDRights\parseDescriptionFromImport().

    {
        global $DIC;

        $db = $DIC->database();

        $query = 'SELECT entry_id FROM il_md_cpr_selections ' .
            'WHERE copyright = ' . $db->quote($copyright_text, 'text');
        $res = $db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return $row->entry_id;
        }
        return 0;
    }

Here is the caller graph for this function:

lookupCopyyrightTitle()

static ilMDCopyrightSelectionEntry::lookupCopyyrightTitle (   $a_cp_string )

static

Lookup copyright title.

Currently used for export of meta data

Parameters

type

$a_cp_string

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

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

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        if (!$entry_id = self::_extractEntryId($a_cp_string)) {
            return $a_cp_string;
        }
                
        $query = "SELECT title FROM il_md_cpr_selections " .
            "WHERE entry_id = " . $ilDB->quote($entry_id) . " ";
        $res = $ilDB->query($query);
        $row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT);
        return $row->title ? $row->title : '';
    }

read()

ilMDCopyrightSelectionEntry::read ( )

private

Read entry.

private

Parameters

Definition at line 525 of file class.ilMDCopyrightSelectionEntry.php.

References $DIC, $ilDB, $query, $res, ilDBConstants\FETCHMODE_OBJECT, getEntryId(), IL_INST_ID, setCopyright(), setCopyrightAndOtherRestrictions(), setCosts(), setDescription(), setLanguage(), setOrderPosition(), setOutdated(), and setTitle().

Referenced by __construct().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = "SELECT * FROM il_md_cpr_selections " .
            "WHERE entry_id = " . $this->db->quote($this->entry_id, 'integer') . " " .
            "ORDER BY is_default DESC, position ASC ";

        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->setTitle($row->title);
            $this->setDescription($row->description);
            $this->setCopyright($row->copyright);
            $this->setLanguage($row->language);
            $this->setCosts($row->costs);
            $this->setOutdated($row->outdated);
            $this->setOrderPosition($row->position);
            // Fixed
            $this->setCopyrightAndOtherRestrictions(true);
        }
        
        $query = "SELECT count(meta_rights_id) used FROM il_meta_rights " .
            "WHERE description = " . $ilDB->quote('il_copyright_entry__' . IL_INST_ID . '__' . $this->getEntryId(), 'text');
        
        $res = $this->db->query($query);
        $row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT);
        $this->usage = $row->used;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setCopyright()

ilMDCopyrightSelectionEntry::setCopyright

(

$a_copyright

)

set copyright

public

Parameters

string

$copyright

Definition at line 321 of file class.ilMDCopyrightSelectionEntry.php.

Referenced by read().

    {
        $this->copyright = $a_copyright;
    }

Here is the caller graph for this function:

setCopyrightAndOtherRestrictions()

ilMDCopyrightSelectionEntry::setCopyrightAndOtherRestrictions

(

$a_status

)

set copyright and other restrictions

public

Parameters

bool	copyright and other restrictions

Definition at line 387 of file class.ilMDCopyrightSelectionEntry.php.

Referenced by read().

    {
        $this->copyright_and_other_restrictions = $a_status;
    }

Here is the caller graph for this function:

setCosts()

ilMDCopyrightSelectionEntry::setCosts

(

$a_costs

)

set costs

public

Parameters

Definition at line 343 of file class.ilMDCopyrightSelectionEntry.php.

Referenced by read().

    {
        $this->costs = $a_costs;
    }

Here is the caller graph for this function:

setDescription()

ilMDCopyrightSelectionEntry::setDescription

(

$a_desc

)

set description

public

Parameters

string

description

Definition at line 299 of file class.ilMDCopyrightSelectionEntry.php.

Referenced by read().

    {
        $this->description = $a_desc;
    }

Here is the caller graph for this function:

setLanguage()

ilMDCopyrightSelectionEntry::setLanguage

(

$a_lang_key

)

set language

public

Parameters

string

language key

Definition at line 365 of file class.ilMDCopyrightSelectionEntry.php.

References language().

Referenced by read().

    {
        $this->language = $a_lang_key;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setOrderPosition()

ilMDCopyrightSelectionEntry::setOrderPosition

(

$a_position

)

Set the order position in the table of copyrights.

Parameters

$a_position

integer

Definition at line 409 of file class.ilMDCopyrightSelectionEntry.php.

Referenced by read().

    {
        $this->order_position = (int) $a_position;
    }

Here is the caller graph for this function:

setOutdated()

ilMDCopyrightSelectionEntry::setOutdated

(

$a_value

)

Set copyright element as outdated and not usable anymore.

Parameters

$a_value

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

Referenced by read().

    {
        $this->outdated = (int) $a_value;
    }

Here is the caller graph for this function:

setTitle()

ilMDCopyrightSelectionEntry::setTitle

(

$a_title

)

set title

public

Parameters

string

title

Definition at line 276 of file class.ilMDCopyrightSelectionEntry.php.

Referenced by read().

    {
        $this->title = $a_title;
    }

Here is the caller graph for this function:

update()

ilMDCopyrightSelectionEntry::update

(

)

update

public

Definition at line 465 of file class.ilMDCopyrightSelectionEntry.php.

References $DIC, $ilDB, getCopyright(), getCopyrightAndOtherRestrictions(), getCosts(), getDescription(), getEntryId(), getLanguage(), getOrderPosition(), getOutdated(), and getTitle().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $ilDB->update('il_md_cpr_selections', array(
            'title' => array('text',$this->getTitle()),
            'description' => array('clob',$this->getDescription()),
            'copyright' => array('clob',$this->getCopyright()),
            'language' => array('text',$this->getLanguage()),
            'costs' => array('integer',$this->getCosts()),
            'cpr_restrictions' => array('integer',$this->getCopyrightAndOtherRestrictions()),
            'outdated' => array('integer',$this->getOutdated()),
            'position' => array('integer',$this->getOrderPosition())
            ), array(
                'entry_id' => array('integer',$this->getEntryId())
        ));
        return true;
    }

Here is the call graph for this function:

validate()

ilMDCopyrightSelectionEntry::validate

(

)

validate

public

Parameters

Definition at line 510 of file class.ilMDCopyrightSelectionEntry.php.

References getTitle().

    {
        if (!strlen($this->getTitle())) {
            return false;
        }
        return true;
    }

Here is the call graph for this function:

Field Documentation

$copyright

ilMDCopyrightSelectionEntry::$copyright

private

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

Referenced by getCopyright().

$copyright_and_other_restrictions

ilMDCopyrightSelectionEntry::$copyright_and_other_restrictions

private

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

$costs

ilMDCopyrightSelectionEntry::$costs

private

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

Referenced by getCosts().

$db

ilMDCopyrightSelectionEntry::$db

protected

Definition at line 35 of file class.ilMDCopyrightSelectionEntry.php.

Referenced by getDefault(), and lookupCopyrightByText().

$decription

ilMDCopyrightSelectionEntry::$decription

private

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

$entry_id

ilMDCopyrightSelectionEntry::$entry_id

private

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

Referenced by _lookupCopyright(), getEntryId(), and lookupCopyyrightTitle().

$language

ilMDCopyrightSelectionEntry::$language

private

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

Referenced by getLanguage().

$logger

ilMDCopyrightSelectionEntry::$logger = null

protected

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

$order_position

ilMDCopyrightSelectionEntry::$order_position

protected

Definition at line 54 of file class.ilMDCopyrightSelectionEntry.php.

Referenced by getOrderPosition().

$outdated

ilMDCopyrightSelectionEntry::$outdated

protected

Definition at line 48 of file class.ilMDCopyrightSelectionEntry.php.

Referenced by getOutdated().

$title

ilMDCopyrightSelectionEntry::$title

private

Definition at line 38 of file class.ilMDCopyrightSelectionEntry.php.

Referenced by getTitle().

---

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

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