ILIAS  release_4-4 Revision
All Data Structures Namespaces Files Functions Variables Modules Pages
ilObjMediaCast Class Reference

Class ilObjMediaCast. More...

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

Public Member Functions

 ilObjMediaCast ($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...
 
 initDefaultRoles ()
 init default roles settings More...
 
 notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0)
 notifys an object about an event occured Based on the event happend, each object may decide how it reacts. More...
 
 readItems ($a_oldest_first=false)
 Get all items of media cast. More...
 
 deleteOrder ()
 
 readOrder ()
 
 saveOrder (array $a_items)
 
 cloneObject ($a_target_id, $a_copy_id=0)
 Clone media cast. More...
 
 copyItems ($a_new_obj)
 Copy items. More...
 
- Public Member Functions inherited from ilObject
 ilObject ($a_id=0, $a_reference=true)
 Constructor public. More...
 
 withReferences ()
 determines wehter objects are referenced or not (got ref ids or not) More...
 
 read ($a_force_db=false)
 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...
 
 getOwner ()
 get object owner More...
 
 getOwnerName ()
 
 _lookupOwnerName ($a_owner_id)
 lookup owner name for owner id More...
 
 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...
 
 setObjDataRecord ($a_record)
 set object_data record (note: this method should only be called from the ilObjectFactory class) 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...
 
 _getIdForImportId ($a_import_id)
 get current object id for import id (static) More...
 
 _lookupOwner ($a_id)
 lookup object owner More...
 
 _lookupLastUpdate ($a_id, $a_as_string=false)
 lookup last update More...
 
 _getLastUpdateOfObjects ($a_objs)
 Get last update for a set of media objects. More...
 
 _setDeletedDate ($a_ref_id)
 only called in ilTree::saveSubTree More...
 
 _resetDeletedDate ($a_ref_id)
 only called in ilObjectGUI::insertSavedNodes More...
 
 _lookupDeletedDate ($a_ref_id)
 only called in ilObjectGUI::insertSavedNodes More...
 
 _writeTitle ($a_obj_id, $a_title)
 write title to db (static) More...
 
 _writeDescription ($a_obj_id, $a_desc)
 write description to db (static) More...
 
 _writeImportId ($a_obj_id, $a_import_id)
 write import id to db (static) More...
 
 _isInTrash ($a_ref_id)
 checks wether object is in trash More...
 
 _hasUntrashedReference ($a_obj_id)
 checks wether an object has at least one reference that is not in trash More...
 
 _getObjectsDataForType ($a_type, $a_omit_trash=false)
 get all objects of a certain type More...
 
 putInTree ($a_parent_ref)
 maybe this method should be in tree object!? More...
 
 setPermissions ($a_parent_ref)
 set permissions of object 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...
 
 createRoleFolder ()
 creates a local role folder More...
 
 applyDidacticTemplate ($a_tpl_id)
 Apply template. More...
 
 notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0)
 notifys an object about an event occured Based on the event passed, each object may decide how it reacts. More...
 
 setRegisterMode ($a_bool)
 
 isUserRegistered ($a_user_id=0)
 
 requireRegistration ()
 
 getXMLZip ()
 
 getHTMLDirectory ()
 
 cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)
 Clone object permissions, put in tree ... More...
 
 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...
 
 _lookupCreationDate ($a_id)
 Lookup creation date. 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
 
 $ilias
 
 $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
 
 $obj_data_record
 object_data record More...
 

Static Public Attributes

static $purposes = array ("Standard", "VideoAlternative", "VideoPortable", "AudioPortable")
 

Protected Attributes

 $online = false
 
 $publicfiles = false
 
 $downloadable = true
 
 $order
 
 $view_mode = ""
 
 $defaultAccess = 0
 

Additional Inherited Members

- Static Public Member Functions inherited from ilObject
static _lookupObjIdByImportId ($a_import_id)
 
static _getAllReferences ($a_id)
 get all reference ids of object More...
 
static _lookupTitle ($a_id)
 lookup object title More...
 
static _getIdsForTitle ($title, $type='', $partialmatch=false)
 
