ilObjLinkResource Class Reference

Class ilObjLinkResource. More...

Inheritance diagram for ilObjLinkResource:

Collaboration diagram for ilObjLinkResource:

Public Member Functions
	__construct (int $a_id=0, bool $a_call_by_reference=true)
	create ($a_upload=false)
	update ()
	delete ()
	cloneObject (int $target_id, int $copy_id=0, bool $omit_tree=false)
	toXML (ilXmlWriter $writer, bool $skip_lom=false)
Public Member Functions inherited from ilObject
	getObjectProperties ()
	flushObjectProperties ()
	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...
	processAutoRating ()
	read ()
	getId ()
	setId (int $id)
	setRefId (int $ref_id)
	getRefId ()
	getType ()
	setType (string $type)
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...
	getTitle ()
	getUntranslatedTitle ()
	Get untranslated object title WebDAV needs to access the untranslated title of an object. More...
	setTitle (string $title)
	getDescription ()
	setDescription (string $description)
	getLongDescription ()
	get object long description (stored in object_description) More...
	getImportId ()
	setImportId (string $import_id)
	setOfflineStatus (bool $status)
	getOfflineStatus ()
	supportsOfflineHandling ()
	getOwner ()
	getOwnerName ()
	get full name of object owner More...
	setOwner (int $usr_id)
	getCreateDate ()
	Get create date in YYYY-MM-DD HH-MM-SS format. More...
	getLastUpdateDate ()
	Get last update date in YYYY-MM-DD HH-MM-SS format. More...
	create ()
	note: title, description and type should be set when this function is called More...
	update ()
	MDUpdateListener (string $element)
	Metadata update listener. More...
	createMetaData ()
	updateMetaData ()
	deleteMetaData ()
	updateOwner ()
	update owner of object in db More...
	putInTree (int $parent_ref_id)
	maybe this method should be in tree object!? More...
	setPermissions (int $parent_ref_id)
	setParentRolePermissions (int $parent_ref_id)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g. More...
	createReference ()
	creates reference for object More...
	countReferences ()
	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More...
	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type. More...
	applyDidacticTemplate (int $tpl_id)
	getXMLZip ()
	getHTMLDirectory ()
	appendCopyInfo (int $target_id, int $copy_id)
	Prepend Copy info if object with same name exists in that container. More...
	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies. More...
	cloneMetaData (ilObject $target_obj)
	Copy meta data. More...
	selfOrParentWithRatingEnabled ()
	getPossibleSubObjects (bool $filter=true)
	get all possible sub objects of this type the object can decide which types of sub objects are possible jut in time overwrite if the decision distinguish from standard model More...

Protected Member Functions
	getWebLinkRepo ()
	doMDUpdateListener (string $a_element)
Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)
	beforeMDUpdateListener (string $a_element)
	doCreateMetaData ()
	beforeCreateMetaData ()
	doUpdateMetaData ()
	beforeUpdateMetaData ()
	doDeleteMetaData ()
	beforeDeleteMetaData ()
	handleAutoRating ()
	hasAutoRating ()

Protected Attributes
LOMServices	$lom_services
ilWebLinkDatabaseRepository	$repo
Protected Attributes inherited from ilObject
ilLogger	$obj_log
ILIAS	$ilias
ilObjectDefinition	$obj_definition
ilDBInterface	$db
ilLogger	$log
ilErrorHandling	$error
ilTree	$tree
ilAppEventHandler	$app_event_handler
ilRbacAdmin	$rbac_admin
ilRbacReview	$rbac_review
ilObjUser	$user
ilLanguage	$lng
LOMServices	$lom_services
bool	$call_by_reference
int	$max_title = self::TITLE_LENGTH
int	$max_desc = self::DESC_LENGTH
bool	$add_dots = true
int	$ref_id = null
string	$type = ""
string	$title = ""
string	$desc = ""
string	$long_desc = ""
int	$owner = 0
string	$create_date = ""
string	$last_update = ""
string	$import_id = ""
bool	$register = false

Additional Inherited Members
Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId (string $import_id)
	Get (latest) object id for an import id. More...
static	_lookupImportId (int $obj_id)
static	_lookupOwnerName (int $owner_id)
	Lookup owner name for owner id. More...
static	_getIdForImportId (string $import_id)
static	_getAllReferences (int $id)
	get all reference ids for object ID More...
static	_lookupTitle (int $obj_id)
static	lookupOfflineStatus (int $obj_id)
	Lookup offline status using objectDataCache. More...
static	_lookupOwner (int $obj_id)
	Lookup owner user ID for object ID. More...
static	_getIdsForTitle (string $title, string $type='', bool $partial_match=false)
static	_lookupDescription (int $obj_id)
static	_lookupLastUpdate (int $obj_id, bool $formatted=false)
static	_getLastUpdateOfObjects (array $obj_ids)
static	_lookupObjId (int $ref_id)
static	_setDeletedDate (int $ref_id, int $deleted_by)
static	setDeletedDates (array $ref_ids, int $user_id)
static	_resetDeletedDate (int $ref_id)
static	_lookupDeletedDate (int $ref_id)
static	_writeTitle (int $obj_id, string $title)
	write title to db (static) More...
