This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilObjMediaCast:

Collaboration diagram for ilObjMediaCast:

Public Member Functions
	__construct (int $a_id=0, bool $a_call_by_reference=true)

	setOnline (bool $a_online)

	getOnline ()

	setComments (bool $comments)

	getComments ()

	setPublicFiles (bool $a_publicfiles)

	getPublicFiles ()

	setViewMode (string $a_val)

	getViewMode ()

	setItemsArray (array $a_itemsarray)

	getItemsArray ()

	setAutoplayMode (int $a_val)

	getAutoplayMode ()

	setNumberInitialVideos (int $a_val)

	getNumberInitialVideos ()

	setNewItemsInLearningProgress (bool $a_val)
	Set new items automatically in lp. More...

	getNewItemsInLearningProgress ()

	getSortedItemsArray ()

	setDownloadable (bool $a_downloadable)

	getDownloadable ()

	getDefaultAccess ()

	setDefaultAccess (int $value)

	setOrder (int $a_value)

	getOrder ()

	create ()

	update ()

	read ()

	delete ()

	readItems (bool $a_oldest_first=false)

	deleteOrder ()

	readOrder ()

	saveOrder (array $a_items)

	copyItems (ilObjMediaCast $a_new_obj)

	handleLPUpdate (int $a_user_id, int $a_mob_id)

	addMobToCast (int $mob_id, int $user_id, string $long_desc="", bool $extract=false)
	Add media object to media cast. More...

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

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

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"

const	VIEW_IMG_GALLERY = "img_gallery"

const	VIEW_PODCAST = "podcast"

const	VIEW_VCAST = "video"

const	AUTOPLAY_NO = 0

const	AUTOPLAY_ACT = 1

const	AUTOPLAY_INACT = 2

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

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

Protected Member Functions
	copyOrder (ilObjMediaCast $newObj, array $mapping)

Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)

	beforeMDUpdateListener (string $a_element)

	doCreateMetaData ()

	beforeCreateMetaData ()

	doUpdateMetaData ()

	beforeUpdateMetaData ()

	doDeleteMetaData ()

	beforeDeleteMetaData ()

	handleAutoRating ()

	hasAutoRating ()

Protected Attributes
bool	$comments = false

ILIAS Notes Service	$notes

ILIAS MediaCast InternalDomainService	$domain

ILIAS MediaObjects Tracking TrackingManager	$mob_tracking

array	$itemsarray

ilObjUser	$user

bool	$online = false

bool	$publicfiles = false

bool	$downloadable = true

int	$order = 0

string	$view_mode = self::VIEW_VCAST

int	$defaultAccess = 0

array	$mob_mapping = []

int	$nr_initial_videos = 5

bool	$new_items_in_lp = true

int	$autoplay_mode = self::AUTOPLAY_ACT

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)

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilObjMediaCast

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

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

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ addMobToCast()

ilObjMediaCast::addMobToCast	(	int	$mob_id,
		int	$user_id,
		string	$long_desc = `""`,
		bool	$extract = `false`
	)

Add media object to media cast.

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

References Vendor\Package\$e, ilObject\$long_desc, getDefaultAccess(), ilObject\getId(), getPlaytimeForSeconds(), ilObject\getType(), and NEWS_AUDIO.

      : int {
         $mob = new ilObjMediaObject($mob_id);
         if ($extract) {
             try {
                 $mob->getExternalMetadata();
             } catch (Exception $e) {
             }
         }
         $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);
         $mc_item->setVisibility($this->getDefaultAccess() == 0 ? "users" : "public");
         $mc_item->create();
 
         $lp = $this->domain->learningProgress($this);
         $lp->addItemToLP($mob_id);
 
         return $mc_item->getId();
     }

Here is the call graph for this function:

◆ copyItems()

ilObjMediaCast::copyItems ( ilObjMediaCast $a_new_obj )

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

References $user, ilObject\getId(), ilObject\getType(), NEWS_AUDIO, and readItems().