static _lookupDescription ($a_id)
 lookup object description More...
 
static _lookupObjId ($a_id)
 
static setDeletedDates ($a_ref_ids)
 Set deleted date type $ilDB. More...
 
static _lookupType ($a_id, $a_reference=false)
 lookup object type More...
 
static _lookupObjectId ($a_ref_id)
 lookup object id 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 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.

Member Function Documentation

◆ cloneObject()

ilObjMediaCast::cloneObject (   $a_target_id,
  $a_copy_id = 0 
)

Clone media cast.

Parameters
inttarget ref_id
intcopy id

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

References ilObject\$ilias, $ilUser, copyItems(), getDefaultAccess(), getDownloadable(), getOrder(), getPublicFiles(), and ilObject\getTitle().

542  {
543  global $ilDB, $ilUser, $ilias;
544 
545  $new_obj = parent::cloneObject($a_target_id,$a_copy_id);
546 
547  $new_obj->setTitle($this->getTitle());
548  $new_obj->setPublicFiles($this->getPublicFiles());
549  $new_obj->setDownloadable($this->getDownloadable());
550  $new_obj->setDefaultAccess($this->getDefaultAccess());
551  $new_obj->setOrder($this->getOrder());
552  $new_obj->update();
553 
554  // copy items
555  $this->copyItems($new_obj);
556 
557  // copy order!?
558 
559  return $new_obj;
560  }
getDefaultAccess()
return default access for news items
getTitle()
get object title public
getDownloadable()
Get Downloadable.
global $ilUser
Definition: imgupload.php:15
getPublicFiles()
Get PublicFiles.
copyItems($a_new_obj)
Copy items.
+ Here is the call graph for this function:

◆ copyItems()

ilObjMediaCast::copyItems (   $a_new_obj)

Copy items.

Parameters

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

References $ilUser, NEWS_AUDIO, and readItems().

Referenced by cloneObject().

569  {
570  global $ilUser;
571 
572  include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
573  foreach($this->readItems(true) as $item)
574  {
575  // copy media object
576  $mob_id = $item["mob_id"];
577  $mob = new ilObjMediaObject($mob_id);
578  $new_mob = $mob->duplicate();
579 
580  // copy news item
581  // create new media cast item
582  include_once("./Services/News/classes/class.ilNewsItem.php");
583  $mc_item = new ilNewsItem();
584  $mc_item->setMobId($new_mob->getId());
585  $mc_item->setContentType(NEWS_AUDIO);
586  $mc_item->setContextObjId($a_new_obj->getId());
587  $mc_item->setContextObjType($a_new_obj->getType());
588  $mc_item->setUserId($ilUser->getId());
589  $mc_item->setPlaytime($item["playtime"]);
590  $mc_item->setTitle($item["title"]);
591  $mc_item->setContent($item["content"]);
592  $mc_item->setVisibility($item["visibility"]);
593  $mc_item->create();
594 
595  }
596  }
Class ilObjMediaObject.
global $ilUser
Definition: imgupload.php:15
readItems($a_oldest_first=false)
Get all items of media cast.
const NEWS_AUDIO
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ create()

ilObjMediaCast::create ( )

Create mew media cast.

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

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

253  {
254  global $ilDB;
255 
256  parent::create();
257 
258  $query = "INSERT INTO il_media_cast_data (".
259  " id".
260  ", is_online".
261  ", public_files".
262  ", downloadable".
263  ", def_access".
264  ", sortmode".
265  ", viewmode".
266  " ) VALUES (".
267  $ilDB->quote($this->getId(), "integer")
268  .",".$ilDB->quote((int) $this->getOnline(), "integer")
269  .",".$ilDB->quote((int) $this->getPublicFiles(), "integer")
270  .",".$ilDB->quote((int) $this->getDownloadable(), "integer")
271  .",".$ilDB->quote((int) $this->getDefaultAccess(), "integer")
272  .",".$ilDB->quote((int) $this->getOrder(), "integer")
273  .",".$ilDB->quote((int) $this->getViewMode(), "text")
274  .")";
275  $ilDB->manipulate($query);
276 
277  }
getDefaultAccess()
return default access for news items
getOnline()
Get Online.
getId()
get object id public
getViewMode()
Get view mode.
getDownloadable()
Get Downloadable.
getPublicFiles()
Get PublicFiles.
+ 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 340 of file class.ilObjMediaCast.php.

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

