Inheritance diagram for ilObjContentPage:

Collaboration diagram for ilObjContentPage:

Public Member Functions
	__construct ($a_id=0, $a_reference=true)

	getObjectTranslation ()

	getStyleSheetId ()

	setStyleSheetId (int $styleId)

	writeStyleSheetId (int $styleId)

	getPageObjIds ()

	trackProgress (int $usrId)

Public Member Functions inherited from ilObject2
	__construct ($a_id=0, $a_reference=true)
	Constructor public. More...

	withReferences ()

	read ()
	Read data from db. More...

	setRefId ($a_id)

	getRefId ()

	getType ()

	setType ($a_type)

	getPresentationTitle ()

	getTitle ()

	getUntranslatedTitle ()

	setTitle ($a_title)

	getDescription ()

	setDescription ($a_desc)

	getLongDescription ()

	getImportId ()

	setImportId ($a_import_id)

	getOwner ()

	getOwnerName ()

	setOwner ($a_owner)

	getCreateDate ()

	getLastUpdateDate ()

	create ($a_clone_mode=false)

	update ()

	MDUpdateListener ($a_element)

	createMetaData ()

	updateMetaData ()

	deleteMetaData ()

	updateOwner ()

	putInTree ($a_parent_ref)

	setPermissions ($a_parent_ref)

	createReference ()

	countReferences ()

	delete ()

	initDefaultRoles ()

	setRegisterMode ($a_bool)

	isUserRegistered ($a_user_id=0)

	requireRegistration ()

	appendCopyInfo ($a_target_id, $a_copy_id)

	cloneMetaData ($target_obj)

	cloneObject ($a_target_id, $a_copy_id=null, $a_omit_tree=false)

	cloneDependencies ($a_target_id, $a_copy_id)

Public Member Functions inherited from ilObject
	__construct ($a_id=0, $a_reference=true)
	Constructor public. More...

	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not) More...

	read ()
	read object data from db into object More...

	getId ()
	get object id public More...

	setId ($a_id)
	set object id public More...

	setRefId ($a_id)
	set reference id public More...

	getRefId ()
	get reference id public More...

	getType ()
	get object type public More...

	setType ($a_type)
	set object type public More...

	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...

	getTitle ()
	get object title public More...

	getUntranslatedTitle ()
	get untranslated object title public More...

	setTitle ($a_title)
	set object title More...

	getDescription ()
	get object description More...

	setDescription ($a_desc)
	set object description More...

	getLongDescription ()
	get object long description (stored in object_description) More...

	getImportId ()
	get import id More...

	setImportId ($a_import_id)
	set import id More...

	setOfflineStatus ($a_status)
	Set offline status. More...

	getOfflineStatus ()
	Get offline status. More...

	supportsOfflineHandling ()
	Check whether object supports offline handling. More...

	getOwner ()
	get object owner More...

	getOwnerName ()

	setOwner ($a_owner)
	set object owner More...

	getCreateDate ()
	get create date public More...

	getLastUpdateDate ()
	get last update date public More...

	getDiskUsage ()
	Gets the disk usage of the object in bytes. More...

	create ()
	create More...

	update ()
	update object in db More...

	MDUpdateListener ($a_element)
	Meta data update listener. More...

	createMetaData ()
	create meta data entry More...

	updateMetaData ()
	update meta data entry More...

	deleteMetaData ()
	delete meta data entry More...

	updateOwner ()
	update owner of object in db More...

	putInTree ($a_parent_ref)
	maybe this method should be in tree object!? More...

	setPermissions ($a_parent_ref)
	set permissions of object More...

	setParentRolePermissions ($a_parent_ref)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates. More...

	createReference ()
	creates reference for object More...

	countReferences ()
	count references of object More...

	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 If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) public More...

	applyDidacticTemplate ($a_tpl_id)
	Apply template. More...

	setRegisterMode ($a_bool)

	isUserRegistered ($a_user_id=0)

	requireRegistration ()

	getXMLZip ()

	getHTMLDirectory ()

	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies. More...

	cloneMetaData ($target_obj)
	Copy meta data. More...

	getPossibleSubObjects ($a_filter=true)
	get all possible subobjects of this type the object can decide which types of subobjects are possible jut in time overwrite if the decision distinguish from standard model More...

