Inheritance diagram for ilObjMediaCast:

Collaboration diagram for ilObjMediaCast:

Public Member Functions
	__construct ($a_id=0, $a_call_by_reference=true)
	Constructor public. More...

	setOnline ($a_online)
	Set Online. More...

	getOnline ()
	Get Online. More...

	setPublicFiles ($a_publicfiles)
	Set PublicFiles. More...

	getPublicFiles ()
	Get PublicFiles. More...

	setViewMode ($a_val)
	Set view mode. More...

	getViewMode ()
	Get view mode. More...

	setItemsArray ($a_itemsarray)
	Set ItemsArray. More...

	getItemsArray ()
	Get ItemsArray. More...

	getSortedItemsArray ()
	Get sorted items array. More...

	setDownloadable ($a_downloadable)
	Set Downloadable. More...

	getDownloadable ()
	Get Downloadable. More...

	getDefaultAccess ()
	return default access for news items More...

	setDefaultAccess ($value)
	set default access: 0 logged in users, 1 for public access More...

	setOrder ($a_value)
	Set order. More...

	getOrder ()
	Get order. More...

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

	create ()
	Create mew media cast. More...

	update ()
	update object data More...

	read ()
	Read media cast. More...

	delete ()
	delete object and all related data More...

	readItems ($a_oldest_first=false)
	Get all items of media cast. More...

	deleteOrder ()

	readOrder ()

	saveOrder (array $a_items)

	copyItems ($a_new_obj)
	Copy items. More...

	handleLPUpdate ($a_user_id, $a_mob_id)

	addMobToCast ($mob_id, $user_id, $long_desc="")
	Add mob to cast. More...

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...

Data Fields
const	ORDER_TITLE = 1

const	ORDER_CREATION_DATE_ASC = 2

const	ORDER_CREATION_DATE_DESC = 3

const	ORDER_MANUAL = 4

const	VIEW_LIST = ""

const	VIEW_GALLERY = "gallery"

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

Static Public Attributes
static	$purposes = array("Standard")

Protected Member Functions
	copyOrder ($newObj, $mapping)
	Copy order. More...

	getPlaytimeForSeconds (int $seconds)
	Get playtime for seconds. More...

Protected Attributes
	$user

	$online = false

	$publicfiles = false

	$downloadable = true

	$order

	$view_mode = ""

	$defaultAccess = 0

	$mob_mapping = []

Protected Attributes inherited from ilObject
	$objDefinition

	$db

	$log

	$error

	$tree

	$app_event_handler

	$rbacadmin

	$rbacreview

Additional Inherited Members
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...

Detailed Description

Class ilObjMediaCast.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

Definition at line 14 of file class.ilObjMediaCast.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjMediaCast::__construct	(	$a_id = `0`,
		$a_call_by_reference = `true`
	)

Constructor public.

Parameters

integer	reference_id or object_id
boolean	treat the id as reference_id (true) or object_id (false)

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

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

     {
         global $DIC;
 
         $this->db = $DIC->database();
         $this->user = $DIC->user();
         $this->type = "mcst";
         parent::__construct($a_id, $a_call_by_reference);
         $mcst_set = new ilSetting("mcst");
         $this->setDefaultAccess($mcst_set->get("defaultaccess") == "users" ? 0 : 1);
         $this->setOrder(self::ORDER_CREATION_DATE_DESC);
     }

Here is the call graph for this function:

Member Function Documentation

◆ addMobToCast()

ilObjMediaCast::addMobToCast	(	$mob_id,
		$user_id,
		$long_desc = `""`
	)

Add mob to cast.

Parameters

	$mob_id
	$user_id
string	$long_desc

Definition at line 569 of file class.ilObjMediaCast.php.