341  {
342  global $ilDB;
343 
344  // always call parent delete function first!!
345  if (!parent::delete())
346  {
347  return false;
348  }
349 
350  // delete all items
351  $med_items = $this->getItemsArray();
352  foreach ($med_items as $item)
353  {
354  include_once("./Services/News/classes/class.ilNewsItem.php");
355  $news_item = new ilNewsItem($item["id"]);
356  $news_item->delete();
357  }
358 
359  $this->deleteOrder();
360 
361  // delete record of table il_media_cast_data
362  $query = "DELETE FROM il_media_cast_data".
363  " WHERE id = ".$ilDB->quote($this->getId(), "integer");
364  $ilDB->manipulate($query);
365 
366  return true;
367  }
getId()
get object id public
getItemsArray()
Get ItemsArray.
+ Here is the call graph for this function:

◆ deleteOrder()

ilObjMediaCast::deleteOrder ( )

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

References ilObject\getId().

Referenced by delete(), and saveOrder().

477  {
478  global $ilDB;
479 
480  if(!$this->getId())
481  {
482  return;
483  }
484 
485  $sql = "DELETE FROM il_media_cast_data_ord".
486  " WHERE obj_id = ".$ilDB->quote($this->getId(), "integer");
487  $ilDB->manipulate($sql);
488  }
getId()
get object id public
+ 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 205 of file class.ilObjMediaCast.php.

References $defaultAccess.

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

205  {
206  return $this->defaultAccess;
207  }
+ 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 243 of file class.ilObjMediaCast.php.

References ilObjMediaCastAccess\_lookupDiskUsage().

244  {
245  require_once("./Modules/MediaCast/classes/class.ilObjMediaCastAccess.php");
246  return ilObjMediaCastAccess::_lookupDiskUsage($this->id);
247  }
_lookupDiskUsage($a_id)
Returns the number of bytes used on the harddisk by the file object with the specified object id...
+ Here is the call graph for this function:

◆ getDownloadable()

ilObjMediaCast::getDownloadable ( )

Get Downloadable.

Returns
boolean Downloadable

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

References $downloadable.

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

196  {
197  return $this->downloadable;
198  }
+ Here is the caller graph for this function:

◆ getItemsArray()

ilObjMediaCast::getItemsArray ( )

Get ItemsArray.

Returns
array ItemsArray

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

Referenced by delete(), and getSortedItemsArray().

128  {
129  return $this->itemsarray;
130  }
+ Here is the caller graph for this function:

◆ getOnline()

ilObjMediaCast::getOnline ( )

Get Online.

Returns
boolean Online

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

References $online.

Referenced by create(), and update().

69  {
70  return $this->online;
71  }
+ Here is the caller graph for this function:

◆ getOrder()

ilObjMediaCast::getOrder ( )

Get order.

Returns
boolean

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

References $order.

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

233  {
234  return $this->order;
235  }
+ Here is the caller graph for this function:

◆ getPublicFiles()

ilObjMediaCast::getPublicFiles ( )

Get PublicFiles.

Returns
boolean PublicFiles

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

References $publicfiles.

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

89  {
90  return $this->publicfiles;
91  }
+ Here is the caller graph for this function:

◆ getSortedItemsArray()

ilObjMediaCast::getSortedItemsArray ( )

Get sorted items array.

Parameters

Definition at line 138 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().