static	_writeDescription (int $obj_id, string $desc)
	write description to db (static) More...
static	_writeImportId (int $obj_id, string $import_id)
	write import id to db (static) More...
static	_lookupType (int $id, bool $reference=false)
static	_isInTrash (int $ref_id)
static	_hasUntrashedReference (int $obj_id)
	checks whether an object has at least one reference that is not in trash More...
static	_lookupObjectId (int $ref_id)
static	_getObjectsDataForType (string $type, bool $omit_trash=false)
	get all objects of a certain type More...
static	_exists (int $id, bool $reference=false, ?string $type=null)
	checks if an object exists in object_data More...
static	_getObjectsByType (string $obj_type="", ?int $owner=null)
static	_prepareCloneSelection (array $ref_ids, string $new_type, bool $show_path=true)
	Prepare copy wizard object selection. More...
static	getIconForType (string $type)
static	_getIcon (int $obj_id=0, string $size="big", string $type="", bool $offline=false)
	Get icon for repository item. More...
static	collectDeletionDependencies (array &$deps, int $ref_id, int $obj_id, string $type, int $depth=0)
	Collect deletion dependencies. More...
static	getDeletionDependencies (int $obj_id)
	Get deletion dependencies. More...
static	getLongDescriptions (array $obj_ids)
static	getAllOwnedRepositoryObjects (int $user_id)
static	fixMissingTitles ($type, array &$obj_title_map)
	Try to fix missing object titles. More...
static	_lookupCreationDate (int $obj_id)
static	_getObjectTypeIdByTitle (string $type, ?\ilDBInterface $ilDB=null)
Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
const	DESC_LENGTH = 128
const	LONG_DESC_LENGTH = 4000
const	TABLE_OBJECT_DATA = "object_data"
array	$objectList
string	$untranslatedTitle

Detailed Description

Class ilObjLinkResource.

Author

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

Definition at line 27 of file class.ilObjLinkResource.php.

Constructor & Destructor Documentation

__construct()

ilObjLinkResource::__construct	(	int	$a_id = 0,
		bool	$a_call_by_reference = true
	)

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

References $DIC, and ILIAS\GlobalScreen\Provider\__construct().

    {
        global $DIC;

        $this->type = "webr";
        parent::__construct($a_id, $a_call_by_reference);

        $this->lom_services = $DIC->learningObjectMetadata();
    }

Here is the call graph for this function:

Member Function Documentation

cloneObject()

ilObjLinkResource::cloneObject	(	int	$target_id,
		int	$copy_id = 0,
		bool	$omit_tree = false
	)

Definition at line 129 of file class.ilObjLinkResource.php.

References $container, ilObjLinkResourceAccess\_getFirstLink(), ilObject\cloneMetaData(), ilWebLinkDatabaseRepository\createAllItemsInDraftContainer(), and getWebLinkRepo().

     : ?ilObject {
        $new_obj = parent::cloneObject($target_id, $copy_id, $omit_tree);
        $this->cloneMetaData($new_obj);

        // object created, now copy items and parameters
        $items = $this->getWebLinkRepo()->getAllItemsAsContainer()->getItems();
        $container = new ilWebLinkDraftItemsContainer();

        foreach ($items as $item) {
            $draft = new ilWebLinkDraftItem(
                $item->isInternal(),
                $item->getTitle(),
                $item->getDescription(),
                $item->getTarget(),
                $item->isActive(),
                $item->getParameters()
            );

            $container->addItem($draft);
        }

        $new_web_link_repo = new ilWebLinkDatabaseRepository($new_obj->getId());
        $new_web_link_repo->createAllItemsInDraftContainer($container);

        // append copy info weblink title
        if ($new_web_link_repo->doesOnlyOneItemExist(true)) {
            $item = ilObjLinkResourceAccess::_getFirstLink($new_obj->getId());
            $draft = new ilWebLinkDraftItem(
                $item->isInternal(),
                $new_obj->getTitle(),
                $new_obj->getDescription(),
                $item->getTarget(),
                $item->isActive(),
                $item->getParameters()
            );
            $new_web_link_repo->updateItem($item, $draft);
        }

        // make the new object a list if needed
        if ($this->getWebLinkRepo()->doesListExist()) {
            $draft_list = new ilWebLinkDraftList(
                $new_obj->getTitle(),
                $new_obj->getDescription()
            );
            $new_web_link_repo->createList($draft_list);
        }

        return $new_obj;
    }

Here is the call graph for this function:

create()

ilObjLinkResource::create

(

$a_upload = false

)

Todo:

how to handle this meta data switch

Definition at line 53 of file class.ilObjLinkResource.php.

References ilObject\createMetaData().

                                             : int
    {
        $new_id = parent::create();
        if (!$a_upload) {
            $this->createMetaData();
        }
        return $new_id;
    }