References ilObject\$long_desc, ilObject\getId(), ilObjectLP\getInstance(), getPlaytimeForSeconds(), ilObject\getType(), and NEWS_AUDIO.

     {
         $mob = new ilObjMediaObject($mob_id);
         $news_set = new ilSetting("news");
         $enable_internal_rss = $news_set->get("enable_rss_for_internal");
 
         // create new media cast item
         $mc_item = new ilNewsItem();
         $mc_item->setMobId($mob->getId());
         $mc_item->setContentType(NEWS_AUDIO);
         $mc_item->setContextObjId($this->getId());
         $mc_item->setContextObjType($this->getType());
         $mc_item->setUserId($user_id);
         $med_item = $mob->getMediaItem("Standard");
         $mc_item->setPlaytime($this->getPlaytimeForSeconds($med_item->getDuration()));
         $mc_item->setTitle($mob->getTitle());
         $mc_item->setContent($mob->getLongDescription());
         if ($long_desc != "") {
             $mc_item->setContent($long_desc);
         }
         $mc_item->setLimitation(false);
         // @todo handle visibility
         $mc_item->create();
 
         $lp = ilObjectLP::getInstance($this->getId());
 
         // see ilLPListOfSettingsGUI assign
         $collection = $lp->getCollectionInstance();
         if ($collection && $collection->hasSelectableItems()) {
             /* not yet...
             $collection->activateEntries([$mob_id]);
             $lp->resetCaches();
             ilLPStatusWrapper::_refreshStatus($this->getId());
             */
         }
         return $mc_item->getId();
     }

Here is the call graph for this function:

◆ copyItems()

ilObjMediaCast::copyItems ( $a_new_obj )

Copy items.

Parameters

Definition at line 515 of file class.ilObjMediaCast.php.

References $ilUser, $user, NEWS_AUDIO, and readItems().

