ILIAS
Release_3_10_x_branch Revision 61812
|
Class ilObjStyleSheet. More...
Public Member Functions | |
ilObjStyleSheet ($a_id=0, $a_call_by_reference=false) | |
Constructor public. | |
setRefId () | |
getRefId () | |
get reference id public | |
putInTree () | |
createReference () | |
creates reference for object | |
setUpToDate ($a_up_to_date=true) | |
getUpToDate () | |
setScope ($a_scope) | |
getScope () | |
_writeUpToDate ($a_id, $a_up_to_date) | |
_lookupUpToDate ($a_id) | |
_writeStandard ($a_id, $a_std) | |
write standard flag | |
_writeScope ($a_id, $a_scope) | |
write standard flag | |
_lookupStandard ($a_id) | |
lookup standard flag | |
_writeActive ($a_id, $a_active) | |
write active flag | |
_lookupActive ($a_id) | |
lookup active flag | |
_getStandardStyles ($a_exclude_default_style=false, $a_include_deactivated=false, $a_scope=0) | |
get standard styles | |
_getClonableContentStyles () | |
get all clonable styles (active standard styles and individual learning module styles with write permission) | |
assignMetaData (&$a_meta_data) | |
assign meta data object | |
& | getMetaData () |
get meta data object | |
create ($a_from_style=0) | |
ilClone () | |
clone style sheet (note: styles have no ref ids and return an object id) | |
addParameter ($a_tag, $a_par) | |
write style parameter to db | |
deleteParameter ($a_id) | |
delete style parameter | |
deleteStylePar ($a_tag, $a_class, $a_par) | |
delete style parameter by tag/class/parameter | |
delete () | |
delete style object | |
read () | |
read style properties | |
writeCSSFile ($a_target_file="") | |
write css file to webspace directory | |
getContentStylePath ($a_style_id) | |
get content style path | |
getContentPrintStyle () | |
get content print style | |
getSyntaxStylePath () | |
get syntax style path | |
update () | |
update object in db | |
updateStyleParameter ($a_id, $a_value) | |
update style parameter per id | |
replaceStylePar ($a_tag, $a_class, $a_par, $a_val) | |
update style parameter per tag/class/parameter | |
getStyle () | |
todo: bad style! should return array of objects, not multi-dim-arrays | |
setStyle ($a_style) | |
set styles | |
getXML () | |
get xml representation of style object | |
exportXML ($a_dir) | |
export style xml file to directory | |
createFromXMLFile ($a_file) | |
create style from xml file | |
getAvailableTags () | |
get all available tags in an array | |
getAvailableParameters () | |
Public Member Functions inherited from ilObject | |
ilObject ($a_id=0, $a_reference=true) | |
Constructor public. | |
withReferences () | |
determines wehter objects are referenced or not (got ref ids or not) | |
read ($a_force_db=false) | |
read object data from db into object | |
getId () | |
get object id public | |
setId ($a_id) | |
set object id public | |
setRefId ($a_id) | |
set reference id public | |
getType () | |
get object type public | |
setType ($a_type) | |
set object type public | |
getPresentationTitle () | |
get presentation title Normally same as title Overwritten for sessions | |
getTitle () | |
get object title public | |
getUntranslatedTitle () | |
get untranslated object title public | |
setTitle ($a_title) | |
set object title | |
getDescription () | |
get object description | |
setDescription ($a_desc) | |
set object description | |
getLongDescription () | |
get object long description (stored in object_description) | |
getImportId () | |
get import id | |
setImportId ($a_import_id) | |
set import id | |
_lookupObjIdByImportId ($a_import_id) | |
getOwner () | |
get object owner | |
getOwnerName () | |
_lookupOwnerName ($a_owner_id) | |
lookup owner name for owner id | |
setOwner ($a_owner) | |
set object owner | |
getCreateDate () | |
get create date public | |
getLastUpdateDate () | |
get last update date public | |
setObjDataRecord ($a_record) | |
set object_data record (note: this method should only be called from the ilObjectFactory class) | |
create () | |
create | |
MDUpdateListener ($a_element) | |
Meta data update listener. | |
createMetaData () | |
create meta data entry | |
updateMetaData () | |
update meta data entry | |
deleteMetaData () | |
delete meta data entry | |
updateOwner () | |
update owner of object in db | |
_getIdForImportId ($a_import_id) | |
get current object id for import id (static) | |
_getAllReferences ($a_id) | |
get all reference ids of object | |
_lookupTitle ($a_id) | |
lookup object title | |
_lookupDescription ($a_id) | |
lookup object description | |
_lookupLastUpdate ($a_id, $a_as_string=false) | |
lookup last update | |
_getLastUpdateOfObjects ($a_objs) | |
Get last update for a set of media objects. | |
_lookupObjId ($a_id) | |
_setDeletedDate ($a_ref_id) | |
only called in ilTree::saveSubTree | |
_resetDeletedDate ($a_ref_id) | |
only called in ilObjectGUI::insertSavedNodes | |
_writeTitle ($a_obj_id, $a_title) | |
write title to db (static) | |
_writeDescription ($a_obj_id, $a_desc) | |
write description to db (static) | |
_writeImportId ($a_obj_id, $a_import_id) | |
write import id to db (static) | |
_lookupType ($a_id, $a_reference=false) | |
lookup object type | |
_isInTrash ($a_ref_id) | |
checks wether object is in trash | |
_hasUntrashedReference ($a_obj_id) | |
checks wether an object has at least one reference that is not in trash | |
_lookupObjectId ($a_ref_id) | |
lookup object id | |
_getObjectsDataForType ($a_type, $a_omit_trash=false) | |
get all objects of a certain type | |
putInTree ($a_parent_ref) | |
maybe this method should be in tree object!? | |
setPermissions ($a_parent_ref) | |
set permissions of object | |
countReferences () | |
count references of object | |
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 | |
createRoleFolder () | |
creates a local role folder | |
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. | |
setRegisterMode ($a_bool) | |
isUserRegistered ($a_user_id=0) | |
requireRegistration () | |
getXMLZip () | |
getHTMLDirectory () | |
cloneObject ($a_target_id, $a_copy_id=0) | |
Clone object permissions, put in tree ... | |
appendCopyInfo ($a_target_id, $a_copy_id) | |
Prepend Copy info if object with same name exists in that container. | |
cloneDependencies ($a_target_id, $a_copy_id) | |
Clone object dependencies. | |
cloneMetaData ($target_obj) | |
Copy meta data. |
Data Fields | |
$style | |
Data Fields inherited from ilObject | |
$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 |
Additional Inherited Members | |
Static Public Member Functions inherited from ilObject | |
static | _getIdsForTitle ($title, $type= '') |
_exists ($a_id, $a_reference=false) | |
checks if an object exists in object_data | |
static | _getObjectsByType ($a_obj_type="") |
Get objects by type. | |
static | _prepareCloneSelection ($a_ref_ids, $new_type) |
Prepare copy wizard object selection. | |
static | _getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false) |
Class ilObjStyleSheet.
Definition at line 35 of file class.ilObjStyleSheet.php.
ilObjStyleSheet::_getClonableContentStyles | ( | ) |
get all clonable styles (active standard styles and individual learning module styles with write permission)
Definition at line 239 of file class.ilObjStyleSheet.php.
References ilObject\$id, ilObject\$ref_id, ilObject\_getAllReferences(), ilObjContentObject\_lookupContObjIdByStyleId(), and DB_FETCHMODE_ASSOC.
Referenced by ilObjStyleSheetGUI\createObject().
ilObjStyleSheet::_getStandardStyles | ( | $a_exclude_default_style = false , |
|
$a_include_deactivated = false , |
|||
$a_scope = 0 |
|||
) |
get standard styles
Definition at line 192 of file class.ilObjStyleSheet.php.
References ilObject\$ilias, $res, ilObject\_lookupTitle(), and DB_FETCHMODE_ASSOC.
Referenced by ilObjContentObjectGUI\properties().
ilObjStyleSheet::_lookupActive | ( | $a_id | ) |
lookup active flag
Definition at line 177 of file class.ilObjStyleSheet.php.
References $res, and DB_FETCHMODE_ASSOC.
Referenced by ilObjStyleSettingsGUI\editContentStylesObject().
ilObjStyleSheet::_lookupStandard | ( | $a_id | ) |
lookup standard flag
Definition at line 150 of file class.ilObjStyleSheet.php.
References $res, and DB_FETCHMODE_ASSOC.
Referenced by ilObjContentObjectGUI\properties(), and ilObjContentObjectGUI\saveProperties().
ilObjStyleSheet::_lookupUpToDate | ( | $a_id | ) |
Definition at line 111 of file class.ilObjStyleSheet.php.
References $res, and DB_FETCHMODE_ASSOC.
Referenced by getContentStylePath().
ilObjStyleSheet::_writeActive | ( | $a_id, | |
$a_active | |||
) |
write active flag
Definition at line 165 of file class.ilObjStyleSheet.php.
Referenced by ilObjStyleSettingsGUI\saveActiveStylesObject().
ilObjStyleSheet::_writeScope | ( | $a_id, | |
$a_scope | |||
) |
write standard flag
Definition at line 138 of file class.ilObjStyleSheet.php.
Referenced by ilObjStyleSettingsGUI\saveScopeObject().
ilObjStyleSheet::_writeStandard | ( | $a_id, | |
$a_std | |||
) |
write standard flag
Definition at line 126 of file class.ilObjStyleSheet.php.
Referenced by ilObjStyleSheetGUI\copyStyleObject(), ilObjStyleSheetGUI\importStyleObject(), and ilObjStyleSheetGUI\saveObject().
ilObjStyleSheet::_writeUpToDate | ( | $a_id, | |
$a_up_to_date | |||
) |
Definition at line 99 of file class.ilObjStyleSheet.php.
Referenced by writeCSSFile().
ilObjStyleSheet::addParameter | ( | $a_tag, | |
$a_par | |||
) |
write style parameter to db
string | $a_tag | tag name (tag.class, e.g. "div.Mnemonic") |
string | $a_par | tag parameter (e.g. "margin-left") |
Definition at line 517 of file class.ilObjStyleSheet.php.
References getAvailableParameters(), ilObject\getId(), read(), and writeCSSFile().
ilObjStyleSheet::assignMetaData | ( | & | $a_meta_data | ) |
assign meta data object
Definition at line 286 of file class.ilObjStyleSheet.php.
ilObjStyleSheet::create | ( | $a_from_style = 0 | ) |
Definition at line 299 of file class.ilObjStyleSheet.php.
References ilObject\create(), DB_FETCHMODE_ASSOC, ilObject\getId(), getScope(), read(), and writeCSSFile().
ilObjStyleSheet::createFromXMLFile | ( | $a_file | ) |
create style from xml file
Definition at line 906 of file class.ilObjStyleSheet.php.
References $style, ilObject\create(), ilObject\getId(), read(), update(), and writeCSSFile().
ilObjStyleSheet::createReference | ( | ) |
creates reference for object
public
Reimplemented from ilObject.
Definition at line 74 of file class.ilObjStyleSheet.php.
ilObjStyleSheet::delete | ( | ) |
delete style object
Reimplemented from ilObject.
Definition at line 566 of file class.ilObjStyleSheet.php.
References ilObjContentObject\_deleteStyleAssignments(), ilObject\getId(), and ilUtil\getWebspaceDir().
ilObjStyleSheet::deleteParameter | ( | $a_id | ) |
delete style parameter
int | $a_id | style parameter id |
Definition at line 538 of file class.ilObjStyleSheet.php.
ilObjStyleSheet::deleteStylePar | ( | $a_tag, | |
$a_class, | |||
$a_par | |||
) |
delete style parameter by tag/class/parameter
Definition at line 550 of file class.ilObjStyleSheet.php.
References ilObject\getId().
ilObjStyleSheet::exportXML | ( | $a_dir | ) |
export style xml file to directory
Definition at line 881 of file class.ilObjStyleSheet.php.
References $file, and getXML().
Referenced by ilContObjectExport\buildExportFileXML().
ilObjStyleSheet::getAvailableParameters | ( | ) |
Definition at line 960 of file class.ilObjStyleSheet.php.
Referenced by addParameter().
ilObjStyleSheet::getAvailableTags | ( | ) |
get all available tags in an array
Definition at line 943 of file class.ilObjStyleSheet.php.
ilObjStyleSheet::getContentPrintStyle | ( | ) |
get content print style
static
Definition at line 753 of file class.ilObjStyleSheet.php.
Referenced by ilObjWikiGUI\printViewObject(), and ilLMPresentationGUI\showPrintView().
ilObjStyleSheet::getContentStylePath | ( | $a_style_id | ) |
get content style path
static (to avoid full reading)
Definition at line 710 of file class.ilObjStyleSheet.php.
References ilObject\$ilias, $style, ilObject\_exists(), _lookupUpToDate(), ilUtil\getWebspaceDir(), and ilObjStyleSheet().
Referenced by ilWikiPageGUI\__construct(), ilGlossaryTermGUI\confirmDefinitionDeletion(), ilObjGlossaryGUI\confirmDefinitionDeletion(), ilPageObjectGUI\displayMediaFullscreen(), ilObjGroupGUI\executeCommand(), ilObjCategoryGUI\executeCommand(), ilTermDefinitionEditorGUI\executeCommand(), ilObjQuestionPoolGUI\executeCommand(), ilObjRootFolderGUI\executeCommand(), ilLMPresentationGUI\exportbibinfo(), ilPaymentObjectGUI\forwardToPageObject(), ilContainerGUI\forwardToPageObject(), ilShopGUI\forwardToPageObject(), ilObjPaymentSettingsGUI\forwardToPageObject(), ilContainerGUI\getContainerPageHTML(), ilShopGUI\getPageHTML(), ilLMPresentationGUI\ilGlossary(), ilLMPresentationGUI\ilMedia(), ilLMPresentationGUI\ilPage(), ilGlossaryTermGUI\listDefinitions(), ilGlossaryPresentationGUI\listDefinitions(), ilLMEditorGUI\main_header(), ilGlossaryPresentationGUI\media(), ilLMPresentationGUI\offlineexport(), ilTestEvaluationGUI\outCorrectSolution(), ilTestOutputGUI\outCorrectSolution(), ilTestOutputGUI\outWorkingForm(), ilObjWikiGUI\printViewObject(), ilPCParagraphGUI\setStyle(), ilObjDlBookGUI\showAbstract(), ilObjDlBookGUI\showCitation(), ilLMPresentationGUI\showDownloadList(), ilObjMediaPoolGUI\showMedia(), ilLMPresentationGUI\showNoPublicAccess(), ilLMPresentationGUI\showPreconditionsOfPage(), ilLMPresentationGUI\showPrintView(), ilLMPresentationGUI\showPrintViewSelection(), and ilLMPresentationGUI\showTableOfContents().
& ilObjStyleSheet::getMetaData | ( | ) |
get meta data object
Definition at line 294 of file class.ilObjStyleSheet.php.
ilObjStyleSheet::getRefId | ( | ) |
get reference id public
Reimplemented from ilObject.
Definition at line 63 of file class.ilObjStyleSheet.php.
ilObjStyleSheet::getScope | ( | ) |
Definition at line 94 of file class.ilObjStyleSheet.php.
Referenced by create(), and update().
ilObjStyleSheet::getStyle | ( | ) |
todo: bad style! should return array of objects, not multi-dim-arrays
Definition at line 841 of file class.ilObjStyleSheet.php.
References $style.
Referenced by writeCSSFile().
ilObjStyleSheet::getSyntaxStylePath | ( | ) |
get syntax style path
static
Definition at line 763 of file class.ilObjStyleSheet.php.
Referenced by ilWikiPageGUI\__construct(), ilGlossaryTermGUI\confirmDefinitionDeletion(), ilObjGlossaryGUI\confirmDefinitionDeletion(), ilTermDefinitionEditorGUI\executeCommand(), ilObjQuestionPoolGUI\executeCommand(), ilLMPresentationGUI\exportbibinfo(), ilObjGlossary\exportHTML(), ilObjContentObject\exportHTML(), ilLMPresentationGUI\ilGlossary(), ilLMPresentationGUI\ilPage(), ilGlossaryTermGUI\listDefinitions(), ilGlossaryPresentationGUI\listDefinitions(), ilLMEditorGUI\main_header(), ilLMPresentationGUI\offlineexport(), ilTestEvaluationGUI\outCorrectSolution(), ilTestOutputGUI\outCorrectSolution(), ilTestOutputGUI\outWorkingForm(), ilObjWikiGUI\printViewObject(), ilObjDlBookGUI\showAbstract(), ilObjDlBookGUI\showCitation(), and ilLMPresentationGUI\showPrintView().
ilObjStyleSheet::getUpToDate | ( | ) |
Definition at line 84 of file class.ilObjStyleSheet.php.
ilObjStyleSheet::getXML | ( | ) |
get xml representation of style object
Definition at line 858 of file class.ilObjStyleSheet.php.
References $style.
Referenced by exportXML().
ilObjStyleSheet::ilClone | ( | ) |
clone style sheet (note: styles have no ref ids and return an object id)
public
Definition at line 497 of file class.ilObjStyleSheet.php.
References $log, ilObject\getDescription(), ilObject\getId(), ilObject\getTitle(), ilObject\getType(), and ilObjStyleSheet().
ilObjStyleSheet::ilObjStyleSheet | ( | $a_id = 0 , |
|
$a_call_by_reference = false |
|||
) |
Constructor public.
integer | reference_id or object_id |
boolean | treat the id as reference_id (true) or object_id (false) |
Definition at line 46 of file class.ilObjStyleSheet.php.
References ilObject\ilObject().
Referenced by getContentStylePath(), and ilClone().
ilObjStyleSheet::putInTree | ( | ) |
Definition at line 69 of file class.ilObjStyleSheet.php.
ilObjStyleSheet::read | ( | ) |
read style properties
Definition at line 612 of file class.ilObjStyleSheet.php.
References $res, DB_FETCHMODE_ASSOC, ilObject\getId(), setScope(), and setUpToDate().
Referenced by addParameter(), create(), createFromXMLFile(), and update().
ilObjStyleSheet::replaceStylePar | ( | $a_tag, | |
$a_class, | |||
$a_par, | |||
$a_val | |||
) |
update style parameter per tag/class/parameter
Definition at line 801 of file class.ilObjStyleSheet.php.
References ilObject\getId().
ilObjStyleSheet::setRefId | ( | ) |
Definition at line 58 of file class.ilObjStyleSheet.php.
ilObjStyleSheet::setScope | ( | $a_scope | ) |
Definition at line 89 of file class.ilObjStyleSheet.php.
Referenced by read().
ilObjStyleSheet::setStyle | ( | $a_style | ) |
ilObjStyleSheet::setUpToDate | ( | $a_up_to_date = true | ) |
Definition at line 79 of file class.ilObjStyleSheet.php.
Referenced by read(), and writeCSSFile().
ilObjStyleSheet::update | ( | ) |
update object in db
public
Reimplemented from ilObject.
Definition at line 768 of file class.ilObjStyleSheet.php.
References getScope(), read(), and writeCSSFile().
Referenced by createFromXMLFile().
ilObjStyleSheet::updateStyleParameter | ( | $a_id, | |
$a_value | |||
) |
update style parameter per id
int | $a_id | style parameter id |
int | $a_id | style parameter value |
Definition at line 787 of file class.ilObjStyleSheet.php.
ilObjStyleSheet::writeCSSFile | ( | $a_target_file = "" | ) |
write css file to webspace directory
Definition at line 655 of file class.ilObjStyleSheet.php.
References $style, _writeUpToDate(), ilObject\getId(), getStyle(), ilUtil\getWebspaceDir(), and setUpToDate().
Referenced by addParameter(), create(), createFromXMLFile(), and update().
ilObjStyleSheet::$style |
Definition at line 37 of file class.ilObjStyleSheet.php.
Referenced by createFromXMLFile(), getContentStylePath(), getStyle(), getXML(), and writeCSSFile().