139  {
140  $med_items = $this->getItemsArray();
141 
142  // sort by order setting
143  switch($this->getOrder())
144  {
146  $med_items = ilUtil::sortArray($med_items, "title", "asc", false, true);
147  break;
148 
150  $med_items = ilUtil::sortArray($med_items, "creation_date", "asc", false, true);
151  break;
152 
154  $med_items = ilUtil::sortArray($med_items, "creation_date", "desc", false, true);
155  break;
156 
158  $order = array_flip($this->readOrder());
159  $pos = sizeof($order);
160  foreach(array_keys($med_items) as $idx)
161  {
162  if(array_key_exists($idx, $order))
163  {
164  $med_items[$idx]["order"] = ($order[$idx]+1)*10;
165  }
166  // item has no order yet
167  else
168  {
169  $med_items[$idx]["order"] = (++$pos)*10;
170  }
171  }
172 
173  $med_items = ilUtil::sortArray($med_items, "order", "asc", true, true);
174  break;
175  }
176 
177  return $med_items;
178  }
static sortArray($array, $a_array_sortby, $a_array_sortorder=0, $a_numeric=false, $a_keep_keys=false)
sortArray
getItemsArray()
Get ItemsArray.
+ Here is the call graph for this function:

◆ getViewMode()

ilObjMediaCast::getViewMode ( )

Get view mode.

Returns
string view mode

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

References $view_mode.

Referenced by create(), and update().

109  {
110  return $this->view_mode;
111  }
+ Here is the caller graph for this function:

◆ ilObjMediaCast()

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

Constructor public.

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

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

References ilObject\ilObject(), setDefaultAccess(), and setOrder().

45  {
46  $this->type = "mcst";
47  $this->ilObject($a_id,$a_call_by_reference);
48  $mcst_set = new ilSetting("mcst");
49  $this->setDefaultAccess($mcst_set->get("defaultaccess") == "users" ? 0 : 1);
50  $this->setOrder(self::ORDER_CREATION_DATE_DESC);
51  }
ILIAS Setting Class.
setOrder($a_value)
Set order.
ilObject($a_id=0, $a_reference=true)
Constructor public.
setDefaultAccess($value)
set default access: 0 logged in users, 1 for public access
+ Here is the call graph for this function:

◆ initDefaultRoles()

ilObjMediaCast::initDefaultRoles ( )

init default roles settings

If your module does not require any default roles, delete this method (For an example how this method is used, look at ilObjForum)

public

Returns
array object IDs of created local roles.

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

379  {
380  global $rbacadmin;
381 
382  // create a local role folder
383  //$rfoldObj = $this->createRoleFolder("Local roles","Role Folder of forum obj_no.".$this->getId());
384 
385  // create moderator role and assign role to rolefolder...
386  //$roleObj = $rfoldObj->createRole("Moderator","Moderator of forum obj_no.".$this->getId());
387  //$roles[] = $roleObj->getId();
388 
389  //unset($rfoldObj);
390  //unset($roleObj);
391 
392  return $roles ? $roles : array();
393  }

◆ notify()

ilObjMediaCast::notify (   $a_event,
  $a_ref_id,
  $a_parent_non_rbac_id,
  $a_node_id,
  $a_params = 0 
)

notifys an object about an event occured Based on the event happend, each object may decide how it reacts.

If you are not required to handle any events related to your module, just delete this method. (For an example how this method is used, look at ilObjGroup)

public

Parameters
stringevent
integerreference id of object where the event occured
arraypasses optional parameters if required
Returns
boolean

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

References $_GET, and ilObject\getType().