Here is the call graph for this function:

delete()

ilObjLinkResource::delete

(

)

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

References ilObject\deleteMetaData(), and getWebLinkRepo().

                            : bool
    {
        // always call parent delete function first!!
        if (!parent::delete()) {
            return false;
        }

        // delete items and list
        $this->getWebLinkRepo()->deleteAllItems();
        if ($this->getWebLinkRepo()->doesListExist()) {
            $this->getWebLinkRepo()->deleteList();
        }

        // delete meta data
        $this->deleteMetaData();

        return true;
    }

Here is the call graph for this function:

doMDUpdateListener()

ilObjLinkResource::doMDUpdateListener ( string  $a_element )

protected

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

References ilObject\$title, ilObject\getId(), ilObject\getType(), and getWebLinkRepo().

                                                            : void
    {
        if ($a_element !== 'General') {
            return;
        }

        $paths = $this->lom_services->paths();
        $reader = $this->lom_services->read(
            $this->getId(),
            0,
            $this->getType(),
            $paths->custom()->withNextStep('general')->get()
        );

        $title = $reader->firstData($paths->title())->value();
        $description = $reader->firstData($paths->firstDescription())->value();

        if (
            !$this->getWebLinkRepo()->doesListExist() &&
            $this->getWebLinkRepo()->doesOnlyOneItemExist()
        ) {
            $item = $this->getWebLinkRepo()->getAllItemsAsContainer()->getFirstItem();
            $draft = new ilWebLinkDraftItem(
                $item->isInternal(),
                $title,
                $description,
                $item->getTarget(),
                $item->isActive(),
                $item->getParameters()
            );
            $this->getWebLinkRepo()->updateItem($item, $draft);
        }
        if ($this->getWebLinkRepo()->doesListExist()) {
            $list = $this->getWebLinkRepo()->getList();
            $draft = new ilWebLinkDraftList(
                $title,
                $description
            );
            $this->getWebLinkRepo()->updateList($list, $draft);
        }
    }

Here is the call graph for this function:

getWebLinkRepo()

ilObjLinkResource::getWebLinkRepo ( )

protected

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

References $repo, and ilObject\getId().

Referenced by cloneObject(), delete(), doMDUpdateListener(), and toXML().

                                       : ilWebLinkRepository
    {
        if (isset($this->repo)) {
            return $this->repo;
        }
        return $this->repo = new ilWebLinkDatabaseRepository($this->getId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

toXML()

ilObjLinkResource::toXML	(	ilXmlWriter	$writer,
		bool	$skip_lom = false
	)

Definition at line 183 of file class.ilObjLinkResource.php.

References ilContainerSortingSettings\_lookupSortMode(), ilXmlWriter\appendXML(), ilObject\getDescription(), ilObject\getId(), ilObject\getTitle(), getWebLinkRepo(), IL_INST_ID, ilContainer\SORT_MANUAL, ilContainer\SORT_TITLE, ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

                                                                      : void
    {
        $attribs = array("obj_id" => "il_" . IL_INST_ID . "_webr_" . $this->getId(
        )
        );

        $writer->xmlStartTag('WebLinks', $attribs);

        if (!$skip_lom) {
            // LOM MetaData
            $md2xml = new ilMD2XML($this->getId(), $this->getId(), 'webr');
            $md2xml->startExport();
            $writer->appendXML($md2xml->getXML());
        }

        // Sorting
        switch (ilContainerSortingSettings::_lookupSortMode($this->getId())) {
            case ilContainer::SORT_MANUAL:
                $writer->xmlElement(
                    'Sorting',
                    array('type' => 'Manual')
                );
                break;

            case ilContainer::SORT_TITLE:
            default:
                $writer->xmlElement(
                    'Sorting',
                    array('type' => 'Title')
                );
                break;
        }

        if ($this->getWebLinkRepo()->doesListExist()) {
            $writer->xmlStartTag('ListSettings');
            $writer->xmlElement('ListTitle', [], $this->getTitle());
            $writer->xmlElement('ListDescription', [], $this->getDescription());
            $writer->xmlEndTag('ListSettings');
        }

        // All items
        $items = $this->getWebLinkRepo()->getAllItemsAsContainer()
                                        ->sort()
                                        ->getItems();

        $position = 0;
        foreach ($items as $item) {
            ++$position;
            $item->toXML($writer, $position);
        }

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

Here is the call graph for this function:

update()

ilObjLinkResource::update

(

)

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

References ilObject\updateMetaData().

                            : bool
    {
        $this->updateMetaData();
        return parent::update();
    }

Here is the call graph for this function:

Field Documentation

$lom_services

LOMServices ilObjLinkResource::$lom_services

protected

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

$repo

ilWebLinkDatabaseRepository ilObjLinkResource::$repo

protected

Definition at line 30 of file class.ilObjLinkResource.php.

Referenced by getWebLinkRepo().

---

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

• components/ILIAS/WebResource/classes/class.ilObjLinkResource.php