Referenced by copyOrder().

                                                         : array
     {
         $ilUser = $this->user;
 
         $item_mapping = [];
         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
             $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"] ?? "users");
             $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	(	ilObjMediaCast	$newObj,
		array	$mapping
	)

protected

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

References ilCopyWizardOptions\_getInstance(), ilBlockSetting\_lookup(), ilBlockSetting\_write(), ilObject\cloneMetaData(), copyItems(), getAutoplayMode(), getDefaultAccess(), getDownloadable(), ilObject\getId(), ilObjectLP\getInstance(), getNewItemsInLearningProgress(), getNumberInitialVideos(), getOnline(), getOrder(), getPublicFiles(), getViewMode(), ILIAS\Repository\int(), readOrder(), and saveOrder().

      : void {
         $items = [];
         foreach ($this->readOrder() as $i) {
             if (!array_key_exists($i, $mapping)) {
                 continue;
             }
             $items[] = $mapping[$i];
         }
         $newObj->saveOrder($items);
     }

Here is the call graph for this function:

◆ create()

ilObjMediaCast::create ( )

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

References ilObject\$db, $id, $ilDB, ilObject\createMetaData(), getAutoplayMode(), getDefaultAccess(), getDownloadable(), ilObject\getId(), getNewItemsInLearningProgress(), getNumberInitialVideos(), getOnline(), getOrder(), getPublicFiles(), and getViewMode().

                             : int
     {
         $ilDB = $this->db;
 
         $id = parent::create();
 
         $this->createMetaData();
 
         $query = "INSERT INTO il_media_cast_data (" .
             " id" .
             ", is_online" .
             ", public_files" .
             ", downloadable" .
             ", def_access" .
             ", sortmode" .
             ", viewmode" .
             ", autoplaymode" .
             ", nr_initial_videos" .
             ", new_items_in_lp" .
             " ) 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($this->getViewMode(), "text")
             . "," . $ilDB->quote((int) $this->getAutoplayMode(), "integer")
             . "," . $ilDB->quote((int) $this->getNumberInitialVideos(), "integer")
             . "," . $ilDB->quote((int) $this->getNewItemsInLearningProgress(), "integer")
             . ")";
         $ilDB->manipulate($query);
         return $id;
     }

Here is the call graph for this function:

◆ delete()

ilObjMediaCast::delete ( )

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

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

                             : bool
     {
         $ilDB = $this->db;
 
         // always call parent delete function first!!
         if (!parent::delete()) {
             return false;
         }
 
         $this->deleteMetaData();
 
         // delete all items
         $med_items = $this->getItemsArray();
         foreach ($med_items as $item) {
             $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 356 of file class.ilObjMediaCast.php.

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

Referenced by delete(), and saveOrder().

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

◆ getAutoplayMode()

ilObjMediaCast::getAutoplayMode ( )

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

References $autoplay_mode.

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

                                      : int
     {
         return $this->autoplay_mode;
     }

Here is the caller graph for this function:

◆ getComments()

ilObjMediaCast::getComments ( )

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

References $comments.

Referenced by update().

                                  : bool
     {
         return $this->comments;
     }

Here is the caller graph for this function:

◆ getDefaultAccess()

ilObjMediaCast::getDefaultAccess ( )

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

References $defaultAccess.

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

                                       : int
     {
         return $this->defaultAccess;
     }

Here is the caller graph for this function:

◆ getDownloadable()

ilObjMediaCast::getDownloadable ( )

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

References $downloadable.

Referenced by ilMediaCastTableGUI\__construct(), copyOrder(), create(), and update().

                                      : bool
     {
         return $this->downloadable;
     }

Here is the caller graph for this function:

◆ getItemsArray()

ilObjMediaCast::getItemsArray ( )

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

References $itemsarray.

Referenced by delete(), and getSortedItemsArray().

                                    : array
     {
         return $this->itemsarray;
     }

Here is the caller graph for this function:

◆ getNewItemsInLearningProgress()

ilObjMediaCast::getNewItemsInLearningProgress ( )

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

References $new_items_in_lp.

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

                                                    : bool
     {
         return $this->new_items_in_lp;
     }

Here is the caller graph for this function:

◆ getNumberInitialVideos()

ilObjMediaCast::getNumberInitialVideos ( )

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

References $nr_initial_videos.

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

                                             : int
     {
         return $this->nr_initial_videos;
     }

Here is the caller graph for this function:

◆ getOnline()

ilObjMediaCast::getOnline ( )

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

References $online.

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

                                : bool
     {
         return $this->online;
     }

Here is the caller graph for this function:

◆ getOrder()

ilObjMediaCast::getOrder ( )

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

References $order.

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

                               : int
     {
         return $this->order;
     }

Here is the caller graph for this function:

◆ getPlaytimeForSeconds()

ilObjMediaCast::getPlaytimeForSeconds ( int $seconds )

Get playtime for seconds.

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

References $duration.

Referenced by addMobToCast().

                                                        : string
     {
         $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 ( )

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

References $publicfiles.

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

                                     : bool
     {
         return $this->publicfiles;
     }

Here is the caller graph for this function:

◆ getSortedItemsArray()

ilObjMediaCast::getSortedItemsArray ( )

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

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

                                          : array
     {
         $med_items = $this->getItemsArray();
         // sort by order setting
         switch ($this->getOrder()) {
             case ilObjMediaCast::ORDER_TITLE:
                 $med_items = ilArrayUtil::sortArray($med_items, "title", "asc", false, true);
                 break;
 
             case ilObjMediaCast::ORDER_CREATION_DATE_ASC:
                 $med_items = ilArrayUtil::sortArray($med_items, "creation_date", "asc", false, true);
                 break;
 
             case ilObjMediaCast::ORDER_CREATION_DATE_DESC:
                 $med_items = ilArrayUtil::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 = ilArrayUtil::sortArray($med_items, "order", "asc", true, true);
                 break;
         }
         return $med_items;
     }

Here is the call graph for this function:

◆ getViewMode()

ilObjMediaCast::getViewMode ( )

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

References $view_mode.

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

                                  : string
     {
         return $this->view_mode;
     }

Here is the caller graph for this function:

◆ handleLPUpdate()

ilObjMediaCast::handleLPUpdate	(	int	$a_user_id,
		int	$a_mob_id
	)

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

References ilObject\getRefId().

      : void {
         $this->mob_tracking->saveCompletion(
             $a_mob_id,
             $this->getRefId(),
             $a_user_id
         );
     }

Here is the call graph for this function:

◆ read()

ilObjMediaCast::read ( )

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

References ilObject\$db, $ilDB, ilObject\getId(), readItems(), setAutoplayMode(), setComments(), setDefaultAccess(), setDownloadable(), setNewItemsInLearningProgress(), setNumberInitialVideos(), setOnline(), setOrder(), setPublicFiles(), and setViewMode().

                           : void
     {
         $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((bool) $rec["is_online"]);
         $this->setPublicFiles((bool) $rec["public_files"]);
         $this->setDownloadable((bool) $rec["downloadable"]);
         $this->setDefaultAccess((int) $rec["def_access"]);
         $this->setOrder((int) $rec["sortmode"]);
         $this->setViewMode((string) $rec["viewmode"]);
         $this->setAutoplayMode((int) $rec["autoplaymode"]);
         $this->setNumberInitialVideos((int) $rec["nr_initial_videos"]);
         $this->setNewItemsInLearningProgress((bool) $rec["new_items_in_lp"]);
 
         $this->setComments($this->notes->domain()->commentsActive($this->getId()));
     }

Here is the call graph for this function:

◆ readItems()

ilObjMediaCast::readItems ( bool $a_oldest_first = false )

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

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

Referenced by copyItems(), and read().

                                                            : array
     {
         //
         $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 369 of file class.ilObjMediaCast.php.

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

Referenced by copyOrder(), and getSortedItemsArray().

                                : ?array
     {
         $ilDB = $this->db;
 
         if (!$this->getId()) {
             return null;
         }
 
         $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 388 of file class.ilObjMediaCast.php.

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

Referenced by copyOrder().

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

Here is the caller graph for this function:

◆ setAutoplayMode()

ilObjMediaCast::setAutoplayMode ( int $a_val )

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

Referenced by read().

                                                : void
     {
         $this->autoplay_mode = $a_val;
     }

Here is the caller graph for this function:

◆ setComments()

ilObjMediaCast::setComments ( bool $comments )

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

References $comments.

Referenced by read().

                                                : void
     {
         $this->comments = $comments;
     }

Here is the caller graph for this function:

◆ setDefaultAccess()

ilObjMediaCast::setDefaultAccess ( int $value )

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

Referenced by __construct(), and read().

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

Here is the caller graph for this function:

◆ setDownloadable()

ilObjMediaCast::setDownloadable ( bool $a_downloadable )

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

Referenced by read().

                                                          : void
     {
         $this->downloadable = $a_downloadable;
     }

Here is the caller graph for this function:

◆ setItemsArray()

ilObjMediaCast::setItemsArray ( array $a_itemsarray )

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

                                                       : void
     {
         $this->itemsarray = $a_itemsarray;
     }

◆ setNewItemsInLearningProgress()

ilObjMediaCast::setNewItemsInLearningProgress ( bool $a_val )

Set new items automatically in lp.

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

Referenced by read().

                                                               : void
     {
         $this->new_items_in_lp = $a_val;
     }

Here is the caller graph for this function:

◆ setNumberInitialVideos()

ilObjMediaCast::setNumberInitialVideos ( int $a_val )

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

Referenced by read().

                                                       : void
     {
         $this->nr_initial_videos = $a_val;
     }

Here is the caller graph for this function:

◆ setOnline()

ilObjMediaCast::setOnline ( bool $a_online )

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

Referenced by read().

                                              : void
     {
         $this->online = $a_online;
     }

Here is the caller graph for this function:

◆ setOrder()

ilObjMediaCast::setOrder ( int $a_value )

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

Referenced by __construct(), and read().

                                           : void
     {
         $this->order = $a_value;
     }

Here is the caller graph for this function:

◆ setPublicFiles()

ilObjMediaCast::setPublicFiles ( bool $a_publicfiles )

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

Referenced by read().

                                                        : void
     {
         $this->publicfiles = $a_publicfiles;
     }

Here is the caller graph for this function:

◆ setViewMode()

ilObjMediaCast::setViewMode ( string $a_val )

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

Referenced by read().

                                               : void
     {
         $this->view_mode = $a_val;
     }

Here is the caller graph for this function:

◆ update()

ilObjMediaCast::update ( )

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

References ilObject\$db, $ilDB, getAutoplayMode(), getComments(), getDefaultAccess(), getDownloadable(), ilObject\getId(), getNewItemsInLearningProgress(), getNumberInitialVideos(), getOnline(), getOrder(), getPublicFiles(), getViewMode(), and ilObject\updateMetaData().

                             : bool
     {
         $ilDB = $this->db;
 
         if (!parent::update()) {
             return false;
         }
 
         $this->updateMetaData();
 
         // 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($this->getDefaultAccess(), "integer") .
             ", sortmode = " . $ilDB->quote($this->getOrder(), "integer") .
             ", viewmode = " . $ilDB->quote($this->getViewMode(), "text") .
             ", autoplaymode = " . $ilDB->quote($this->getAutoplayMode(), "integer") .
             ", nr_initial_videos = " . $ilDB->quote($this->getNumberInitialVideos(), "integer") .
             ", new_items_in_lp = " . $ilDB->quote($this->getNewItemsInLearningProgress(), "integer") .
             " WHERE id = " . $ilDB->quote($this->getId(), "integer");
 
         $ilDB->manipulate($query);
 
         $this->notes->domain()->activateComments($this->getId(), $this->getComments());
 
         return true;
     }

Here is the call graph for this function:

Field Documentation

◆ $autoplay_mode

int ilObjMediaCast::$autoplay_mode = self::AUTOPLAY_ACT

protected

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

Referenced by getAutoplayMode().

◆ $comments

bool ilObjMediaCast::$comments = false

protected

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

Referenced by getComments(), and setComments().

◆ $defaultAccess

int ilObjMediaCast::$defaultAccess = 0

protected

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

Referenced by getDefaultAccess().

◆ $domain

ILIAS MediaCast InternalDomainService ilObjMediaCast::$domain

protected

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

◆ $downloadable

bool ilObjMediaCast::$downloadable = true

protected

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

Referenced by getDownloadable().

◆ $itemsarray

array ilObjMediaCast::$itemsarray

protected

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

Referenced by getItemsArray(), and readItems().

◆ $mob_mapping

array ilObjMediaCast::$mob_mapping = []

protected

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

◆ $mob_tracking

ILIAS MediaObjects Tracking TrackingManager ilObjMediaCast::$mob_tracking

protected

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

◆ $new_items_in_lp

bool ilObjMediaCast::$new_items_in_lp = true

protected

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

Referenced by getNewItemsInLearningProgress().

◆ $notes

ILIAS Notes Service ilObjMediaCast::$notes

protected

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

◆ $nr_initial_videos

int ilObjMediaCast::$nr_initial_videos = 5

protected

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

Referenced by getNumberInitialVideos().

◆ $online

bool ilObjMediaCast::$online = false

protected

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

Referenced by getOnline().

◆ $order

int ilObjMediaCast::$order = 0

protected

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

Referenced by getOrder(), and getSortedItemsArray().

◆ $publicfiles

bool ilObjMediaCast::$publicfiles = false

protected

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

Referenced by getPublicFiles().

◆ $purposes

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

static

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

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

◆ $user

ilObjUser ilObjMediaCast::$user

protected

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

Referenced by copyItems().

◆ $view_mode

string ilObjMediaCast::$view_mode = self::VIEW_VCAST

protected

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

Referenced by getViewMode().

◆ AUTOPLAY_ACT

const ilObjMediaCast::AUTOPLAY_ACT = 1

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

Referenced by ILIAS\MetaData\Vocabularies\Dispatch\Presentation\Presentation\VideoViewGUI\getAutoplay(), and ILIAS\MetaData\OERHarvester\Settings\Settings\SettingsGUI\getEditForm().

◆ AUTOPLAY_INACT

const ilObjMediaCast::AUTOPLAY_INACT = 2

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

Referenced by ILIAS\MetaData\OERHarvester\Settings\Settings\SettingsGUI\getEditForm().

◆ AUTOPLAY_NO

const ilObjMediaCast::AUTOPLAY_NO = 0

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

Referenced by ILIAS\MetaData\Vocabularies\Dispatch\Presentation\Presentation\VideoViewGUI\getAutoplay(), ILIAS\MetaData\OERHarvester\Settings\Settings\SettingsGUI\getEditForm(), and ILIAS\MetaData\Vocabularies\Dispatch\Presentation\Presentation\VideoViewGUI\renderToolbar().

◆ ORDER_CREATION_DATE_ASC

const ilObjMediaCast::ORDER_CREATION_DATE_ASC = 2

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

Referenced by ilObjMediaCastGUI\editOrderObject(), ILIAS\MetaData\OERHarvester\Settings\Settings\SettingsGUI\getEditForm(), and getSortedItemsArray().

◆ ORDER_CREATION_DATE_DESC

const ilObjMediaCast::ORDER_CREATION_DATE_DESC = 3

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

Referenced by ilObjMediaCastGUI\editOrderObject(), ILIAS\MetaData\OERHarvester\Settings\Settings\SettingsGUI\getEditForm(), and getSortedItemsArray().

◆ ORDER_MANUAL

const ilObjMediaCast::ORDER_MANUAL = 4

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

Referenced by ilObjMediaCastGUI\addContentSubTabs(), ilObjMediaCastGUI\editOrderObject(), ILIAS\MetaData\OERHarvester\Settings\Settings\SettingsGUI\getEditForm(), and getSortedItemsArray().

◆ ORDER_TITLE

const ilObjMediaCast::ORDER_TITLE = 1

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

Referenced by ilObjMediaCastGUI\editOrderObject(), ILIAS\MetaData\OERHarvester\Settings\Settings\SettingsGUI\getEditForm(), and getSortedItemsArray().

◆ VIEW_GALLERY

const ilObjMediaCast::VIEW_GALLERY = "gallery"

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

Referenced by ilObjMediaCastGUI\showContentObject().

◆ VIEW_IMG_GALLERY

const ilObjMediaCast::VIEW_IMG_GALLERY = "img_gallery"

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

Referenced by ilMediaCastManageTableGUI\__construct(), ilObjMediaCastGUI\executeCommand(), ILIAS\MetaData\OERHarvester\Settings\Settings\SettingsGUI\getEditForm(), ilObjMediaCastGUI\initAddCastItemForm(), ilObjMediaCastGUI\listItemsObject(), ilObjMediaCastGUI\showContentObject(), and ilObjMediaCastGUI\updateCastItemObject().

◆ VIEW_LIST

const ilObjMediaCast::VIEW_LIST = ""

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

◆ VIEW_PODCAST

const ilObjMediaCast::VIEW_PODCAST = "podcast"

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

Referenced by ilMediaCastManageTableGUI\__construct(), ilObjMediaCastGUI\executeCommand(), ILIAS\MetaData\OERHarvester\Settings\Settings\SettingsGUI\getEditForm(), ilObjMediaCastGUI\listItemsObject(), and ilObjMediaCastGUI\showContentObject().

◆ VIEW_VCAST

const ilObjMediaCast::VIEW_VCAST = "video"

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

Referenced by ilObjMediaCastGUI\executeCommand(), ILIAS\MetaData\OERHarvester\Settings\Settings\SettingsGUI\getEditForm(), ilObjMediaCastGUI\listItemsObject(), and ilObjMediaCastGUI\showContentObject().

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

components/ILIAS/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()

◆ getAutoplayMode()

◆ getComments()

◆ getDefaultAccess()

◆ getDownloadable()

◆ getItemsArray()

◆ getNewItemsInLearningProgress()

◆ getNumberInitialVideos()

◆ getOnline()

◆ getOrder()

◆ getPlaytimeForSeconds()

◆ getPublicFiles()

◆ getSortedItemsArray()

◆ getViewMode()

◆ handleLPUpdate()

◆ read()

◆ readItems()

◆ readOrder()

◆ saveOrder()

◆ setAutoplayMode()

◆ setComments()

◆ setDefaultAccess()

◆ setDownloadable()

◆ setItemsArray()

◆ setNewItemsInLearningProgress()

◆ setNumberInitialVideos()

◆ setOnline()

◆ setOrder()

◆ setPublicFiles()

◆ setViewMode()

◆ update()

Field Documentation

◆ $autoplay_mode

◆ $comments

◆ $defaultAccess

◆ $domain

◆ $downloadable

◆ $itemsarray

◆ $mob_mapping

◆ $mob_tracking

◆ $new_items_in_lp

◆ $notes

◆ $nr_initial_videos

◆ $online

◆ $order

◆ $publicfiles

◆ $purposes

◆ $user

◆ $view_mode

◆ AUTOPLAY_ACT

◆ AUTOPLAY_INACT

◆ AUTOPLAY_NO

◆ ORDER_CREATION_DATE_ASC

◆ ORDER_CREATION_DATE_DESC

◆ ORDER_MANUAL

◆ ORDER_TITLE

◆ VIEW_GALLERY

◆ VIEW_IMG_GALLERY

◆ VIEW_LIST

◆ VIEW_PODCAST

◆ VIEW_VCAST