409  {
410  global $tree;
411 
412  switch ($a_event)
413  {
414  case "link":
415 
416  //var_dump("<pre>",$a_params,"</pre>");
417  //echo "Module name ".$this->getRefId()." triggered by link event. Objects linked into target object ref_id: ".$a_ref_id;
418  //exit;
419  break;
420 
421  case "cut":
422 
423  //echo "Module name ".$this->getRefId()." triggered by cut event. Objects are removed from target object ref_id: ".$a_ref_id;
424  //exit;
425  break;
426 
427  case "copy":
428 
429  //var_dump("<pre>",$a_params,"</pre>");
430  //echo "Module name ".$this->getRefId()." triggered by copy event. Objects are copied into target object ref_id: ".$a_ref_id;
431  //exit;
432  break;
433 
434  case "paste":
435 
436  //echo "Module name ".$this->getRefId()." triggered by paste (cut) event. Objects are pasted into target object ref_id: ".$a_ref_id;
437  //exit;
438  break;
439 
440  case "new":
441 
442  //echo "Module name ".$this->getRefId()." triggered by paste (new) event. Objects are applied to target object ref_id: ".$a_ref_id;
443  //exit;
444  break;
445  }
446 
447  // At the beginning of the recursive process it avoids second call of the notify function with the same parameter
448  if ($a_node_id==$_GET["ref_id"])
449  {
450  $parent_obj =& $this->ilias->obj_factory->getInstanceByRefId($a_node_id);
451  $parent_type = $parent_obj->getType();
452  if($parent_type == $this->getType())
453  {
454  $a_node_id = (int) $tree->getParentId($a_node_id);
455  }
456  }
457 
458  parent::notify($a_event,$a_ref_id,$a_parent_non_rbac_id,$a_node_id,$a_params);
459  }
$_GET["client_id"]
redirection script todo: (a better solution should control the processing via a xml file) ...
getType()
get object type public
+ Here is the call graph for this function:

◆ read()

ilObjMediaCast::read ( )

Read media cast.

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

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

313  {
314  global $ilDB;
315 
316  parent::read();
317  $this->readItems();
318 
319  $query = "SELECT * FROM il_media_cast_data WHERE id = ".
320  $ilDB->quote($this->getId(), "integer");
321  $set = $ilDB->query($query);
322  $rec = $ilDB->fetchAssoc($set);
323 
324  $this->setOnline($rec["is_online"]);
325  $this->setPublicFiles($rec["public_files"]);
326  $this->setDownloadable($rec["downloadable"]);
327  $this->setDefaultAccess($rec["def_access"]);
328  $this->setOrder($rec["sortmode"]);
329  $this->setViewMode($rec["viewmode"]);
330 
331  }
setOrder($a_value)
Set order.
getId()
get object id public
setDownloadable($a_downloadable)
Set Downloadable.
setOnline($a_online)
Set Online.
setViewMode($a_val)
Set view mode.
setDefaultAccess($value)
set default access: 0 logged in users, 1 for public access
readItems($a_oldest_first=false)
Get all items of media cast.
setPublicFiles($a_publicfiles)
Set PublicFiles.
+ Here is the call graph for this function:

◆ readItems()

ilObjMediaCast::readItems (   $a_oldest_first = false)

Get all items of media cast.

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

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

Referenced by copyItems(), and read().

465  {
466  //
467  include_once("./Services/News/classes/class.ilNewsItem.php");
468  $it = new ilNewsItem();
469  $it->setContextObjId($this->getId());
470  $it->setContextObjType($this->getType());
471  $this->itemsarray = $it->queryNewsForContext(false, 0, "", false, $a_oldest_first);
472 
473  return $this->itemsarray;
474  }
getId()
get object id public
getType()
get object type public
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ readOrder()

ilObjMediaCast::readOrder ( )

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

References $res, $row, and ilObject\getId().

Referenced by getSortedItemsArray().

491  {
492  global $ilDB;
493 
494  if(!$this->getId())
495  {
496  return;
497  }
498 
499  $all = array();
500  $sql = "SELECT item_id FROM il_media_cast_data_ord".
501  " WHERE obj_id = ".$ilDB->quote($this->getId(), "integer").
502  " ORDER BY pos";
503  $res = $ilDB->query($sql);
504  while($row = $ilDB->fetchAssoc($res))
505  {
506  $all[] = $row["item_id"];
507  }
508  return $all;
509  }
getId()
get object id public
+ 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 511 of file class.ilObjMediaCast.php.

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

512  {
513  global $ilDB;
514 
515  if(!$this->getId())
516  {
517  return;
518  }
519 
520  $this->deleteOrder();
521 
522  $pos = 0;
523  foreach($a_items as $item_id)
524  {
525  $pos++;
526 
527  $sql = "INSERT INTO il_media_cast_data_ord (obj_id,item_id,pos)".
528  " VALUES (".$ilDB->quote($this->getId(), "integer").",".
529  $ilDB->quote($item_id, "integer").",".
530  $ilDB->quote($pos, "integer").")";
531  $ilDB->manipulate($sql);
532  }
533  }
getId()
get object id public
+ 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 214 of file class.ilObjMediaCast.php.

