ILIAS  release_7 Revision v7.30-3-g800a261c036
ilObjMediaCast Class Reference

Class ilObjMediaCast. More...

+ Inheritance diagram for ilObjMediaCast:
+ Collaboration diagram for ilObjMediaCast:

Public Member Functions

 __construct ($a_id=0, $a_call_by_reference=true)
 Constructor @access 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 @access 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 @access public More...
 
 setId ($a_id)
 set object id @access public More...
 
 setRefId ($a_id)
 set reference id @access public More...
 
 getRefId ()
 get reference id @access public More...
 
 getType ()
 get object type @access public More...
 
 setType ($a_type)
 set object type @access public More...
 
 getPresentationTitle ()
 get presentation title Normally same as title Overwritten for sessions More...
 
 getTitle ()
 get object title @access public More...
 
 getUntranslatedTitle ()
 get untranslated object title @access 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 @access public More...
 
 getLastUpdateDate ()
 get last update date @access 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) @access 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@access public 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 @access public.

Parameters
integerreference_id or object_id
booleantreat the id as reference_id (true) or object_id (false)

Reimplemented from ilObject.

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

54 {
55 global $DIC;
56
57 $this->db = $DIC->database();
58 $this->user = $DIC->user();
59 $this->type = "mcst";
60 parent::__construct($a_id, $a_call_by_reference);
61 $mcst_set = new ilSetting("mcst");
62 $this->setDefaultAccess($mcst_set->get("defaultaccess") == "users" ? 0 : 1);
63 $this->setOrder(self::ORDER_CREATION_DATE_DESC);
64 }
user()
Definition: user.php:4
setDefaultAccess($value)
set default access: 0 logged in users, 1 for public access
setOrder($a_value)
Set order.
ILIAS Setting Class.
global $DIC
Definition: goto.php:24
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc

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

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

570 {
571 $mob = new ilObjMediaObject($mob_id);
572 $news_set = new ilSetting("news");
573 $enable_internal_rss = $news_set->get("enable_rss_for_internal");
574
575 // create new media cast item
576 $mc_item = new ilNewsItem();
577 $mc_item->setMobId($mob->getId());
578 $mc_item->setContentType(NEWS_AUDIO);
579 $mc_item->setContextObjId($this->getId());
580 $mc_item->setContextObjType($this->getType());
581 $mc_item->setUserId($user_id);
582 $med_item = $mob->getMediaItem("Standard");
583 $mc_item->setPlaytime($this->getPlaytimeForSeconds($med_item->getDuration()));
584 $mc_item->setTitle($mob->getTitle());
585 $mc_item->setContent($mob->getLongDescription());
586 if ($long_desc != "") {
587 $mc_item->setContent($long_desc);
588 }
589 $mc_item->setLimitation(false);
590 // @todo handle visibility
591 $mc_item->create();
592
593 $lp = ilObjectLP::getInstance($this->getId());
594
595 // see ilLPListOfSettingsGUI assign
596 $collection = $lp->getCollectionInstance();
597 if ($collection && $collection->hasSelectableItems()) {
598 /* not yet...
599 $collection->activateEntries([$mob_id]);
600 $lp->resetCaches();
601 ilLPStatusWrapper::_refreshStatus($this->getId());
602 */
603 }
604 return $mc_item->getId();
605 }
const NEWS_AUDIO
getPlaytimeForSeconds(int $seconds)
Get playtime for seconds.
Class ilObjMediaObject.
static getInstance($a_obj_id)
getType()
get object type @access public
getId()
get object id @access public

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

+ Here is the call graph for this function:

◆ copyItems()

ilObjMediaCast::copyItems (   $a_new_obj)

Copy items.

Parameters

return

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

516 {
518
519 $item_mapping = [];
520 include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
521 foreach ($this->readItems(true) as $item) {
522 // copy media object
523 $mob_id = $item["mob_id"];
524 $mob = new ilObjMediaObject($mob_id);
525 $new_mob = $mob->duplicate();
526
527 // copy news item
528 // create new media cast item
529 include_once("./Services/News/classes/class.ilNewsItem.php");
530 $mc_item = new ilNewsItem();
531 $mc_item->setMobId($new_mob->getId());
532 $mc_item->setContentType(NEWS_AUDIO);
533 $mc_item->setContextObjId($a_new_obj->getId());
534 $mc_item->setContextObjType($a_new_obj->getType());
535 $mc_item->setUserId($ilUser->getId());
536 $mc_item->setPlaytime($item["playtime"]);
537 $mc_item->setTitle($item["title"]);
538 $mc_item->setContent($item["content"]);
539 $mc_item->setVisibility($item["visibility"]);
540 $mc_item->create();
541 $this->mob_mapping[$mob_id] = $new_mob->getId();
542 $item_mapping[$item["id"]] = $mc_item->getId();
543 }
544 return $item_mapping;
545 }
readItems($a_oldest_first=false)
Get all items of media cast.
$ilUser
Definition: imgupload.php:18

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

