|
ILIAS
release_8 Revision v8.24
|
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...
Collaboration diagram for ilMediaItem:Public Member Functions | |
| __construct (int $a_id=0) | |
| setId (int $a_id) | |
| set media item id More... | |
| getId () | |
| setMobId (int $a_mob_id) | |
| set id of parent media object More... | |
| getMobId () | |
| setNr (int $a_nr) | |
| set number of media item within media object More... | |
| getNr () | |
| setDuration (int $a_val) | |
| getDuration () | |
| setTextRepresentation (string $a_val) | |
| getTextRepresentation () | |
| setUploadHash (string $a_val) | |
| getUploadHash () | |
| create () | |
| update () | |
| writeParameter (string $a_name, string $a_value) | |
| read () | |
| read media item data (item id or (mob_id and nr) must be set) More... | |
| writeThumbTried (string $a_tried) | |
| write thumbnail creation try data ("y"/"n") More... | |
| setPurpose (string $a_purpose) | |
| getPurpose () | |
| setLocation (string $a_location) | |
| getLocation () | |
| setLocationType (string $a_type) | |
| getLocationType () | |
| setFormat (string $a_format) | |
| getFormat () | |
| setThumbTried (string $a_tried) | |
| getThumbTried () | |
| addMapArea (ilMapArea $a_map_area) | |
| deleteMapArea (int $nr) | |
| getMapArea (int $nr) | |
| getMapAreas () | |
| getWidth () | |
| setWidth (string $a_width) | |
| getHeight () | |
| setHeight (string $a_height) | |
| getOriginalSize () | |
| setCaption (string $a_caption) | |
| getCaption () | |
| setHAlign (string $a_halign) | |
| set horizontal align More... | |
| getHAlign () | |
| setParameter (string $a_name, string $a_value) | |
| resetParameters () | |
| setParameters (string $a_par) | |
| set all parameters via parameter string (format: par1="value1", par2="value2", ...) More... | |
| getParameters () | |
| getParameterString () | |
| getParameter (string $a_name) | |
| getWorkDirectory () | |
| get work directory for image map editing More... | |
| createWorkDirectory () | |
| create work directory for image map editing More... | |
| getSuffix () | |
| get location suffix More... | |
| getMapWorkCopyType () | |
| get image type of image map work copy More... | |
| getMapWorkCopyName (bool $a_reference_copy=false) | |
| Get name of image map work copy file. More... | |
| getDirectory () | |
| get media file directory More... | |
| getThumbnailDirectory (string $a_mode="filesystem") | |
| get media file directory More... | |
| getThumbnailTarget (string $a_size="") | |
| get thumbnail target More... | |
| copyOriginal () | |
| Copy the original file for map editing to the working directory. More... | |
| makeMapWorkCopy (int $a_area_nr=0, bool $a_exclude=false) | |
| make map work copy of image More... | |
| addAreaToMapWorkCopy (string $a_shape, string $a_coords) | |
| draw a new area in work image More... | |
| outputMapWorkCopy () | |
| output raw map work copy file More... | |
| buildMapWorkImage () | |
| build image map work image More... | |
| saveMapWorkImage () | |
| save image map work image as file More... | |
| getMapWorkImage () | |
| getMapAreasXML (bool $a_insert_inst=false, int $a_inst=0) | |
| get xml code of media items' areas More... | |
| extractUrlParameters () | |
| Extract parameters of special external references to parameter array. More... | |
| determineDuration () | |
Static Public Member Functions | |
| static | _lookupLocationForMobId (int $a_mob_id, string $a_purpose) |
| static | _lookupMobId (int $a_med_id) |
| static | _getMediaItemsOfMObId (int $a_mobId, string $a_purpose) |
| read media item with specific purpose and mobId More... | |
| static | _getMediaItemsOfMOb (ilObjMediaObject $a_mob) |
| Read media items into(!) media object (static) More... | |
| static | deleteAllItemsOfMob (int $a_mob_id) |
| static | checkParameter (string $a_par, string $a_val) |
| Check parameter (filter javascript related and other unsafe parameters/values) More... | |
| static | _resolveMapAreaLinks (int $a_mob_id) |
| resolve internal links of all media items of a media object More... | |
| static | _getMapAreasIntLinks (int $a_mob_id) |
| get all internal links of map areas of a mob More... | |
| static | getMediaItemsForUploadHash (string $a_hash) |
| Get media items for upload hash. More... | |
Data Fields | |
| int | $id = 0 |
| string | $purpose = "" |
| string | $location = "" |
| string | $location_type = "" |
| string | $format = "" |
| string | $width = "" |
| string | $height = "" |
| string | $caption = "" |
| string | $halign = "" |
| array | $parameters = [] |
| int | $mob_id = 0 |
| int | $nr = 0 |
| array | $mapareas = [] |
| int | $map_cnt = 0 |
| $map_image = null | |
| int | $color1 |
| int | $color2 |
Protected Attributes | |
| string | $tried_thumb = "" |
| string | $text_representation = "" |
| ilDBInterface | $db |
| ilLanguage | $lng |
| int | $duration = 0 |
| string | $upload_hash = '' |
Static Private Member Functions | |
| static | getGDSupportedImageType (string $a_desired_type) |
| returns the best supported image type by this PHP build More... | |
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 ilMediaItem Media Item, component of a media object (file or reference)
Definition at line 24 of file class.ilMediaItem.php.
| ilMediaItem::__construct | ( | int | $a_id = 0 | ) |
Definition at line 54 of file class.ilMediaItem.php.
References $DIC, ILIAS\Repository\lng(), read(), and setId().
Here is the call graph for this function:
|
static |
get all internal links of map areas of a mob
| int | $a_mob_id | media object id |
Definition at line 1148 of file class.ilMediaItem.php.
Referenced by ilPageObjectGUI\displayMedia(), ilPageObject\getInternalLinks(), ilLMPresentationGUI\ilMedia(), and ilGlossaryPresentationGUI\media().
Here is the caller graph for this function:
|
static |
Read media items into(!) media object (static)
Definition at line 431 of file class.ilMediaItem.php.
References $i, $ilDB, $query, ilMapArea\_getMaxNr(), and ilObjMediaObject\addMediaItem().
Referenced by ilObjMediaObject\read().
Here is the call graph for this function:
Here is the caller graph for this function:
|
static |
read media item with specific purpose and mobId
| int | $a_mobId | |
| string | $a_purpose |
Definition at line 408 of file class.ilMediaItem.php.
Referenced by ilObjectFeedWriter\__construct().
Here is the caller graph for this function:
|
static |
Definition at line 364 of file class.ilMediaItem.php.
|
static |
Definition at line 384 of file class.ilMediaItem.php.
|
static |
resolve internal links of all media items of a media object
| int | $a_mob_id | media object id |
Definition at line 1126 of file class.ilMediaItem.php.
References ilMapArea\_resolveIntLinks().
Referenced by ilQuestionPageParser\processPagesToParse(), and ilPageObject\resolveIntLinks().
Here is the call graph for this function:
Here is the caller graph for this function:| ilMediaItem::addAreaToMapWorkCopy | ( | string | $a_shape, |
| string | $a_coords | ||
| ) |
draw a new area in work image
| string | $a_shape | shape |
| string | $a_coords | coordinates string |
Definition at line 958 of file class.ilMediaItem.php.
| ilMediaItem::addMapArea | ( | ilMapArea | $a_map_area | ) |
Definition at line 559 of file class.ilMediaItem.php.
| ilMediaItem::buildMapWorkImage | ( | ) |
build image map work image
Definition at line 1008 of file class.ilMediaItem.php.
|
static |
Check parameter (filter javascript related and other unsafe parameters/values)
Definition at line 683 of file class.ilMediaItem.php.
Referenced by ilMediaAliasItem\setParameters().
Here is the caller graph for this function:| ilMediaItem::copyOriginal | ( | ) |
Copy the original file for map editing to the working directory.
| ilMapEditingException |
Definition at line 863 of file class.ilMediaItem.php.
References $lng, and ilShellUtil\convertImage().
Here is the call graph for this function:| ilMediaItem::create | ( | ) |
Definition at line 196 of file class.ilMediaItem.php.
References $db, $i, $ilDB, $name, $params, $query, getCaption(), getDuration(), getFormat(), getHAlign(), getHeight(), getId(), getLocation(), getLocationType(), getMobId(), getNr(), getParameters(), getPurpose(), getTextRepresentation(), getUploadHash(), getWidth(), and setId().
Here is the call graph for this function:| ilMediaItem::createWorkDirectory | ( | ) |
create work directory for image map editing
Definition at line 736 of file class.ilMediaItem.php.
References ilFileUtils\createDirectory(), and ilFileUtils\getDataDir().
Here is the call graph for this function:
|
static |
Definition at line 481 of file class.ilMediaItem.php.
References $DIC, $ilDB, and $query.
Referenced by ilObjMediaObject\delete(), and ilObjMediaObject\update().
Here is the caller graph for this function:| ilMediaItem::deleteMapArea | ( | int | $nr | ) |
Definition at line 565 of file class.ilMediaItem.php.
References $i.
| ilMediaItem::determineDuration | ( | ) |
Definition at line 1184 of file class.ilMediaItem.php.
References Vendor\Package\$e, ilObjMediaObject\_getDirectory(), ilExternalMediaAnalyzer\extractVimeoParameters(), ilExternalMediaAnalyzer\getVimeoMetadata(), ilFileUtils\ilTempnam(), ilExternalMediaAnalyzer\isVimeo(), and ilFileUtils\makeDir().
Referenced by ilObjMediaCastGUI\getDuration().
Here is the call graph for this function:
Here is the caller graph for this function:| ilMediaItem::extractUrlParameters | ( | ) |
Extract parameters of special external references to parameter array.
Definition at line 1173 of file class.ilMediaItem.php.
References ilExternalMediaAnalyzer\extractUrlParameters().
Here is the call graph for this function:| ilMediaItem::getCaption | ( | ) |
Definition at line 634 of file class.ilMediaItem.php.
Referenced by create(), and update().
Here is the caller graph for this function:| ilMediaItem::getDirectory | ( | ) |
get media file directory
Definition at line 788 of file class.ilMediaItem.php.
References ilObjMediaObject\_getDirectory().
Here is the call graph for this function:| ilMediaItem::getDuration | ( | ) |
Definition at line 171 of file class.ilMediaItem.php.
References $duration.
Referenced by create(), ilObjMediaCastGUI\getDuration(), and update().
Here is the caller graph for this function:| ilMediaItem::getFormat | ( | ) |
Definition at line 544 of file class.ilMediaItem.php.
References $format.
Referenced by create(), and update().
Here is the caller graph for this function:
|
staticprivate |
returns the best supported image type by this PHP build
| string | $a_desired_type |
Definition at line 117 of file class.ilMediaItem.php.
| ilMediaItem::getHAlign | ( | ) |
Definition at line 647 of file class.ilMediaItem.php.
Referenced by create(), and update().
Here is the caller graph for this function:| ilMediaItem::getHeight | ( | ) |
Definition at line 599 of file class.ilMediaItem.php.
Referenced by create(), and update().
Here is the caller graph for this function:| ilMediaItem::getId | ( | ) |
Definition at line 79 of file class.ilMediaItem.php.
References $id.
Referenced by create(), and update().
Here is the caller graph for this function:| ilMediaItem::getLocation | ( | ) |
Definition at line 524 of file class.ilMediaItem.php.
References $location.
Referenced by create(), and update().
Here is the caller graph for this function:| ilMediaItem::getLocationType | ( | ) |
Definition at line 534 of file class.ilMediaItem.php.
Referenced by create(), and update().
Here is the caller graph for this function:| ilMediaItem::getMapArea | ( | int | $nr | ) |
Definition at line 579 of file class.ilMediaItem.php.
| ilMediaItem::getMapAreas | ( | ) |
Definition at line 584 of file class.ilMediaItem.php.
| ilMediaItem::getMapAreasXML | ( | bool | $a_insert_inst = false, |
| int | $a_inst = 0 |
||
| ) |
get xml code of media items' areas
Definition at line 1074 of file class.ilMediaItem.php.
| ilMediaItem::getMapWorkCopyName | ( | bool | $a_reference_copy = false | ) |
Get name of image map work copy file.
| bool | $a_reference_copy | get name for copy of external referenced image |
Definition at line 769 of file class.ilMediaItem.php.
| ilMediaItem::getMapWorkCopyType | ( | ) |
get image type of image map work copy
Definition at line 760 of file class.ilMediaItem.php.
| ilMediaItem::getMapWorkImage | ( | ) |
|
static |
Get media items for upload hash.
| string | $a_hash | upload hash |
Definition at line 1235 of file class.ilMediaItem.php.
Referenced by ilObjMediaPoolGUI\editTitlesAndDescriptions(), ilMediaCreationGUI\editTitlesAndDescriptions(), ilObjMediaPoolGUI\saveTitlesAndDescriptions(), and ilMediaCreationGUI\saveTitlesAndDescriptions().
Here is the caller graph for this function:| ilMediaItem::getMobId | ( | ) |
Definition at line 92 of file class.ilMediaItem.php.
References $mob_id.
Referenced by create(), and update().
Here is the caller graph for this function:| ilMediaItem::getNr | ( | ) |
| ilMediaItem::getOriginalSize | ( | ) |
Definition at line 609 of file class.ilMediaItem.php.
References ilObjMediaObject\_getDirectory(), ilUtil\deducibleSize(), and ilMediaImageUtil\getImageSize().
Here is the call graph for this function:| ilMediaItem::getParameter | ( | string | $a_name | ) |
Definition at line 720 of file class.ilMediaItem.php.
| ilMediaItem::getParameters | ( | ) |
Definition at line 703 of file class.ilMediaItem.php.
Referenced by create(), and update().
Here is the caller graph for this function:| ilMediaItem::getParameterString | ( | ) |
Definition at line 708 of file class.ilMediaItem.php.
References $target_arr.
| ilMediaItem::getPurpose | ( | ) |
Definition at line 514 of file class.ilMediaItem.php.
Referenced by create(), and update().
Here is the caller graph for this function:| ilMediaItem::getSuffix | ( | ) |
get location suffix
Definition at line 750 of file class.ilMediaItem.php.
| ilMediaItem::getTextRepresentation | ( | ) |
Definition at line 181 of file class.ilMediaItem.php.
References $text_representation.
Referenced by create(), and update().
Here is the caller graph for this function:| ilMediaItem::getThumbnailDirectory | ( | string | $a_mode = "filesystem" | ) |
get media file directory
Definition at line 796 of file class.ilMediaItem.php.
| ilMediaItem::getThumbnailTarget | ( | string | $a_size = "" | ) |
get thumbnail target
Definition at line 805 of file class.ilMediaItem.php.
References $format.
| ilMediaItem::getThumbTried | ( | ) |
Definition at line 554 of file class.ilMediaItem.php.
| ilMediaItem::getUploadHash | ( | ) |
Definition at line 191 of file class.ilMediaItem.php.
References $upload_hash.
Referenced by create(), and update().
Here is the caller graph for this function:| ilMediaItem::getWidth | ( | ) |
Definition at line 589 of file class.ilMediaItem.php.
Referenced by create(), and update().
Here is the caller graph for this function:| ilMediaItem::getWorkDirectory | ( | ) |
get work directory for image map editing
Definition at line 728 of file class.ilMediaItem.php.
References ilFileUtils\getDataDir(), and ILIAS\Survey\Mode\getId().
Here is the call graph for this function:| ilMediaItem::makeMapWorkCopy | ( | int | $a_area_nr = 0, |
| bool | $a_exclude = false |
||
| ) |
make map work copy of image
| int | $a_area_nr | draw area $a_area_nr only |
| bool | $a_exclude | true: draw all areas but area $a_area_nr |
Definition at line 912 of file class.ilMediaItem.php.
| ilMediaItem::outputMapWorkCopy | ( | ) |
output raw map work copy file
Definition at line 994 of file class.ilMediaItem.php.
References exit.
| ilMediaItem::read | ( | ) |
read media item data (item id or (mob_id and nr) must be set)
Definition at line 297 of file class.ilMediaItem.php.
References $i, $ilDB, $query, ilMapArea\_getMaxNr(), and ILIAS\Survey\Mode\getId().
Referenced by __construct().
Here is the call graph for this function:
Here is the caller graph for this function:| ilMediaItem::resetParameters | ( | ) |
Definition at line 661 of file class.ilMediaItem.php.
| ilMediaItem::saveMapWorkImage | ( | ) |
save image map work image as file
Definition at line 1040 of file class.ilMediaItem.php.
| ilMediaItem::setCaption | ( | string | $a_caption | ) |
Definition at line 629 of file class.ilMediaItem.php.
| ilMediaItem::setDuration | ( | int | $a_val | ) |
Definition at line 166 of file class.ilMediaItem.php.
| ilMediaItem::setFormat | ( | string | $a_format | ) |
Definition at line 539 of file class.ilMediaItem.php.
| ilMediaItem::setHAlign | ( | string | $a_halign | ) |
set horizontal align
Definition at line 642 of file class.ilMediaItem.php.
| ilMediaItem::setHeight | ( | string | $a_height | ) |
Definition at line 604 of file class.ilMediaItem.php.
| ilMediaItem::setId | ( | int | $a_id | ) |
set media item id
Definition at line 74 of file class.ilMediaItem.php.
Referenced by __construct(), and create().
Here is the caller graph for this function:| ilMediaItem::setLocation | ( | string | $a_location | ) |
Definition at line 519 of file class.ilMediaItem.php.
| ilMediaItem::setLocationType | ( | string | $a_type | ) |
Definition at line 529 of file class.ilMediaItem.php.
| ilMediaItem::setMobId | ( | int | $a_mob_id | ) |
set id of parent media object
Definition at line 87 of file class.ilMediaItem.php.
| ilMediaItem::setNr | ( | int | $a_nr | ) |
set number of media item within media object
Definition at line 100 of file class.ilMediaItem.php.
| ilMediaItem::setParameter | ( | string | $a_name, |
| string | $a_value | ||
| ) |
Definition at line 652 of file class.ilMediaItem.php.
| ilMediaItem::setParameters | ( | string | $a_par | ) |
set all parameters via parameter string (format: par1="value1", par2="value2", ...)
Definition at line 669 of file class.ilMediaItem.php.
References ilUtil\extractParameterString().
Here is the call graph for this function:| ilMediaItem::setPurpose | ( | string | $a_purpose | ) |
Definition at line 509 of file class.ilMediaItem.php.
| ilMediaItem::setTextRepresentation | ( | string | $a_val | ) |
Definition at line 176 of file class.ilMediaItem.php.
| ilMediaItem::setThumbTried | ( | string | $a_tried | ) |
Definition at line 549 of file class.ilMediaItem.php.
| ilMediaItem::setUploadHash | ( | string | $a_val | ) |
Definition at line 186 of file class.ilMediaItem.php.
| ilMediaItem::setWidth | ( | string | $a_width | ) |
Definition at line 594 of file class.ilMediaItem.php.
| ilMediaItem::update | ( | ) |
Definition at line 244 of file class.ilMediaItem.php.
References $db, $ilDB, $name, $params, $query, getCaption(), getDuration(), getFormat(), getHAlign(), getHeight(), getId(), getLocation(), getLocationType(), getMobId(), getNr(), getParameters(), getPurpose(), getTextRepresentation(), getUploadHash(), and getWidth().
Here is the call graph for this function:| ilMediaItem::writeParameter | ( | string | $a_name, |
| string | $a_value | ||
| ) |
Definition at line 281 of file class.ilMediaItem.php.
| ilMediaItem::writeThumbTried | ( | string | $a_tried | ) |
write thumbnail creation try data ("y"/"n")
Definition at line 353 of file class.ilMediaItem.php.
References $ilDB, and ILIAS\Survey\Mode\getId().
Here is the call graph for this function:| string ilMediaItem::$caption = "" |
Definition at line 38 of file class.ilMediaItem.php.
| int ilMediaItem::$color1 |
Definition at line 49 of file class.ilMediaItem.php.
| int ilMediaItem::$color2 |
Definition at line 50 of file class.ilMediaItem.php.
|
protected |
Definition at line 28 of file class.ilMediaItem.php.
|
protected |
Definition at line 51 of file class.ilMediaItem.php.
Referenced by getDuration().
| string ilMediaItem::$format = "" |
Definition at line 35 of file class.ilMediaItem.php.
| string ilMediaItem::$halign = "" |
Definition at line 39 of file class.ilMediaItem.php.
| string ilMediaItem::$height = "" |
Definition at line 37 of file class.ilMediaItem.php.
| int ilMediaItem::$id = 0 |
Definition at line 31 of file class.ilMediaItem.php.
Referenced by getId().
|
protected |
Definition at line 29 of file class.ilMediaItem.php.
| string ilMediaItem::$location = "" |
Definition at line 33 of file class.ilMediaItem.php.
| string ilMediaItem::$location_type = "" |
Definition at line 34 of file class.ilMediaItem.php.
| int ilMediaItem::$map_cnt = 0 |
Definition at line 44 of file class.ilMediaItem.php.
| ilMediaItem::$map_image = null |
Definition at line 48 of file class.ilMediaItem.php.
| array ilMediaItem::$mapareas = [] |
Definition at line 43 of file class.ilMediaItem.php.
| int ilMediaItem::$mob_id = 0 |
Definition at line 41 of file class.ilMediaItem.php.
Referenced by getMobId().
| int ilMediaItem::$nr = 0 |
Definition at line 42 of file class.ilMediaItem.php.
Referenced by getNr().
| array ilMediaItem::$parameters = [] |
Definition at line 40 of file class.ilMediaItem.php.
| string ilMediaItem::$purpose = "" |
Definition at line 32 of file class.ilMediaItem.php.
|
protected |
Definition at line 27 of file class.ilMediaItem.php.
Referenced by getTextRepresentation().
|
protected |
Definition at line 26 of file class.ilMediaItem.php.
|
protected |
Definition at line 52 of file class.ilMediaItem.php.
Referenced by getUploadHash().
| string ilMediaItem::$width = "" |
Definition at line 36 of file class.ilMediaItem.php.