Referenced by ilObjMediaCast(), and read().

214  {
215  $this->defaultAccess = (int) $value == 0 ? 0 : 1;
216  }
+ Here is the caller graph for this function:

◆ setDownloadable()

ilObjMediaCast::setDownloadable (   $a_downloadable)

Set Downloadable.

Parameters
boolean$a_downloadableDownloadable

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

Referenced by read().

187  {
188  $this->downloadable = $a_downloadable;
189  }
+ Here is the caller graph for this function:

◆ setItemsArray()

ilObjMediaCast::setItemsArray (   $a_itemsarray)

Set ItemsArray.

Parameters
array$a_itemsarrayItemsArray

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

118  {
119  $this->itemsarray = $a_itemsarray;
120  }

◆ setOnline()

ilObjMediaCast::setOnline (   $a_online)

Set Online.

Parameters
boolean$a_onlineOnline

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

Referenced by read().

59  {
60  $this->online = $a_online;
61  }
+ Here is the caller graph for this function:

◆ setOrder()

ilObjMediaCast::setOrder (   $a_value)

Set order.

Parameters
boolean$a_value

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

Referenced by ilObjMediaCast(), and read().

224  {
225  $this->order = $a_value;
226  }
+ Here is the caller graph for this function:

◆ setPublicFiles()

ilObjMediaCast::setPublicFiles (   $a_publicfiles)

Set PublicFiles.

Parameters
boolean$a_publicfilesPublicFiles

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

Referenced by read().

79  {
80  $this->publicfiles = $a_publicfiles;
81  }
+ Here is the caller graph for this function:

◆ setViewMode()

ilObjMediaCast::setViewMode (   $a_val)

Set view mode.

Parameters
string$a_valview mode

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

Referenced by read().

99  {
100  $this->view_mode = $a_val;
101  }
+ Here is the caller graph for this function:

◆ update()

ilObjMediaCast::update ( )

update object data

public

Returns
boolean

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

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

286  {
287  global $ilDB;
288 
289  if (!parent::update())
290  {
291  return false;
292  }
293 
294  // update media cast data
295  $query = "UPDATE il_media_cast_data SET ".
296  " is_online = ".$ilDB->quote((int) $this->getOnline(), "integer").
297  ", public_files = ".$ilDB->quote((int) $this->getPublicFiles(), "integer").
298  ", downloadable = ".$ilDB->quote((int) $this->getDownloadable(), "integer").
299  ", def_access = ".$ilDB->quote((int) $this->getDefaultAccess(), "integer").
300  ", sortmode = ".$ilDB->quote((int) $this->getOrder(), "integer").
301  ", viewmode = ".$ilDB->quote($this->getViewMode(), "text").
302  " WHERE id = ".$ilDB->quote((int) $this->getId(), "integer");
303 
304  $ilDB->manipulate($query);
305 
306  return true;
307  }
getDefaultAccess()
return default access for news items
getOnline()
Get Online.
getId()
get object id public
getViewMode()
Get view mode.
getDownloadable()
Get Downloadable.
getPublicFiles()
Get PublicFiles.
+ Here is the call graph for this function:

Field Documentation

◆ $defaultAccess

ilObjMediaCast::$defaultAccess = 0
protected

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

Referenced by getDefaultAccess().

◆ $downloadable

ilObjMediaCast::$downloadable = true
protected

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

Referenced by getDownloadable().

◆ $online

ilObjMediaCast::$online = false
protected

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

Referenced by getOnline().

◆ $order

ilObjMediaCast::$order
protected

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

Referenced by getOrder(), and getSortedItemsArray().

◆ $publicfiles

ilObjMediaCast::$publicfiles = false
protected

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

Referenced by getPublicFiles().

◆ $purposes

◆ $view_mode

ilObjMediaCast::$view_mode = ""
protected

Definition at line 21 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 28 of file class.ilObjMediaCast.php.

Referenced by ilObjMediaCastGUI\initSettingsForm().


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