+ Here is the call graph for this function:

◆ copyOrder()

ilObjMediaCast::copyOrder (   $newObj,
  $mapping 
)
protected

Copy order.

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

448 {
449 $items = [];
450 foreach ($this->readOrder() as $i) {
451 $items[] = $mapping[$i];
452 }
453 $newObj->saveOrder($items);
454 }
$i
Definition: metadata.php:24

References $i, and readOrder().

+ Here is the call graph for this function:

◆ create()

ilObjMediaCast::create ( )

Create mew media cast.

Reimplemented from ilObject.

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

264 {
266
267 parent::create();
268
269 $query = "INSERT INTO il_media_cast_data (" .
270 " id" .
271 ", is_online" .
272 ", public_files" .
273 ", downloadable" .
274 ", def_access" .
275 ", sortmode" .
276 ", viewmode" .
277 " ) VALUES (" .
278 $ilDB->quote($this->getId(), "integer")
279 . "," . $ilDB->quote((int) $this->getOnline(), "integer")
280 . "," . $ilDB->quote((int) $this->getPublicFiles(), "integer")
281 . "," . $ilDB->quote((int) $this->getDownloadable(), "integer")
282 . "," . $ilDB->quote((int) $this->getDefaultAccess(), "integer")
283 . "," . $ilDB->quote((int) $this->getOrder(), "integer")
284 . "," . $ilDB->quote((int) $this->getViewMode(), "text")
285 . ")";
286 $ilDB->manipulate($query);
287 }
getPublicFiles()
Get PublicFiles.
getOnline()
Get Online.
getDefaultAccess()
return default access for news items
getDownloadable()
Get Downloadable.
getViewMode()
Get view mode.
$query
global $ilDB

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

+ Here is the call graph for this function:

◆ delete()

ilObjMediaCast::delete ( )

delete object and all related data

@access public

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

Reimplemented from ilObject.

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

349 {
351
352 // always call parent delete function first!!
353 if (!parent::delete()) {
354 return false;
355 }
356
357 // delete all items
358 $med_items = $this->getItemsArray();
359 foreach ($med_items as $item) {
360 include_once("./Services/News/classes/class.ilNewsItem.php");
361 $news_item = new ilNewsItem($item["id"]);
362 $news_item->delete();
363 }
364
365 $this->deleteOrder();
366
367 // delete record of table il_media_cast_data
368 $query = "DELETE FROM il_media_cast_data" .
369 " WHERE id = " . $ilDB->quote($this->getId(), "integer");
370 $ilDB->manipulate($query);
371
372 return true;
373 }
getItemsArray()
Get ItemsArray.

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

+ Here is the call graph for this function:

◆ deleteOrder()

ilObjMediaCast::deleteOrder ( )

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

391 {
393
394 if (!$this->getId()) {
395 return;
396 }
397
398 $sql = "DELETE FROM il_media_cast_data_ord" .
399 " WHERE obj_id = " . $ilDB->quote($this->getId(), "integer");
400 $ilDB->manipulate($sql);
401 }

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

Referenced by delete(), and saveOrder().

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

215 {
217 }

References $defaultAccess.

Referenced by create(), and update().

+ Here is the caller graph for this function:

◆ getDiskUsage()

ilObjMediaCast::getDiskUsage ( )

Gets the disk usage of the object in bytes.

@access public

Returns
integer the disk usage in bytes

Reimplemented from ilObject.

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

255 {
256 require_once("./Modules/MediaCast/classes/class.ilObjMediaCastAccess.php");
258 }
static _lookupDiskUsage($a_id)
Returns the number of bytes used on the harddisk by the file object with the specified object id.

References ilObjMediaCastAccess\_lookupDiskUsage().

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

205 {
206 return $this->downloadable;
207 }

References $downloadable.

Referenced by create(), and update().

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

141 {
142 return $this->itemsarray;
143 }