Protected Member Functions
	initType ()

	doRead ()

	doCreate ()

	doUpdate ()

	doDelete ()

Protected Member Functions inherited from ilObject2
	initType ()

	doRead ()

	doCreate ()

	beforeCreate ()
	If overwritten this method should return true, there is currently no "abort" handling for cases where "false" is returned. More...

	doUpdate ()

	beforeUpdate ()

	doMDUpdateListener ($a_element)

	beforeMDUpdateListener ($a_element)

	doCreateMetaData ()

	beforeCreateMetaData ()

	doUpdateMetaData ()

	beforeUpdateMetaData ()

	doDelete ()

	beforeDelete ()

	doCloneObject ($new_obj, $a_target_id, $a_copy_id=null)

	beforeCloneObject ()

Protected Attributes
	$styleId = 0

	$objTrans

Protected Attributes inherited from ilObject
	$objDefinition

	$db

	$log

	$error

	$tree

	$app_event_handler

	$rbacadmin

	$rbacreview

Private Member Functions
	initTranslationService ()

	initPageMetricsService (ILIAS\Refinery\Factory $refinery)

Private Attributes
	$pageMetricsService

Additional Inherited Members
Static Public Member Functions inherited from ilObject2
static	_lookupObjIdByImportId ($a_import_id)

static	_lookupOwnerName ($a_owner_id)

static	_getIdForImportId ($a_import_id)

static	_getAllReferences ($a_id)

static	_lookupTitle ($a_id)

static	_lookupOwner ($a_id)

static	_getIdsForTitle ($title, $type='', $partialmatch=false)

static	_lookupDescription ($a_id)

static	_lookupLastUpdate ($a_id, $a_as_string=false)

static	_getLastUpdateOfObjects ($a_objs)

static	_lookupObjId ($a_id)

static	_setDeletedDate ($a_ref_id, $a_deleted_by)

static	_resetDeletedDate ($a_ref_id)

static	_lookupDeletedDate ($a_ref_id)

static	_writeTitle ($a_obj_id, $a_title)

static	_writeDescription ($a_obj_id, $a_desc)

static	_writeImportId ($a_obj_id, $a_import_id)

static	_lookupType ($a_id, $a_reference=false)

static	_isInTrash ($a_ref_id)

static	_hasUntrashedReference ($a_obj_id)

static	_lookupObjectId ($a_ref_id)

static	_getObjectsDataForType ($a_type, $a_omit_trash=false)

static	_exists ($a_id, $a_reference=false, $a_type=null)

static	_getObjectsByType ($a_obj_type="", $a_owner="")

static	_prepareCloneSelection ($a_ref_ids, $new_type, $a_show_path=true)

static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)

Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId ($a_import_id)

static	_lookupImportId ($a_obj_id)

static	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id More...

static	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...

static	_getAllReferences ($a_id)
	get all reference ids of object More...

static	_lookupTitle ($a_id)
	lookup object title More...

static	lookupOfflineStatus ($a_obj_id)
	Lookup offline status using objectDataCache. More...

static	_lookupOwner ($a_id)
	lookup object owner More...

static	_getIdsForTitle ($title, $type='', $partialmatch=false)

static	_lookupDescription ($a_id)
	lookup object description More...

static	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update More...

static	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects. More...

static	_lookupObjId ($a_id)

static	_setDeletedDate ($a_ref_id, $a_deleted_by)

static	setDeletedDates ($a_ref_ids, $a_user_id)
	Set deleted date. More...

static	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_writeTitle ($a_obj_id, $a_title)
	write title to db (static) More...

static	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static) More...

static	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static) More...

static	_lookupType ($a_id, $a_reference=false)
	lookup object type More...

static	_isInTrash ($a_ref_id)
	checks wether object is in trash More...

static	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash More...

static	_lookupObjectId ($a_ref_id)
	lookup object id More...

static	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type More...

static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks if an object exists in object_data More...

static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type. More...

static	_prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
	Prepare copy wizard object selection. More...

static	_getIcon ( $a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item. More...

static	collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies ($a_obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $a_obj_ids)
	Get long description data. More...

static	getAllOwnedRepositoryObjects ($a_user_id)
	Get all ids of objects user owns. More...

static	fixMissingTitles ($a_type, array &$a_obj_title_map)
	Try to fix missing object titles. More...

static	_lookupCreationDate ($a_id)
	Lookup creation date. More...

static	hasAutoRating ($a_type, $a_ref_id)
	Check if auto rating is active for parent group/course. More...

Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
	max length of object title More...

const	DESC_LENGTH = 128

	$lng

	$id

	$ref_id

	$type

	$title

	$untranslatedTitle

	$desc

	$long_desc

	$owner

	$create_date

	$last_update

	$import_id

	$register = false

	$referenced

	$objectList

	$max_title

	$max_desc

	$add_dots

Data Fields inherited from ilContentPageObjectConstants
const	OBJ_TYPE = 'copa'

const	HTTP_PARAM_PAGE_EDITOR_STYLE_CONTEXT = 'page_editor_style'

const	UI_CMD_VIEW = 'view'

const	UI_CMD_EDIT = 'edit'

const	UI_CMD_UPDATE = 'update'

const	UI_CMD_COPAGE_EDIT = 'edit'

const	UI_CMD_COPAGE_DOWNLOAD_FILE = 'downloadFile'

const	UI_CMD_COPAGE_DISPLAY_FULLSCREEN = 'displayMediaFullscreen'

const	UI_CMD_COPAGE_DISPLAY_MEDIA = 'displayMedia'

const	UI_CMD_COPAGE_DOWNLOAD_PARAGRAPH = 'download_paragraph'

const	UI_CMD_STYLES_EDIT = 'editStyleProperties'

const	UI_TAB_ID_CONTENT = 'content'

const	UI_TAB_ID_INFO = 'info_short'

const	UI_TAB_ID_SETTINGS = 'settings'

const	UI_TAB_ID_ICON = 'icon'

const	UI_TAB_ID_STYLE = 'style'

const	UI_TAB_ID_I18N = 'i18n'

const	UI_TAB_ID_LP = 'learning_progress'

const	UI_TAB_ID_EXPORT = 'export'

const	UI_TAB_ID_PERMISSIONS = 'perm_settings'

Detailed Description

Class ilObjContentPage.

Definition at line 12 of file class.ilObjContentPage.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjContentPage::__construct	(	$a_id = `0`,
		$a_reference = `true`
	)

Definition at line 24 of file class.ilObjContentPage.php.

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

     {
         global $DIC;
 
         parent::__construct($a_id, $a_reference);
         $this->initTranslationService();
         $this->initPageMetricsService($DIC->refinery());
     }

Here is the call graph for this function:

Member Function Documentation

◆ doCreate()

ilObjContentPage::doCreate ( )

protected

Definition at line 177 of file class.ilObjContentPage.php.

References ilObject\getId(), and initTranslationService().

     {
         parent::doCreate();
 
         $this->initTranslationService();
 
         $this->db->manipulateF(
             '
                         INSERT INTO content_page_data 
                         ( 
                                 content_page_id,
                                 stylesheet
                         )
                         VALUES(%s, %s)',
             ['integer', 'integer'],
             [$this->getId(), 0]
         );
     }

Here is the call graph for this function:

◆ doDelete()

ilObjContentPage::doDelete ( )

protected

Definition at line 225 of file class.ilObjContentPage.php.

References ilPageObject\_exists(), ilObject\getId(), ilObject2\getType(), and initTranslationService().

     {
         parent::doDelete();
 
         if (ilContentPagePage::_exists($this->getType(), $this->getId(), '', true)) {
             $originalPageObject = new ilContentPagePage($this->getId());
             $originalPageObject->delete();
         }
 
         $this->initTranslationService();
         $this->objTrans->delete();
 
         $this->db->manipulateF(
             'DELETE FROM content_page_metrics WHERE content_page_id = %s',
             ['integer'],
             [$this->getId()]
         );
 
         $this->db->manipulateF(
             'DELETE FROM content_page_data WHERE content_page_id = %s',
             ['integer'],
             [$this->getId()]
         );
     }

Here is the call graph for this function:

◆ doRead()

ilObjContentPage::doRead ( )

protected

Definition at line 157 of file class.ilObjContentPage.php.

References $data, $res, ilObject\getId(), initTranslationService(), and setStyleSheetId().

     {
         parent::doRead();
 
         $this->initTranslationService();
 
         $res = $this->db->queryF(
             'SELECT * FROM content_page_data WHERE content_page_id = %s',
             ['integer'],
             [$this->getId()]
         );
 
         while ($data = $this->db->fetchAssoc($res)) {
             $this->setStyleSheetId((int) $data['stylesheet']);
         }
     }

Here is the call graph for this function:

◆ doUpdate()

ilObjContentPage::doUpdate ( )

protected

Definition at line 200 of file class.ilObjContentPage.php.

References ilObject\getId(), ilObject2\getLongDescription(), getObjectTranslation(), getStyleSheetId(), ilObject2\getTitle(), and initTranslationService().

     {
         parent::doUpdate();
 
         $this->initTranslationService();
 
         $trans = $this->getObjectTranslation();
         $trans->setDefaultTitle($this->getTitle());
         $trans->setDefaultDescription($this->getLongDescription());
         $trans->save();
 
         $this->db->manipulateF(
             '
                         UPDATE content_page_data
                         SET
                                 stylesheet = %s
                         WHERE content_page_id = %s',
             ['integer', 'integer'],
             [$this->getStyleSheetId(), $this->getId()]
         );
     }

Here is the call graph for this function:

◆ getObjectTranslation()

ilObjContentPage::getObjectTranslation ( )

Returns: ilObjectTranslation|null

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

References $objTrans.

Referenced by doUpdate().

                                            : ? ilObjectTranslation
     {
         return $this->objTrans;
     }

Here is the caller graph for this function:

◆ getPageObjIds()

ilObjContentPage::getPageObjIds ( )

Returns: int[]

Definition at line 253 of file class.ilObjContentPage.php.

References $res, ilObject\getId(), and ilObject2\getType().

                                     : array
     {
         $pageObjIds = [];
 
         $sql = "SELECT DISTINCT page_id FROM page_object WHERE parent_id = %s AND parent_type = %s";
         $res = $this->db->queryF(
             $sql,
             ['integer', 'text'],
             [$this->getId(), $this->getType()]
         );
 
         while ($row = $this->db->fetchAssoc($res)) {
             $pageObjIds[] = $row['page_id'];
         }
 
         return $pageObjIds;
     }

Here is the call graph for this function:

◆ getStyleSheetId()

ilObjContentPage::getStyleSheetId ( )

Returns: int

Definition at line 70 of file class.ilObjContentPage.php.

References $styleId.

Referenced by doUpdate(), and writeStyleSheetId().

                                       : int
     {
         return (int) $this->styleId;
     }

Here is the caller graph for this function:

◆ initPageMetricsService()

ilObjContentPage::initPageMetricsService ( ILIAS\Refinery\Factory $refinery )

private

Parameters

Refinery $refinery

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

Referenced by __construct().

                                                                               : void
     {
         $this->pageMetricsService = new PageMetricsService(
             new PageMetricsRepositoryImp($this->db),
             $refinery
         );
     }

Here is the caller graph for this function:

◆ initTranslationService()

ilObjContentPage::initTranslationService ( )

private

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

References ilObject\getId(), and ilObjectTranslation\getInstance().

Referenced by __construct(), doCreate(), doDelete(), doRead(), and doUpdate().

                                               : void
     {
         if ($this->getId() > 0 && null === $this->objTrans) {
             $this->objTrans = ilObjectTranslation::getInstance($this->getId());
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initType()

ilObjContentPage::initType ( )

protected

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

     {
         $this->type = self::OBJ_TYPE;
     }

◆ setStyleSheetId()

ilObjContentPage::setStyleSheetId ( int $styleId )

Parameters

int $styleId

Definition at line 78 of file class.ilObjContentPage.php.

References $styleId.

Referenced by doRead(), and writeStyleSheetId().

     {
         $this->styleId = $styleId;
     }

Here is the caller graph for this function:

◆ trackProgress()

ilObjContentPage::trackProgress ( int $usrId )

Parameters

int $usrId

Definition at line 274 of file class.ilObjContentPage.php.

References ilLPStatus\_lookupStatus(), ilChangeEvent\_recordReadEvent(), ilLPStatusWrapper\_updateStatus(), ilObject\getId(), ilObjectLP\getInstance(), ilObject2\getRefId(), ilObject2\getType(), ilLPObjSettings\LP_MODE_CONTENT_VISITED, and ilLPStatus\LP_STATUS_COMPLETED_NUM.

                                               : void
     {
         ilChangeEvent::_recordReadEvent(
             $this->getType(),
             $this->getRefId(),
             $this->getId(),
             $usrId
         );
 
         $lp = ilObjectLP::getInstance($this->getId());
         if ($lp->isActive() && ((int) $lp->getCurrentMode() === ilLPObjSettings::LP_MODE_CONTENT_VISITED)) {
             $current_status = (int) ilLPStatus::_lookupStatus($this->getId(), $usrId, false);
             if ($current_status !== ilLPStatus::LP_STATUS_COMPLETED_NUM) {
                 ilLPStatusWrapper::_updateStatus(
                     $this->getId(),
                     $usrId
                 );
             }
         }
     }

Here is the call graph for this function:

◆ writeStyleSheetId()

ilObjContentPage::writeStyleSheetId ( int $styleId )

Parameters

int $styleId

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

References $styleId, ilPageObject\_exists(), ilContainer\_lookupContainerSetting(), ilObjStyleSheet\_lookupStandard(), ilContainer\_writeContainerSetting(), ilObject2\doCloneObject(), ilObject\getId(), ilObjectTranslation\getInstance(), ilObjectFactory\getInstanceByObjId(), getStyleSheetId(), ilObject2\getType(), ilObjectServiceSettingsGUI\INFO_TAB_VISIBILITY, ilPageObject\lookupTranslations(), and setStyleSheetId().

                                                     : void
     {
         $this->db->manipulateF(
             'UPDATE content_object SET stylesheet = %s WHERE id = %s',
             ['integer', 'integer'],
             [(int) $styleId, $this->getId()]
         );
 
         $this->setStyleSheetId($styleId);
     }

Here is the call graph for this function:

Field Documentation

◆ $objTrans

ilObjContentPage::$objTrans

protected

Definition at line 17 of file class.ilObjContentPage.php.

Referenced by getObjectTranslation().

◆ $pageMetricsService

ilObjContentPage::$pageMetricsService

private

Definition at line 19 of file class.ilObjContentPage.php.

◆ $styleId

ilObjContentPage::$styleId = 0

protected

Definition at line 15 of file class.ilObjContentPage.php.

Referenced by getStyleSheetId(), setStyleSheetId(), and writeStyleSheetId().

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

Modules/ContentPage/classes/class.ilObjContentPage.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ doCreate()

◆ doDelete()

◆ doRead()

◆ doUpdate()

◆ getObjectTranslation()

◆ getPageObjIds()

◆ getStyleSheetId()

◆ initPageMetricsService()

◆ initTranslationService()

◆ initType()

◆ setStyleSheetId()

◆ trackProgress()

◆ writeStyleSheetId()

Field Documentation

◆ $objTrans

◆ $pageMetricsService

◆ $styleId