Referenced by copyOrder().

     {
         $ilUser = $this->user;
 
         $item_mapping = [];
         include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
         foreach ($this->readItems(true) as $item) {
             // copy media object
             $mob_id = $item["mob_id"];
             $mob = new ilObjMediaObject($mob_id);
             $new_mob = $mob->duplicate();
 
             // copy news item
             // create new media cast item
             include_once("./Services/News/classes/class.ilNewsItem.php");
             $mc_item = new ilNewsItem();
             $mc_item->setMobId($new_mob->getId());
             $mc_item->setContentType(NEWS_AUDIO);
             $mc_item->setContextObjId($a_new_obj->getId());
             $mc_item->setContextObjType($a_new_obj->getType());
             $mc_item->setUserId($ilUser->getId());
             $mc_item->setPlaytime($item["playtime"]);
             $mc_item->setTitle($item["title"]);
             $mc_item->setContent($item["content"]);
             $mc_item->setVisibility($item["visibility"]);
             $mc_item->create();
             $this->mob_mapping[$mob_id] = $new_mob->getId();
             $item_mapping[$item["id"]] = $mc_item->getId();
         }
         return $item_mapping;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ copyOrder()

ilObjMediaCast::copyOrder	(	$newObj,
		$mapping
	)

protected

Copy order.

Definition at line 447 of file class.ilObjMediaCast.php.

References $i, $mob_mapping, ilCopyWizardOptions\_getInstance(), ilBlockSetting\_lookup(), ilBlockSetting\_write(), copyItems(), getDefaultAccess(), getDownloadable(), ilObject\getId(), ilObjectLP\getInstance(), getOnline(), getOrder(), getPublicFiles(), getViewMode(), and readOrder().

     {
         $items = [];
         foreach ($this->readOrder() as $i) {
             $items[] = $mapping[$i];
         }
         $newObj->saveOrder($items);
     }

Here is the call graph for this function:

◆ create()

ilObjMediaCast::create ( )

Create mew media cast.

Definition at line 263 of file class.ilObjMediaCast.php.

References ilObject\$db, $ilDB, $query, getDefaultAccess(), getDownloadable(), ilObject\getId(), getOnline(), getOrder(), getPublicFiles(), and getViewMode().

     {
         $ilDB = $this->db;
 
         parent::create();
         
         $query = "INSERT INTO il_media_cast_data (" .
             " id" .
             ", is_online" .
             ", public_files" .
             ", downloadable" .
             ", def_access" .
             ", sortmode" .
             ", viewmode" .
             " ) VALUES (" .
             $ilDB->quote($this->getId(), "integer")
             . "," . $ilDB->quote((int) $this->getOnline(), "integer")
             . "," . $ilDB->quote((int) $this->getPublicFiles(), "integer")
             . "," . $ilDB->quote((int) $this->getDownloadable(), "integer")
             . "," . $ilDB->quote((int) $this->getDefaultAccess(), "integer")
             . "," . $ilDB->quote((int) $this->getOrder(), "integer")
             . "," . $ilDB->quote((int) $this->getViewMode(), "text")
             . ")";
         $ilDB->manipulate($query);
     }

Here is the call graph for this function:

◆ delete()

ilObjMediaCast::delete ( )

delete object and all related data

public

Returns: boolean true if all object data were removed; false if only a references were removed

Definition at line 348 of file class.ilObjMediaCast.php.

References ilObject\$db, $ilDB, $query, deleteOrder(), ilObject\getId(), and getItemsArray().

     {
         $ilDB = $this->db;
 
         // always call parent delete function first!!
         if (!parent::delete()) {
             return false;
         }
 
         // delete all items
         $med_items = $this->getItemsArray();
         foreach ($med_items as $item) {
             include_once("./Services/News/classes/class.ilNewsItem.php");
             $news_item = new ilNewsItem($item["id"]);
             $news_item->delete();
         }
         
         $this->deleteOrder();
 
         // delete record of table il_media_cast_data
         $query = "DELETE FROM il_media_cast_data" .
             " WHERE id = " . $ilDB->quote($this->getId(), "integer");
         $ilDB->manipulate($query);
         
         return true;
     }

Here is the call graph for this function:

◆ deleteOrder()

ilObjMediaCast::deleteOrder ( )

Definition at line 390 of file class.ilObjMediaCast.php.

References ilObject\$db, $ilDB, and ilObject\getId().

Referenced by delete(), and saveOrder().

     {
         $ilDB = $this->db;
         
         if (!$this->getId()) {
             return;
         }
         
         $sql = "DELETE FROM il_media_cast_data_ord" .
             " WHERE obj_id = " . $ilDB->quote($this->getId(), "integer");
         $ilDB->manipulate($sql);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultAccess()

ilObjMediaCast::getDefaultAccess ( )

return default access for news items

Returns: int 0 for logged in users, 1 for public access

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

References $defaultAccess.

Referenced by copyOrder(), create(), and update().

     {
         return $this->defaultAccess;
     }

Here is the caller graph for this function:

◆ getDiskUsage()

ilObjMediaCast::getDiskUsage ( )

Gets the disk usage of the object in bytes.

public

Returns: integer the disk usage in bytes

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

References ilObjMediaCastAccess\_lookupDiskUsage().

     {
         require_once("./Modules/MediaCast/classes/class.ilObjMediaCastAccess.php");
         return ilObjMediaCastAccess::_lookupDiskUsage($this->id);
     }

Here is the call graph for this function:

◆ getDownloadable()

ilObjMediaCast::getDownloadable ( )

Get Downloadable.

Returns: boolean Downloadable

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

References $downloadable.

Referenced by copyOrder(), create(), and update().

     {
         return $this->downloadable;
     }

Here is the caller graph for this function:

◆ getItemsArray()

ilObjMediaCast::getItemsArray ( )

Get ItemsArray.

Returns: array ItemsArray

Definition at line 140 of file class.ilObjMediaCast.php.

Referenced by delete(), and getSortedItemsArray().

     {
         return $this->itemsarray;
     }

Here is the caller graph for this function:

◆ getOnline()

ilObjMediaCast::getOnline ( )

Get Online.

Returns: boolean Online

Definition at line 81 of file class.ilObjMediaCast.php.

References $online.

Referenced by copyOrder(), create(), and update().

     {
         return $this->online;
     }

Here is the caller graph for this function:

◆ getOrder()

ilObjMediaCast::getOrder ( )

Get order.

Returns: boolean

Definition at line 243 of file class.ilObjMediaCast.php.

References $order.

Referenced by copyOrder(), create(), getSortedItemsArray(), and update().

     {
         return $this->order;
     }

Here is the caller graph for this function:

◆ getPlaytimeForSeconds()

ilObjMediaCast::getPlaytimeForSeconds ( int $seconds )

protected

Get playtime for seconds.

Parameters

int

Returns: string

Definition at line 612 of file class.ilObjMediaCast.php.

Referenced by addMobToCast().

     {
         $hours = floor($seconds / 3600);
         $minutes = floor(($seconds % 3600) / 60);
         $seconds = $seconds % 60;
         $duration = str_pad($hours, 2, "0", STR_PAD_LEFT) . ":" .
             str_pad($minutes, 2, "0", STR_PAD_LEFT) . ":" .
             str_pad($seconds, 2, "0", STR_PAD_LEFT);
         return $duration;
     }

Here is the caller graph for this function:

◆ getPublicFiles()

ilObjMediaCast::getPublicFiles ( )

Get PublicFiles.

Returns: boolean PublicFiles

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

References $publicfiles.

Referenced by copyOrder(), create(), and update().

     {
         return $this->publicfiles;
     }

Here is the caller graph for this function:

◆ getSortedItemsArray()

ilObjMediaCast::getSortedItemsArray ( )

Get sorted items array.

Parameters

Definition at line 151 of file class.ilObjMediaCast.php.

References $order, getItemsArray(), getOrder(), ORDER_CREATION_DATE_ASC, ORDER_CREATION_DATE_DESC, ORDER_MANUAL, ORDER_TITLE, readOrder(), and ilUtil\sortArray().

     {
         $med_items = $this->getItemsArray();
 
         // sort by order setting
         switch ($this->getOrder()) {
             case ilObjMediaCast::ORDER_TITLE:
                 $med_items = ilUtil::sortArray($med_items, "title", "asc", false, true);
                 break;
             
             case ilObjMediaCast::ORDER_CREATION_DATE_ASC:
                 $med_items = ilUtil::sortArray($med_items, "creation_date", "asc", false, true);
                 break;
             
             case ilObjMediaCast::ORDER_CREATION_DATE_DESC:
                 $med_items = ilUtil::sortArray($med_items, "creation_date", "desc", false, true);
                 break;
             
             case ilObjMediaCast::ORDER_MANUAL:
                 $order = array_flip($this->readOrder());
                 $pos = sizeof($order);
                 foreach (array_keys($med_items) as $idx) {
                     if (array_key_exists($idx, $order)) {
                         $med_items[$idx]["order"] = ($order[$idx] + 1) * 10;
                     }
                     // item has no order yet
                     else {
                         $med_items[$idx]["order"] = (++$pos) * 10;
                     }
                 }
                 
                 $med_items = ilUtil::sortArray($med_items, "order", "asc", true, true);
                 break;
         }
 
         return $med_items;
     }

Here is the call graph for this function:

◆ getViewMode()

ilObjMediaCast::getViewMode ( )

Get view mode.

Returns: string view mode

Definition at line 121 of file class.ilObjMediaCast.php.

References $view_mode.

Referenced by copyOrder(), create(), and update().

     {
         return $this->view_mode;
     }

Here is the caller graph for this function:

◆ handleLPUpdate()

ilObjMediaCast::handleLPUpdate	(	$a_user_id,
		$a_mob_id
	)

Definition at line 547 of file class.ilObjMediaCast.php.

References ilChangeEvent\_recordReadEvent(), ilLPStatusWrapper\_updateStatus(), ilObject\getId(), and ilObject\getRefId().

     {
         // using read events to persist mob status
         require_once 'Services/Tracking/classes/class.ilChangeEvent.php';
         ilChangeEvent::_recordReadEvent(
             "mob",
             $this->getRefId(),
             $a_mob_id,
             $a_user_id
         );
         
         // trigger LP update
         require_once 'Services/Tracking/classes/class.ilLPStatusWrapper.php';
         ilLPStatusWrapper::_updateStatus($this->getId(), $a_user_id);
     }

Here is the call graph for this function:

◆ read()

ilObjMediaCast::read ( )

Read media cast.

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

References ilObject\$db, $ilDB, $query, ilObject\getId(), readItems(), setDefaultAccess(), setDownloadable(), setOnline(), setOrder(), setPublicFiles(), and setViewMode().

     {
         $ilDB = $this->db;
         
         parent::read();
         $this->readItems();
         
         $query = "SELECT * FROM il_media_cast_data WHERE id = " .
             $ilDB->quote($this->getId(), "integer");
         $set = $ilDB->query($query);
         $rec = $ilDB->fetchAssoc($set);
 
         $this->setOnline($rec["is_online"]);
         $this->setPublicFiles($rec["public_files"]);
         $this->setDownloadable($rec["downloadable"]);
         $this->setDefaultAccess($rec["def_access"]);
         $this->setOrder($rec["sortmode"]);
         $this->setViewMode($rec["viewmode"]);
     }

Here is the call graph for this function:

◆ readItems()

ilObjMediaCast::readItems ( $a_oldest_first = false )

Get all items of media cast.

Definition at line 378 of file class.ilObjMediaCast.php.

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

Referenced by copyItems(), and read().

     {
         //
         include_once("./Services/News/classes/class.ilNewsItem.php");
         $it = new ilNewsItem();
         $it->setContextObjId($this->getId());
         $it->setContextObjType($this->getType());
         $this->itemsarray = $it->queryNewsForContext(false, 0, "", false, $a_oldest_first);
         
         return $this->itemsarray;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readOrder()

ilObjMediaCast::readOrder ( )

Definition at line 403 of file class.ilObjMediaCast.php.

References ilObject\$db, $ilDB, $res, and ilObject\getId().

Referenced by copyOrder(), and getSortedItemsArray().

     {
         $ilDB = $this->db;
         
         if (!$this->getId()) {
             return;
         }
         
         $all = array();
         $sql = "SELECT item_id FROM il_media_cast_data_ord" .
             " WHERE obj_id = " . $ilDB->quote($this->getId(), "integer") .
             " ORDER BY pos";
         $res = $ilDB->query($sql);
         while ($row = $ilDB->fetchAssoc($res)) {
             $all[] = $row["item_id"];
         }
         return $all;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveOrder()

ilObjMediaCast::saveOrder ( array $a_items )

Definition at line 422 of file class.ilObjMediaCast.php.

References ilObject\$db, $ilDB, deleteOrder(), and ilObject\getId().

     {
         $ilDB = $this->db;
         
         if (!$this->getId()) {
             return;
         }
         
         $this->deleteOrder();
         
         $pos = 0;
         foreach ($a_items as $item_id) {
             $pos++;
             
             $sql = "INSERT INTO il_media_cast_data_ord (obj_id,item_id,pos)" .
                 " VALUES (" . $ilDB->quote($this->getId(), "integer") . "," .
                 $ilDB->quote($item_id, "integer") . "," .
                 $ilDB->quote($pos, "integer") . ")";
             $ilDB->manipulate($sql);
         }
     }

Here is the call graph for this function:

◆ setDefaultAccess()

ilObjMediaCast::setDefaultAccess ( $value )

set default access: 0 logged in users, 1 for public access

Parameters

int $value

Definition at line 224 of file class.ilObjMediaCast.php.

Referenced by __construct(), and read().

     {
         $this->defaultAccess = (int) $value == 0 ? 0 : 1;
     }

Here is the caller graph for this function:

◆ setDownloadable()

ilObjMediaCast::setDownloadable ( $a_downloadable )

Set Downloadable.

Parameters

boolean $a_downloadable Downloadable

Definition at line 195 of file class.ilObjMediaCast.php.

Referenced by read().

     {
         $this->downloadable = $a_downloadable;
     }

Here is the caller graph for this function:

◆ setItemsArray()

ilObjMediaCast::setItemsArray ( $a_itemsarray )

Set ItemsArray.

Parameters

array $a_itemsarray ItemsArray

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

     {
         $this->itemsarray = $a_itemsarray;
     }

◆ setOnline()

ilObjMediaCast::setOnline ( $a_online )

Set Online.

Parameters

boolean $a_online Online

Definition at line 71 of file class.ilObjMediaCast.php.

Referenced by read().

     {
         $this->online = $a_online;
     }

Here is the caller graph for this function:

◆ setOrder()

ilObjMediaCast::setOrder ( $a_value )

Set order.

Parameters

boolean $a_value

Definition at line 234 of file class.ilObjMediaCast.php.

Referenced by __construct(), and read().

     {
         $this->order = $a_value;
     }

Here is the caller graph for this function:

◆ setPublicFiles()

ilObjMediaCast::setPublicFiles ( $a_publicfiles )

Set PublicFiles.

Parameters

boolean $a_publicfiles PublicFiles

Definition at line 91 of file class.ilObjMediaCast.php.

Referenced by read().

     {
         $this->publicfiles = $a_publicfiles;
     }

Here is the caller graph for this function:

◆ setViewMode()

ilObjMediaCast::setViewMode ( $a_val )

Set view mode.

Parameters

string $a_val view mode

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

Referenced by read().

     {
         $this->view_mode = $a_val;
     }

Here is the caller graph for this function:

◆ update()

ilObjMediaCast::update ( )

update object data

public

Returns: boolean

Definition at line 295 of file class.ilObjMediaCast.php.

References ilObject\$db, $ilDB, $query, getDefaultAccess(), getDownloadable(), ilObject\getId(), getOnline(), getOrder(), getPublicFiles(), and getViewMode().

     {
         $ilDB = $this->db;
         
         if (!parent::update()) {
             return false;
         }
 
         // update media cast data
         $query = "UPDATE il_media_cast_data SET " .
             " is_online = " . $ilDB->quote((int) $this->getOnline(), "integer") .
             ", public_files = " . $ilDB->quote((int) $this->getPublicFiles(), "integer") .
             ", downloadable = " . $ilDB->quote((int) $this->getDownloadable(), "integer") .
             ", def_access = " . $ilDB->quote((int) $this->getDefaultAccess(), "integer") .
             ", sortmode = " . $ilDB->quote((int) $this->getOrder(), "integer") .
             ", viewmode = " . $ilDB->quote($this->getViewMode(), "text") .
             " WHERE id = " . $ilDB->quote((int) $this->getId(), "integer");
 
         $ilDB->manipulate($query);
 
         return true;
     }

Here is the call graph for this function:

Field Documentation

◆ $defaultAccess

ilObjMediaCast::$defaultAccess = 0

protected

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

Referenced by getDefaultAccess().

◆ $downloadable

ilObjMediaCast::$downloadable = true

protected

Definition at line 25 of file class.ilObjMediaCast.php.

Referenced by getDownloadable().

◆ $mob_mapping

ilObjMediaCast::$mob_mapping = []

protected

Definition at line 45 of file class.ilObjMediaCast.php.

Referenced by copyOrder().

◆ $online

ilObjMediaCast::$online = false

protected

Definition at line 23 of file class.ilObjMediaCast.php.

Referenced by getOnline().

◆ $order

ilObjMediaCast::$order

protected

Definition at line 26 of file class.ilObjMediaCast.php.

Referenced by getOrder(), and getSortedItemsArray().

◆ $publicfiles

ilObjMediaCast::$publicfiles = false

protected

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

Referenced by getPublicFiles().

◆ $purposes

ilObjMediaCast::$purposes = array("Standard")

static

Definition at line 22 of file class.ilObjMediaCast.php.

Referenced by ilMediaCastTableGUI\fillRow(), ilObjMediaCastGUI\getCastItemValues(), ilObjMediaCastGUI\getFeedIconsHTML(), ilObjMediaCastGUI\initAddCastItemForm(), ilMediaCastSettings\initStorage(), ilObjMediaCastGUI\populateFormFromPost(), and ilObjMediaCastGUI\updateCastItemObject().

◆ $user

ilObjMediaCast::$user

protected

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

Referenced by copyItems().

◆ $view_mode

ilObjMediaCast::$view_mode = ""

protected

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

Referenced by getViewMode().

◆ ORDER_CREATION_DATE_ASC

const ilObjMediaCast::ORDER_CREATION_DATE_ASC = 2

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

Referenced by ilObjMediaCastGUI\editOrderObject(), getSortedItemsArray(), and ilObjMediaCastGUI\initSettingsForm().

◆ ORDER_CREATION_DATE_DESC

const ilObjMediaCast::ORDER_CREATION_DATE_DESC = 3

Definition at line 31 of file class.ilObjMediaCast.php.

Referenced by ilObjMediaCastGUI\editOrderObject(), getSortedItemsArray(), and ilObjMediaCastGUI\initSettingsForm().

◆ ORDER_MANUAL

const ilObjMediaCast::ORDER_MANUAL = 4

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

Referenced by ilObjMediaCastGUI\addContentSubTabs(), ilObjMediaCastGUI\editOrderObject(), getSortedItemsArray(), and ilObjMediaCastGUI\initSettingsForm().

◆ ORDER_TITLE

const ilObjMediaCast::ORDER_TITLE = 1

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

Referenced by ilObjMediaCastGUI\editOrderObject(), getSortedItemsArray(), and ilObjMediaCastGUI\initSettingsForm().

◆ VIEW_GALLERY

const ilObjMediaCast::VIEW_GALLERY = "gallery"

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

Referenced by ilObjMediaCastGUI\initSettingsForm(), and ilObjMediaCastGUI\showContentObject().

◆ VIEW_LIST

const ilObjMediaCast::VIEW_LIST = ""

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

Referenced by ilObjMediaCastGUI\initSettingsForm().

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

Modules/MediaCast/classes/class.ilObjMediaCast.php

Public Member Functions

Data Fields

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addMobToCast()

◆ copyItems()

◆ copyOrder()

◆ create()

◆ delete()

◆ deleteOrder()

◆ getDefaultAccess()

◆ getDiskUsage()

◆ getDownloadable()

◆ getItemsArray()

◆ getOnline()

◆ getOrder()

◆ getPlaytimeForSeconds()

◆ getPublicFiles()

◆ getSortedItemsArray()

◆ getViewMode()

◆ handleLPUpdate()

◆ read()

◆ readItems()

◆ readOrder()

◆ saveOrder()

◆ setDefaultAccess()

◆ setDownloadable()

◆ setItemsArray()

◆ setOnline()

◆ setOrder()

◆ setPublicFiles()

◆ setViewMode()

◆ update()

Field Documentation

◆ $defaultAccess

◆ $downloadable

◆ $mob_mapping

◆ $online

◆ $order

◆ $publicfiles

◆ $purposes

◆ $user

◆ $view_mode

◆ ORDER_CREATION_DATE_ASC

◆ ORDER_CREATION_DATE_DESC

◆ ORDER_MANUAL

◆ ORDER_TITLE

◆ VIEW_GALLERY

◆ VIEW_LIST