Referenced by delete(), and getSortedItemsArray().

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

82 {
83 return $this->online;
84 }

References $online.

Referenced by create(), and update().

+ Here is the caller graph for this function:

◆ getOrder()

ilObjMediaCast::getOrder ( )

Get order.

Returns
boolean

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

244 {
245 return $this->order;
246 }

References $order.

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

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

613 {
614 $hours = floor($seconds / 3600);
615 $minutes = floor(($seconds % 3600) / 60);
616 $seconds = $seconds % 60;
617 $duration = str_pad($hours, 2, "0", STR_PAD_LEFT) . ":" .
618 str_pad($minutes, 2, "0", STR_PAD_LEFT) . ":" .
619 str_pad($seconds, 2, "0", STR_PAD_LEFT);
620 return $duration;
621 }

Referenced by addMobToCast().

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

102 {
103 return $this->publicfiles;
104 }

References $publicfiles.

Referenced by create(), and update().

+ Here is the caller graph for this function:

◆ getSortedItemsArray()

ilObjMediaCast::getSortedItemsArray ( )

Get sorted items array.

Parameters

return

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

152 {
153 $med_items = $this->getItemsArray();
154
155 // sort by order setting
156 switch ($this->getOrder()) {
158 $med_items = ilUtil::sortArray($med_items, "title", "asc", false, true);
159 break;
160
162 $med_items = ilUtil::sortArray($med_items, "creation_date", "asc", false, true);
163 break;
164
166 $med_items = ilUtil::sortArray($med_items, "creation_date", "desc", false, true);
167 break;
168
170 $order = array_flip($this->readOrder());
171 $pos = sizeof($order);
172 foreach (array_keys($med_items) as $idx) {
173 if (array_key_exists($idx, $order)) {
174 $med_items[$idx]["order"] = ($order[$idx] + 1) * 10;
175 }
176 // item has no order yet
177 else {
178 $med_items[$idx]["order"] = (++$pos) * 10;
179 }
180 }
181
182 $med_items = ilUtil::sortArray($med_items, "order", "asc", true, true);
183 break;
184 }
185
186 return $med_items;
187 }
static sortArray( $array, $a_array_sortby, $a_array_sortorder=0, $a_numeric=false, $a_keep_keys=false)
sortArray

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

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

122 {
123 return $this->view_mode;
124 }

References $view_mode.

Referenced by create(), and update().

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

548 {
549 // using read events to persist mob status
550 require_once 'Services/Tracking/classes/class.ilChangeEvent.php';
552 "mob",
553 $this->getRefId(),
554 $a_mob_id,
555 $a_user_id
556 );
557
558 // trigger LP update
559 require_once 'Services/Tracking/classes/class.ilLPStatusWrapper.php';
560 ilLPStatusWrapper::_updateStatus($this->getId(), $a_user_id);
561 }
static _recordReadEvent( $a_type, $a_ref_id, $obj_id, $usr_id, $isCatchupWriteEvents=true, $a_ext_rc=false, $a_ext_time=false)
Records a read event and catches up with write events.
static _updateStatus($a_obj_id, $a_usr_id, $a_obj=null, $a_percentage=false, $a_force_raise=false)
Update status.
getRefId()
get reference id @access public

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

+ Here is the call graph for this function:

◆ read()

ilObjMediaCast::read ( )

Read media cast.

Reimplemented from ilObject.

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

322 {
324
325 parent::read();
326 $this->readItems();
327
328 $query = "SELECT * FROM il_media_cast_data WHERE id = " .
329 $ilDB->quote($this->getId(), "integer");
330 $set = $ilDB->query($query);
331 $rec = $ilDB->fetchAssoc($set);
332
333 $this->setOnline($rec["is_online"]);
334 $this->setPublicFiles($rec["public_files"]);
335 $this->setDownloadable($rec["downloadable"]);
336 $this->setDefaultAccess($rec["def_access"]);
337 $this->setOrder($rec["sortmode"]);
338 $this->setViewMode($rec["viewmode"]);
339 }
setDownloadable($a_downloadable)
Set Downloadable.
setOnline($a_online)
Set Online.
setViewMode($a_val)
Set view mode.
setPublicFiles($a_publicfiles)
Set PublicFiles.

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

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

379 {
380 //
381 include_once("./Services/News/classes/class.ilNewsItem.php");
382 $it = new ilNewsItem();
383 $it->setContextObjId($this->getId());
384 $it->setContextObjType($this->getType());
385 $this->itemsarray = $it->queryNewsForContext(false, 0, "", false, $a_oldest_first);
386
387 return $this->itemsarray;
388 }

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

Referenced by copyItems(), and read().

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

404 {
406
407 if (!$this->getId()) {
408 return;
409 }
410
411 $all = array();
412 $sql = "SELECT item_id FROM il_media_cast_data_ord" .
413 " WHERE obj_id = " . $ilDB->quote($this->getId(), "integer") .
414 " ORDER BY pos";
415 $res = $ilDB->query($sql);
416 while ($row = $ilDB->fetchAssoc($res)) {
417 $all[] = $row["item_id"];
418 }
419 return $all;
420 }
foreach($_POST as $key=> $value) $res

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

Referenced by copyOrder(), and getSortedItemsArray().

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

423 {
425
426 if (!$this->getId()) {
427 return;
428 }
429
430 $this->deleteOrder();
431
432 $pos = 0;
433 foreach ($a_items as $item_id) {
434 $pos++;
435
436 $sql = "INSERT INTO il_media_cast_data_ord (obj_id,item_id,pos)" .
437 " VALUES (" . $ilDB->quote($this->getId(), "integer") . "," .
438 $ilDB->quote($item_id, "integer") . "," .
439 $ilDB->quote($pos, "integer") . ")";
440 $ilDB->manipulate($sql);
441 }
442 }

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

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

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

Referenced by __construct(), and read().

+ Here is the caller graph for this function:

◆ setDownloadable()

ilObjMediaCast::setDownloadable (   $a_downloadable)

Set Downloadable.

Parameters
boolean$a_downloadableDownloadable

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

196 {
197 $this->downloadable = $a_downloadable;
198 }

Referenced by read().

+ Here is the caller graph for this function:

◆ setItemsArray()

ilObjMediaCast::setItemsArray (   $a_itemsarray)

Set ItemsArray.

Parameters
array$a_itemsarrayItemsArray

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

131 {
132 $this->itemsarray = $a_itemsarray;
133 }

◆ setOnline()

ilObjMediaCast::setOnline (   $a_online)

Set Online.

Parameters
boolean$a_onlineOnline

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

72 {
73 $this->online = $a_online;
74 }

Referenced by read().

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

235 {
236 $this->order = $a_value;
237 }

Referenced by __construct(), and read().

+ Here is the caller graph for this function:

◆ setPublicFiles()

ilObjMediaCast::setPublicFiles (   $a_publicfiles)

Set PublicFiles.

Parameters
boolean$a_publicfilesPublicFiles

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

92 {
93 $this->publicfiles = $a_publicfiles;
94 }

Referenced by read().

+ Here is the caller graph for this function:

◆ setViewMode()

ilObjMediaCast::setViewMode (   $a_val)

Set view mode.

Parameters
string$a_valview mode

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

112 {
113 $this->view_mode = $a_val;
114 }

Referenced by read().

+ Here is the caller graph for this function:

◆ update()

ilObjMediaCast::update ( )

update object data

@access public

Returns
boolean

Reimplemented from ilObject.

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

296 {
298
299 if (!parent::update()) {
300 return false;
301 }
302
303 // update media cast data
304 $query = "UPDATE il_media_cast_data SET " .
305 " is_online = " . $ilDB->quote((int) $this->getOnline(), "integer") .
306 ", public_files = " . $ilDB->quote((int) $this->getPublicFiles(), "integer") .
307 ", downloadable = " . $ilDB->quote((int) $this->getDownloadable(), "integer") .
308 ", def_access = " . $ilDB->quote((int) $this->getDefaultAccess(), "integer") .
309 ", sortmode = " . $ilDB->quote((int) $this->getOrder(), "integer") .
310 ", viewmode = " . $ilDB->quote($this->getViewMode(), "text") .
311 " WHERE id = " . $ilDB->quote((int) $this->getId(), "integer");
312
313 $ilDB->manipulate($query);
314
315 return true;
316 }

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

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

◆ $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

◆ $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

◆ ORDER_CREATION_DATE_DESC

const ilObjMediaCast::ORDER_CREATION_DATE_DESC = 3

◆ ORDER_MANUAL

◆ ORDER_TITLE

const ilObjMediaCast::ORDER_TITLE = 1

◆ VIEW_GALLERY

const ilObjMediaCast::VIEW_GALLERY = "gallery"

◆ 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: