ilObjStyleSheet Class Reference

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

Inheritance diagram for ilObjStyleSheet:

Collaboration diagram for ilObjStyleSheet:

Public Member Functions
	__construct (int $a_id=0, bool $a_call_by_reference=false)
	setUpToDate (bool $a_up_to_date=true)
	Set style up to date (false + update will trigger css generation next time) More...
	getUpToDate ()
	setScope (int $a_scope)
	getScope ()
	create (int $a_from_style=0, bool $a_import_mode=false)
	Create a new style. More...
	characteristicExists (string $a_char, string $a_style_type)
	Check whether characteristic exists. More...
	addCharacteristic (string $a_type, string $a_char, bool $a_hidden=false, int $order_nr=0, bool $outdated=false)
	getCharacteristics (string $a_type="", bool $a_no_hidden=false, bool $a_include_core=true)
	Get characteristics. More...
	setCharacteristics (array $a_chars)
	saveHideStatus (string $a_type, string $a_char, bool $a_hide)
	Save characteristic hidden status. More...
	getHideStatus (string $a_type, string $a_char)
	Get characteristic hidden status. More...
	ilClone ()
	clone style sheet (note: styles have no ref ids and return an object id) More...
	copyImagesToDir (string $a_target)
	Copy images to directory. More...
	addParameter (string $a_tag, string $a_par, string $a_type, int $a_mq_id=0, bool $a_custom=false)
	write style parameter to db More...
	createImagesDirectory ()
	Create images directory <data_dir>/sty/sty_<id>/images. More...
	getImagesDirectory ()
	getThumbnailsDirectory ()
	deleteParameter (int $a_id)
	delete style parameter More...
	deleteCustomStylePars (string $a_tag, string $a_class, string $a_type, int $a_mq_id=0)
	Delete style parameter by tag/class/parameter. More...
	deleteStyleParOfChar (string $a_type, string $a_class)
	Delete style parameters of characteristic. More...
	delete ()
	read ()
	read style properties More...
	writeCSSFile (string $a_target_file="", string $a_image_dir="")
	write css file to webspace directory More...
	getParametersOfClass (string $a_type, string $a_class, int $a_mq_id=0)
	update ()
	updateStyleParameter (int $a_id, string $a_value)
	update style parameter per id More...
	getStyle ()
	setStyle (array $a_style)
	handleXmlString (string $a_str)
	getXML ()
	get xml representation of style object todo: add mq_id More...
	createExportDirectory ()
	cleanExportDirectory ()
	createExportSubDirectory ()
	setExportSubDir (string $a_dir)
	Set local directory, that will be included within the zip file. More...
	getExportSubDir ()
	The local directory, that will be included within the zip file. More...
	export ()
	exportXML (string $a_dir)
	export style xml file to directory More...
	createImportDirectory ()
	import ($a_file)
	createFromXMLFile (string $a_file, bool $a_skip_parent_create=false)
	create style from xml file todo: add mq_id and custom More...
	getStyleParameterGroups ()
	Get grouped parameter. More...
	determineTemplateStyleClassType (string $t, string $k)
	do_3_10_Migration ()
	Migrates 3.10 style to 3.11 style. More...
	do_3_10_CharMigration (int $a_id=0)
	This is more or less a copy of Services/Migration/DBUpdate_1385/classes ilStyleMigration->addMissingStyleCharacteristics() Any changes here may also be interesting there. More...
	do_3_9_Migration (int $a_id)
	Migrate old 3.9 styles. More...
	getColors ()
	Get colors of style. More...
	removeColor (string $a_name)
	Remove a color. More...
	getColorCodeForName (string $a_name)
	getMediaQueries ()
	addMediaQuery (string $a_mquery, int $order_nr=0)
	getMaxMQueryOrderNr ()
	Get maximum media query order nr. More...
	updateMediaQuery (int $a_id, string $a_mquery)
	getMediaQueryForId (int $a_id)
	Get media query for id. More...
	deleteMediaQuery (int $a_id)
	Delete media query. More...
	saveMediaQueryOrder (array $a_order_nr=null)
	Save media query order. More...
	getTemplates (string $a_type)
	Get table templates of style. More...
	getTemplateClasses (int $a_tid)
	Get template classes. More...
	addTemplate (string $a_type, string $a_name, array $a_classes)
	Add table template. More...
	updateTemplate (int $a_t_id, string $a_name, array $a_classes)
	Update table template. More...
	addTemplateClass (int $a_t_id, string $a_type, string $a_class)
	templateExists (string $a_template_name)
	Check whether template exists. More...
	getTemplate (int $a_t_id)
	lookupTemplateName (int $a_t_id)
	Lookup table template name for template ID. More...
	getTemplateXML ()
	Get table template xml. More...
	writeTemplatePreview (int $a_t_id, string $a_preview_html)
	Write table template preview. More...
	lookupTemplatePreview (int $a_t_id)
	Lookup table template preview. More...
	removeTemplate (int $a_t_id)
	Remove table template. More...
	writeStyleSetting (string $a_name, string $a_value)
	lookupStyleSetting (string $a_name)
	Lookup style setting. More...
Public Member Functions inherited from ilObject
	__construct (int $id=0, bool $reference=true)
	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...
	processAutoRating ()
	read ()
	getId ()
	setId (int $id)
	setRefId (int $ref_id)
	getRefId ()
	getType ()
	setType (string $type)
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...
	getTitle ()
	getUntranslatedTitle ()
	Get untranslated object title WebDAV needs to access the untranslated title of an object. More...
	setTitle (string $title)
	getDescription ()
	setDescription (string $desc)
	getLongDescription ()
	get object long description (stored in object_description) More...
	getImportId ()
	setImportId (string $import_id)
	setOfflineStatus (bool $status)
	getOfflineStatus ()
	supportsOfflineHandling ()
	getOwner ()
	getOwnerName ()
	get full name of object owner More...
	setOwner (int $usr_id)
	getCreateDate ()
	Get create date in YYYY-MM-DD HH-MM-SS format. More...
	getLastUpdateDate ()
	Get last update date in YYYY-MM-DD HH-MM-SS format. More...
	create ()
	note: title, description and type should be set when this function is called More...
	update ()
	MDUpdateListener (string $element)
	Metadata update listener. More...
	createMetaData ()
	updateMetaData ()
	deleteMetaData ()
	updateOwner ()
	update owner of object in db More...
	putInTree (int $parent_ref_id)
	maybe this method should be in tree object!? More...
	setPermissions (int $parent_ref_id)
	setParentRolePermissions (int $parent_ref_id)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g. More...
	createReference ()
	creates reference for object More...
	countReferences ()
	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More...
	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type. More...
	applyDidacticTemplate (int $tpl_id)
	getXMLZip ()
	getHTMLDirectory ()
	appendCopyInfo (int $target_id, int $copy_id)
	Prepend Copy info if object with same name exists in that container. More...
	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies. More...
	cloneMetaData (ilObject $target_obj)
	Copy meta data. More...
	selfOrParentWithRatingEnabled ()
	getPossibleSubObjects (bool $filter=true)
	get all possible sub objects of this type the object can decide which types of sub objects are possible jut in time overwrite if the decision distinguish from standard model More...

Static Public Member Functions
static	getBasicZipPath ()
static	_writeUpToDate (int $a_id, bool $a_up_to_date)
static	writeOwner ($obj_id, $style_id)
static	_lookupUpToDate (int $a_id)
static	_writeStandard (int $a_id, bool $a_std)
	Write standard flag. More...
static	_writeScope (int $a_id, int $a_scope)
static	_lookupStandard (int $a_id)
	Lookup standard flag. More...
static	_writeActive (int $a_id, bool $a_active)
static	_lookupActive (int $a_id)
	Lookup active flag. More...
static	_getStandardStyles (bool $a_exclude_default_style=false, bool $a_include_deactivated=false, int $a_scope=0)
	Get standard styles. More...
static	_getClonableContentStyles ()
	Get all clonable styles (active standard styles and individual learning module styles with write permission). More...
static	_getBasicStyleDom ()
static	getBasicImageDir ()
static	_createImagesDirectory (int $a_style_id)
	Create images directory <data_dir>/sty/sty_<id>/images. More...
static	_getImagesDirectory (int $a_style_id)
static	getEffectiveContentStyleId (int $a_style_id)
	Get effective Style Id. More...
static	getContentStylePath (int $a_style_id, bool $add_random=true, bool $add_token=true)
	get content style path static (to avoid full reading) More...
static	getContentPrintStyle ()
static	getSyntaxStylePath ()
static	getPlaceHolderStylePath ()
static	_getStyleParameterInputType (string $par)
static	_getStyleParameterSubPar (string $par)
static	_getStyleParameters (string $a_tag="")
static	_getFilteredGroups ()
static	_getStyleParameterNumericUnits (bool $a_no_percentage=false)
static	_getStyleParameterValues (string $par)
static	_getStyleSuperTypes ()
static	_isExpandable (string $a_type)
static	_isHideable (string $a_type)
static	_getStyleSuperTypeForType (string $a_type)
static	_getCoreStyles ()
static	isCoreStyle (string $a_type, string $a_class)
static	_getTemplateClassTypes (string $a_template_type="")
	Get template class types. More...
static	_getPseudoClasses (string $tag)
static	_determineTag (string $a_type)
static	getAvailableParameters ()
static	_addMissingStyleClassesToStyle (int $a_id)
	Add missing style classes to all styles. More...
static	_addMissingStyleClassesToAllStyles (?array $a_styles=null)
	Add missing style classes to all styles todo: add mq_id and custom handling. More...
static	_getColorFlavor (string $a_rgb, int $a_i)
	Get color flavor. More...
static	_explodeRGB (string $a_rgb, bool $as_dec=false)
	Explode an RGB string into an array. More...
static	_RGBToHLS (array $a_rgb)
	RGB to HLS (both arrays, 0..255) More...
static	_HLSToRGB (array $a_hls)
	HLS to RGB (both arrays, 0..255) More...
static	_lookupTemplateName (int $a_t_id)
	Lookup table template name for template ID. More...
static	_lookupTemplateIdByName (int $a_style_id, string $a_name)
	Lookup table template preview. More...
static	writeStyleUsage (int $a_obj_id, int $a_style_id)
	Write style usage. More...
static	lookupObjectStyle (int $a_obj_id)
	Lookup object style. More...
static	lookupObjectForStyle (int $a_style_id)
	Lookup objects for style. More...
Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId (string $import_id)
	Get (latest) object id for an import id. More...
static	_lookupImportId (int $obj_id)
static	_lookupOwnerName (int $owner_id)
	Lookup owner name for owner id. More...
static	_getIdForImportId (string $import_id)
static	_getAllReferences (int $id)
	get all reference ids for object ID More...
static	_lookupTitle (int $obj_id)
static	lookupOfflineStatus (int $obj_id)
	Lookup offline status using objectDataCache. More...
static	_lookupOwner (int $obj_id)
	Lookup owner user ID for object ID. More...
static	_getIdsForTitle (string $title, string $type='', bool $partial_match=false)
static	_lookupDescription (int $obj_id)
static	_lookupLastUpdate (int $obj_id, bool $formatted=false)
static	_getLastUpdateOfObjects (array $obj_ids)
static	_lookupObjId (int $ref_id)
static	_setDeletedDate (int $ref_id, int $deleted_by)
static	setDeletedDates (array $ref_ids, int $user_id)
static	_resetDeletedDate (int $ref_id)
static	_lookupDeletedDate (int $ref_id)
static	_writeTitle (int $obj_id, string $title)
	write title to db (static) More...
static	_writeDescription (int $obj_id, string $desc)
	write description to db (static) More...
static	_writeImportId (int $obj_id, string $import_id)
	write import id to db (static) More...
static	_lookupType (int $id, bool $reference=false)
static	_isInTrash (int $ref_id)
static	_hasUntrashedReference (int $obj_id)
	checks whether an object has at least one reference that is not in trash More...
static	_lookupObjectId (int $ref_id)
static	_getObjectsDataForType (string $type, bool $omit_trash=false)
	get all objects of a certain type More...
static	_exists (int $id, bool $reference=false, ?string $type=null)
	checks if an object exists in object_data More...
static	_getObjectsByType (string $obj_type="", int $owner=null)
static	_prepareCloneSelection (array $ref_ids, string $new_type, bool $show_path=true)
	Prepare copy wizard object selection. More...
static	_getIcon (int $obj_id=0, string $size="big", string $type="", bool $offline=false)
	Get icon for repository item. More...
static	collectDeletionDependencies (array &$deps, int $ref_id, int $obj_id, string $type, int $depth=0)
	Collect deletion dependencies. More...
static	getDeletionDependencies (int $obj_id)
	Get deletion dependencies. More...
static	getLongDescriptions (array $obj_ids)
static	getAllOwnedRepositoryObjects (int $user_id)
static	fixMissingTitles ($type, array &$obj_title_map)
	Try to fix missing object titles. More...
static	_lookupCreationDate (int $obj_id)
static	_getObjectTypeIdByTitle (string $type, \ilDBInterface $ilDB=null)

Data Fields
array	$style = []
Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
const	DESC_LENGTH = 128
const	LONG_DESC_LENGTH = 4000
const	TABLE_OBJECT_DATA = "object_data"
array	$objectList
string	$untranslatedTitle

Static Public Attributes
static array	$num_unit = array("px", "em", "ex", "%", "pt", "pc", "in", "mm", "cm")
static array	$num_unit_no_perc = array("px", "em", "ex", "pt", "pc", "in", "mm", "cm")
static array	$parameter
static array	$filtered_groups
static array	$style_super_types
static array	$expandable_types
static array	$hideable_types
static array	$assigned_tags
static array	$pseudo_classes
static array	$core_styles
static array	$templates

Static Protected Member Functions
static	hexdec (string $hex)

Protected Attributes
ILIAS Style Content InternalRepoService	$repo
bool	$is_3_10_skin = false
string	$export_sub_dir = ""
array	$chars_by_type = []
array	$end_styles = []
array	$chars = []
bool	$up_to_date = false
array	$hidden_chars = []
array	$style_class = []
int	$scope = 0
Protected Attributes inherited from ilObject
ilLogger	$obj_log
ILIAS	$ilias
ilObjectDefinition	$obj_definition
ilDBInterface	$db
ilLogger	$log
ilErrorHandling	$error
ilTree	$tree
ilAppEventHandler	$app_event_handler
ilRbacAdmin	$rbac_admin
ilRbacReview	$rbac_review
ilObjUser	$user
ilLanguage	$lng
int	$id
bool	$referenced
bool	$call_by_reference
int	$max_title = self::TITLE_LENGTH
int	$max_desc = self::DESC_LENGTH
bool	$add_dots = true
int	$ref_id = null
string	$type = ""
string	$title = ""
bool	$offline = false
string	$desc = ""
string	$long_desc = ""
int	$owner = 0
string	$create_date = ""
string	$last_update = ""
string	$import_id = ""
bool	$register = false

Static Protected Attributes
static string	$basic_style_file = "./libs/ilias/Style/basic_style/style.xml"
static string	$basic_style_zip = "./libs/ilias/Style/basic_style/style.zip"
static string	$basic_style_image_dir = "./libs/ilias/Style/basic_style/images"
static DOMDocument	$basic_style_dom = null

Additional Inherited Members
Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)
	beforeMDUpdateListener (string $a_element)
	doCreateMetaData ()
	beforeCreateMetaData ()
	doUpdateMetaData ()
	beforeUpdateMetaData ()
	doDeleteMetaData ()
	beforeDeleteMetaData ()
	handleAutoRating ()
	hasAutoRating ()

Detailed Description

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

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

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

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

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

Constructor & Destructor Documentation

__construct()

ilObjStyleSheet::__construct	(	int	$a_id = 0,
		bool	$a_call_by_reference = false
	)

Definition at line 505 of file class.ilObjStyleSheet.php.

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\lng().

      {
        global $DIC;

        $this->db = $DIC->database();
        $this->lng = $DIC->language();
        $this->type = "sty";
        $this->style = array();
        $this->ilias = $DIC["ilias"];

        if ($a_call_by_reference) {
            $this->ilias->raiseError("Can't instantiate style object via reference id.", $this->ilias->error_obj->FATAL);
        }
        parent::__construct($a_id, false);
        $this->repo = $DIC->contentStyle()->internal()->repo();
    }

Here is the call graph for this function:

Member Function Documentation

_addMissingStyleClassesToAllStyles()

static ilObjStyleSheet::_addMissingStyleClassesToAllStyles ( ?array  $a_styles = null )

static

Add missing style classes to all styles todo: add mq_id and custom handling.

Definition at line 2170 of file class.ilObjStyleSheet.php.

References $DIC, ilObject\$id, $ilDB, _createImagesDirectory(), _getBasicStyleDom(), _getCoreStyles(), _getImagesDirectory(), and ilObject\_getObjectsDataForType().

Referenced by _addMissingStyleClassesToStyle().

     : void {
        global $DIC;

        $ilDB = $DIC->database();

        if (is_null($a_styles)) {
            $styles = ilObject::_getObjectsDataForType("sty");
        } else {
            $styles = $a_styles;
        }
        $core_styles = ilObjStyleSheet::_getCoreStyles();
        $bdom = ilObjStyleSheet::_getBasicStyleDom();

        // get all core image files
        $core_images = array();
        $core_dir = self::$basic_style_image_dir;
        if (is_dir($core_dir)) {
            $dir = opendir($core_dir);
            while ($file = readdir($dir)) {
                if (substr($file, 0, 1) != "." && is_file($core_dir . "/" . $file)) {
                    $core_images[] = $file;
                }
            }
        }

        foreach ($styles as $style) {
            $id = $style["id"];

            foreach ($core_styles as $cs) {
                // check, whether core style class exists
                $set = $ilDB->queryF(
                    "SELECT * FROM style_char WHERE style_id = %s " .
                    "AND type = %s AND characteristic = %s",
                    array("integer", "text", "text"),
                    array($id, $cs["type"], $cs["class"])
                );

                // if not, add core style class
                if (!($rec = $ilDB->fetchAssoc($set))) {
                    $ilDB->manipulateF(
                        "INSERT INTO style_char (style_id, type, characteristic) " .
                        " VALUES (%s,%s,%s) ",
                        array("integer", "text", "text"),
                        array($id, $cs["type"], $cs["class"])
                    );

                    $xpath = new DOMXPath($bdom);
                    $par_nodes = $xpath->query("/StyleSheet/Style[@Tag = '" . $cs["tag"] . "' and @Type='" .
                        $cs["type"] . "' and @Class='" . $cs["class"] . "']/StyleParameter");
                    foreach ($par_nodes as $par_node) {
                        // check whether style parameter exists
                        $set = $ilDB->queryF(
                            "SELECT * FROM style_parameter WHERE style_id = %s " .
                            "AND type = %s AND class = %s AND tag = %s AND parameter = %s",
                            array("integer", "text", "text", "text", "text"),
                            array($id, $cs["type"], $cs["class"],
                            $cs["tag"], $par_node->getAttribute("Name"))
                        );

                        // if not, create style parameter
                        if (!($ilDB->fetchAssoc($set))) {
                            $spid = $ilDB->nextId("style_parameter");
                            $st = $ilDB->manipulateF(
                                "INSERT INTO style_parameter (id, style_id, type, class, tag, parameter, value) " .
                                " VALUES (%s,%s,%s,%s,%s,%s,%s)",
                                array("integer", "integer", "text", "text", "text", "text", "text"),
                                array($spid, $id, $cs["type"], $cs["class"], $cs["tag"],
                                $par_node->getAttribute("Name"), $par_node->getAttribute("Value"))
                            );
                        }
                    }
                }
            }

            // now check, whether some core image files are missing
            ilObjStyleSheet::_createImagesDirectory($id);
            $imdir = ilObjStyleSheet::_getImagesDirectory($id);
            foreach ($core_images as $cim) {
                if (!is_file($imdir . "/" . $cim)) {
                    copy($core_dir . "/" . $cim, $imdir . "/" . $cim);
                }
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_addMissingStyleClassesToStyle()

static ilObjStyleSheet::_addMissingStyleClassesToStyle ( int  $a_id )

static

Add missing style classes to all styles.

Definition at line 2159 of file class.ilObjStyleSheet.php.

References _addMissingStyleClassesToAllStyles().

Referenced by import(), and ilObjStyleSheetGUI\saveObject().

     : void {
        $styles = array(array("id" => $a_id));
        ilObjStyleSheet::_addMissingStyleClassesToAllStyles($styles);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_createImagesDirectory()

static ilObjStyleSheet::_createImagesDirectory ( int  $a_style_id )

static

Create images directory <data_dir>/sty/sty_<id>/images.

Definition at line 1102 of file class.ilObjStyleSheet.php.

References $DIC, $ilErr, ilFileUtils\getWebspaceDir(), and ilFileUtils\makeDir().

Referenced by _addMissingStyleClassesToAllStyles(), create(), and createImagesDirectory().

     : void {
        global $DIC;

        $ilErr = $DIC["ilErr"];

        $sty_data_dir = ilFileUtils::getWebspaceDir() . "/sty";
        if (!is_dir($sty_data_dir)) {
            ilFileUtils::makeDir($sty_data_dir);
        }
        if (!is_writable($sty_data_dir)) {
            $ilErr->raiseError("Style data directory (" . $sty_data_dir
                . ") not writeable.", $ilErr->FATAL);
        }

        $style_dir = $sty_data_dir . "/sty_" . $a_style_id;
        if (!is_dir($style_dir)) {
            ilFileUtils::makeDir($style_dir);
        }
        if (!is_dir($style_dir)) {
            $ilErr->raiseError("Creation of style directory failed (" .
                $style_dir . ").", $ilErr->FATAL);
        }

        // create images subdirectory
        $im_dir = $style_dir . "/images";
        if (!is_dir($im_dir)) {
            ilFileUtils::makeDir($im_dir);
        }
        if (!is_dir($im_dir)) {
            $ilErr->raiseError("Creation of Import Directory failed (" .
                $im_dir . ").", $ilErr->FATAL);
        }

        // create thumbnails directory
        $thumb_dir = $style_dir . "/images/thumbnails";
        ilFileUtils::makeDir($thumb_dir);
        if (!is_dir($thumb_dir)) {
            $ilErr->raiseError("Creation of Import Directory failed (" .
                $thumb_dir . ").", $ilErr->FATAL);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_determineTag()

static ilObjStyleSheet::_determineTag ( string  $a_type )

static

Definition at line 2141 of file class.ilObjStyleSheet.php.

Referenced by _getCoreStyles(), ILIAS\Style\Content\CharacteristicManager\copyCharacteristicFromSource(), ILIAS\Style\Content\CharacteristicManager\deleteCharacteristic(), ILIAS\Style\Content\CharacteristicTableGUI\fillRow(), getXML(), and ilStyleCharacteristicGUI\saveCharacteristic().

                                                        : string
    {
        return self::$assigned_tags[$a_type];
    }

Here is the caller graph for this function:

_explodeRGB()

static ilObjStyleSheet::_explodeRGB ( string  $a_rgb, bool  $as_dec = false  )

static

Explode an RGB string into an array.

Definition at line 2592 of file class.ilObjStyleSheet.php.

Referenced by _getColorFlavor().

     : array {
        $r["r"] = (string) substr($a_rgb, 0, 2);
        $r["g"] = (string) substr($a_rgb, 2, 2);
        $r["b"] = (string) substr($a_rgb, 4, 2);
        if ($as_dec) {
            $r["r"] = self::hexdec($r["r"]);
            $r["g"] = self::hexdec($r["g"]);
            $r["b"] = self::hexdec($r["b"]);
        }

        return $r;
    }

Here is the caller graph for this function:

_getBasicStyleDom()

static ilObjStyleSheet::_getBasicStyleDom ( )

static

Definition at line 759 of file class.ilObjStyleSheet.php.

Referenced by _addMissingStyleClassesToAllStyles().

                                              : DOMDocument
    {
        if (!is_object(self::$basic_style_dom)) {
            self::$basic_style_dom = new DOMDocument();
            self::$basic_style_dom->load(self::$basic_style_file);
        }

        return self::$basic_style_dom;
    }

Here is the caller graph for this function:

_getClonableContentStyles()

static ilObjStyleSheet::_getClonableContentStyles ( )

static

Get all clonable styles (active standard styles and individual learning module styles with write permission).

Returns

array<int,string>

Definition at line 717 of file class.ilObjStyleSheet.php.

References $DIC, ilObject\$id, $ilDB, ilObject\$ref_id, ilObject\_getAllReferences(), ilObjContentObject\_lookupContObjIdByStyleId(), ilObject\_lookupTitle(), and ILIAS\Repository\int().

Referenced by ilObjStyleSheetGUI\getCloneForm().

                                                      : array
    {
        global $DIC;

        $ilAccess = $DIC->access();
        $ilDB = $DIC->database();

        $clonable_styles = array();

        $q = "SELECT * FROM style_data";
        $style_set = $ilDB->query($q);
        while ($style_rec = $ilDB->fetchAssoc($style_set)) {
            $clonable = false;
            if ($style_rec["standard"] == 1) {
                if ($style_rec["active"] == 1) {
                    $clonable = true;
                }
            } else {
                $obj_ids = ilObjContentObject::_lookupContObjIdByStyleId((int) $style_rec["id"]);
                if (count($obj_ids) == 0) {
                    $obj_ids = self::lookupObjectForStyle((int) $style_rec["id"]);
                }
                foreach ($obj_ids as $id) {
                    $ref = ilObject::_getAllReferences((int) $id);
                    foreach ($ref as $ref_id) {
                        if ($ilAccess->checkAccess("write", "", $ref_id)) {
                            $clonable = true;
                        }
                    }
                }
            }
            if ($clonable) {
                $clonable_styles[(int) $style_rec["id"]] =
                    ilObject::_lookupTitle((int) $style_rec["id"]);
            }
        }

        asort($clonable_styles);

        return $clonable_styles;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getColorFlavor()

static ilObjStyleSheet::_getColorFlavor ( string  $a_rgb, int  $a_i  )

static

Get color flavor.

Definition at line 2566 of file class.ilObjStyleSheet.php.

References _explodeRGB(), _HLSToRGB(), and _RGBToHLS().

Referenced by ilStyleColorTableGUI\fillRow(), and getColorCodeForName().

     : string {
        $rgb = ilObjStyleSheet::_explodeRGB($a_rgb, true);
        $hls = ilObjStyleSheet::_RGBToHLS($rgb);

        if ($a_i > 0) {
            $hls["l"] = $hls["l"] + ((255 - $hls["l"]) * ($a_i / 100));
        }
        if ($a_i < 0) {
            $hls["l"] = $hls["l"] - (($hls["l"]) * (-$a_i / 100));
        }

        $rgb = ilObjStyleSheet::_HLSToRGB($hls);

        foreach ($rgb as $k => $v) {
            $rgb[$k] = str_pad(dechex((int) $v), 2, "0", STR_PAD_LEFT);
        }

        return $rgb["r"] . $rgb["g"] . $rgb["b"];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getCoreStyles()

static ilObjStyleSheet::_getCoreStyles ( )

static

Definition at line 2091 of file class.ilObjStyleSheet.php.

References _determineTag().

Referenced by ILIAS\Style\Content\CharacteristicTableGUI\__construct(), _addMissingStyleClassesToAllStyles(), ILIAS\Style\Content\CharacteristicManager\deleteCharacteristic(), ilStyleCharacteristicGUI\deleteCharacteristicConfirmation(), and ilStyleCharacteristicGUI\deleteCoreCharMessage().

                                           : array
    {
        $c_styles = array();
        foreach (self::$core_styles as $cstyle) {
            $c_styles[$cstyle["type"] . "." . ilObjStyleSheet::_determineTag($cstyle["type"]) . "." . $cstyle["class"]]
                = array("type" => $cstyle["type"],
                    "tag" => ilObjStyleSheet::_determineTag($cstyle["type"]),
                    "class" => $cstyle["class"]);
        }
        return $c_styles;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getFilteredGroups()

static ilObjStyleSheet::_getFilteredGroups ( )

static

Definition at line 2042 of file class.ilObjStyleSheet.php.

Referenced by ilStyleCharacteristicGUI\getValues(), and ilStyleCharacteristicGUI\initTagStyleForm().

                                               : array
    {
        return self::$filtered_groups;
    }

Here is the caller graph for this function:

_getImagesDirectory()

static ilObjStyleSheet::_getImagesDirectory ( int  $a_style_id )

static

Definition at line 1151 of file class.ilObjStyleSheet.php.

References ilFileUtils\getWebspaceDir().

Referenced by _addMissingStyleClassesToAllStyles(), getImagesDirectory(), ilStyleDataSet\getXmlRecord(), and ilStyleDataSet\importRecord().

                                                               : string
    {
        return ilFileUtils::getWebspaceDir() . "/sty/sty_" . $a_style_id .
            "/images";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getPseudoClasses()

static ilObjStyleSheet::_getPseudoClasses ( string  $tag )

static

Definition at line 2128 of file class.ilObjStyleSheet.php.

                                                         : array
    {
        return self::$pseudo_classes[$tag] ?? [];
    }

_getStandardStyles()

static ilObjStyleSheet::_getStandardStyles ( bool  $a_exclude_default_style = false, bool  $a_include_deactivated = false, int  $a_scope = 0  )

static

Get standard styles.

Returns

array<int,string>

Definition at line 670 of file class.ilObjStyleSheet.php.

References $DIC, $ilDB, $ilSetting, $path, $res, ilObject\$tree, ilObject\_lookupTitle(), ilTree\getPathId(), ILIAS\Repository\int(), and ilTree\isInTree().

Referenced by ILIAS\Style\Content\Object\ObjectManager\getSelectableStyles().

     : array {
        global $DIC;

        $ilDB = $DIC->database();
        $ilSetting = $DIC->settings();
        $tree = $DIC->repositoryTree();

        $default_style = $ilSetting->get("default_content_style_id");

        $and_str = "";
        if (!$a_include_deactivated) {
            $and_str = " AND active = 1";
        }

        $q = "SELECT * FROM style_data " .
            " WHERE standard = 1" . $and_str;
        $res = $ilDB->query($q);
        $styles = array();
        while ($sty = $ilDB->fetchAssoc($res)) {
            if (!$a_exclude_default_style || $default_style != $sty["id"]) {
                // check scope
                if ($a_scope > 0 && $sty["category"] > 0) {
                    if ($tree->isInTree((int) $sty["category"]) &&
                        $tree->isInTree($a_scope)) {
                        $path = $tree->getPathId($a_scope);
                        if (!in_array((int) $sty["category"], $path)) {
                            continue;
                        }
                    }
                }
                $styles[(int) $sty["id"]] = ilObject::_lookupTitle((int) $sty["id"]);
            }
        }

        return $styles;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getStyleParameterInputType()

static ilObjStyleSheet::_getStyleParameterInputType ( string  $par )

static

Definition at line 2013 of file class.ilObjStyleSheet.php.

Referenced by ilStyleCharacteristicGUI\initTagStyleForm().

                                                                   : string
    {
        $input = self::$parameter[$par]["input"];
        return $input;
    }

Here is the caller graph for this function:

_getStyleParameterNumericUnits()

static ilObjStyleSheet::_getStyleParameterNumericUnits ( bool  $a_no_percentage = false )

static

Definition at line 2047 of file class.ilObjStyleSheet.php.

Referenced by ilFontSizeInputGUI\insert(), ilNumericStyleValueInputGUI\insert(), ilBackgroundPositionInputGUI\insert(), ilTRBLBorderWidthInputGUI\insert(), and ilTRBLNumericStyleValueInputGUI\insert().

     : array {
        if ($a_no_percentage) {
            return self::$num_unit_no_perc;
        }
        return self::$num_unit;
    }

Here is the caller graph for this function:

_getStyleParameters()

static ilObjStyleSheet::_getStyleParameters ( string  $a_tag = "" )

static

Definition at line 2025 of file class.ilObjStyleSheet.php.

Referenced by ilStyleCharacteristicGUI\getValues(), and ilStyleCharacteristicGUI\saveTagStyle().

     : array {
        if ($a_tag == "") {
            return self::$parameter;
        }
        $par = array();
        foreach (self::$parameter as $k => $v) {
            if (isset(self::$filtered_groups[$v["group"]]) &&
                !in_array($a_tag, self::$filtered_groups[$v["group"]])) {
                continue;
            }
            $par[$k] = $v;
        }
        return $par;
    }

Here is the caller graph for this function:

_getStyleParameterSubPar()

static ilObjStyleSheet::_getStyleParameterSubPar ( string  $par )

static

Definition at line 2019 of file class.ilObjStyleSheet.php.

                                                                : string
    {
        $subpar = self::$parameter[$par]["subpar"];
        return $subpar;
    }

_getStyleParameterValues()

static ilObjStyleSheet::_getStyleParameterValues ( string  $par )

static

Definition at line 2056 of file class.ilObjStyleSheet.php.

Referenced by ilFontSizeInputGUI\insert(), ilTRBLBorderStyleInputGUI\insert(), ilBackgroundPositionInputGUI\insert(), and ilTRBLBorderWidthInputGUI\insert().

     : array {
        return self::$parameter[$par]["values"];
    }

Here is the caller graph for this function:

_getStyleSuperTypeForType()

static ilObjStyleSheet::_getStyleSuperTypeForType ( string  $a_type )

static

Definition at line 2077 of file class.ilObjStyleSheet.php.

Referenced by ilObjStyleSheetGUI\__construct().

     : string {
        foreach (self::$style_super_types as $s => $t) {
            if (in_array($a_type, $t)) {
                return $s;
            }
            if ($a_type == $s) {
                return $s;
            }
        }
        return "";
    }

Here is the caller graph for this function:

_getStyleSuperTypes()

static ilObjStyleSheet::_getStyleSuperTypes ( )

static

Definition at line 2062 of file class.ilObjStyleSheet.php.

Referenced by ILIAS\Style\Content\CharacteristicTableGUI\__construct(), ILIAS\Style\Content\CharacteristicDBRepo\getBySuperType(), ilStyleCharacteristicGUI\initCharacteristicForm(), ilStyleCharacteristicGUI\listCharacteristics(), and ilStyleCharacteristicGUI\setListSubTabs().

                                                : array
    {
        return self::$style_super_types;
    }

Here is the caller graph for this function:

_getTemplateClassTypes()

static ilObjStyleSheet::_getTemplateClassTypes ( string  $a_template_type = "" )

static

Get template class types.

Definition at line 2118 of file class.ilObjStyleSheet.php.

Referenced by create(), ilObjStyleSheetGUI\getTemplateFormValues(), getTemplateXML(), getXML(), ilObjStyleSheetGUI\initTemplateForm(), ilObjStyleSheetGUI\saveTemplateObject(), ilObjStyleSheetGUI\setTemplatesSubTabs(), and ilObjStyleSheetGUI\updateTemplateObject().

     : array {
        if ($a_template_type == "") {
            return self::$templates;
        }

        return self::$templates[$a_template_type];
    }

Here is the caller graph for this function:

_HLSToRGB()

static ilObjStyleSheet::_HLSToRGB ( array  $a_hls )

static

HLS to RGB (both arrays, 0..255)

Definition at line 2662 of file class.ilObjStyleSheet.php.

Referenced by _getColorFlavor().

                                                  : array
    {
        $h = $a_hls["h"] / 255;
        $l = $a_hls["l"] / 255;
        $s = $a_hls["s"] / 255;
        $temp3 = 0;

        $rgb["r"] = $rgb["g"] = $rgb["b"] = 0;

        //  If S=0, define R, G, and B all to L
        if ($s == 0) {
            $rgb["r"] = $rgb["g"] = $rgb["b"] = $l;
        } else {
            if ($l < 0.5) {
                $temp2 = $l * (1.0 + $s);
            } else {
                $temp2 = $l + $s - $l * $s;
            }

            $temp1 = 2.0 * $l - $temp2;


            # For each of R, G, B, compute another temporary value, temp3, as follows:
            foreach ($rgb as $k => $v) {
                switch ($k) {
                    case "r":
                        $temp3 = $h + 1.0 / 3.0;
                        break;

                    case "g":
                        $temp3 = $h;
                        break;

                    case "b":
                        $temp3 = $h - 1.0 / 3.0;
                        break;
                }
                if ($temp3 < 0) {
                    $temp3 = $temp3 + 1.0;
                }
                if ($temp3 > 1) {
                    $temp3 = $temp3 - 1.0;
                }

                if (6.0 * $temp3 < 1) {
                    $rgb[$k] = $temp1 + ($temp2 - $temp1) * 6.0 * $temp3;
                } elseif (2.0 * $temp3 < 1) {
                    $rgb[$k] = $temp2;
                } elseif (3.0 * $temp3 < 2) {
                    $rgb[$k] = $temp1 + ($temp2 - $temp1) * ((2.0 / 3.0) - $temp3) * 6.0;
                } else {
                    $rgb[$k] = $temp1;
                }
            }
        }

        $rgb["r"] = round($rgb["r"] * 255);
        $rgb["g"] = round($rgb["g"] * 255);
        $rgb["b"] = round($rgb["b"] * 255);

        return $rgb;
    }

Here is the caller graph for this function:

_isExpandable()

static ilObjStyleSheet::_isExpandable ( string  $a_type )

static

Definition at line 2067 of file class.ilObjStyleSheet.php.

Referenced by ILIAS\Style\Content\CharacteristicTableGUI\__construct(), ilStyleCharacteristicGUI\initCharacteristicForm(), and ilStyleCharacteristicGUI\listCharacteristics().

                                                        : bool
    {
        return in_array($a_type, self::$expandable_types);
    }

Here is the caller graph for this function:

_isHideable()

static ilObjStyleSheet::_isHideable ( string  $a_type )

static

Definition at line 2072 of file class.ilObjStyleSheet.php.

Referenced by ILIAS\Style\Content\CharacteristicTableGUI\__construct(), and ILIAS\Style\Content\CharacteristicTableGUI\fillRow().

                                                      : bool
    {
        return in_array($a_type, self::$hideable_types);
    }

Here is the caller graph for this function:

_lookupActive()

static ilObjStyleSheet::_lookupActive ( int  $a_id )

static

Lookup active flag.

Definition at line 652 of file class.ilObjStyleSheet.php.

References $DIC, $ilDB, and $res.

Referenced by ilContentStyleSettingsGUI\edit().

                                                   : bool
    {
        global $DIC;

        $ilDB = $DIC->database();

        $q = "SELECT * FROM style_data " .
            " WHERE id = " . $ilDB->quote($a_id, "integer");
        $res = $ilDB->query($q);
        $sty = $ilDB->fetchAssoc($res);

        return (bool) $sty["active"];
    }

Here is the caller graph for this function:

_lookupStandard()

static ilObjStyleSheet::_lookupStandard ( int  $a_id )

static

Lookup standard flag.

Definition at line 623 of file class.ilObjStyleSheet.php.

References $DIC, $ilDB, and $res.

Referenced by ILIAS\Style\Content\Object\ObjectManager\cloneTo(), and ILIAS\Style\Content\Object\ObjectManager\inheritFromParent().

                                                     : bool
    {
        global $DIC;

        $ilDB = $DIC->database();

        $q = "SELECT * FROM style_data " .
            " WHERE id = " . $ilDB->quote($a_id, "integer");
        $res = $ilDB->query($q);
        $sty = $ilDB->fetchAssoc($res);

        return (bool) ($sty["standard"] ?? false);
    }

Here is the caller graph for this function:

_lookupTemplateIdByName()

static ilObjStyleSheet::_lookupTemplateIdByName ( int  $a_style_id, string  $a_name  )

static

Lookup table template preview.

Definition at line 3143 of file class.ilObjStyleSheet.php.

References $DIC, and $ilDB.

Referenced by ilPCTabsGUI\getFormValues(), and ilPCTableGUI\getPropertiesFormValues().

     : ?int {
        global $DIC;

        $ilDB = $DIC->database();

        $set = $ilDB->query("SELECT id FROM style_template " .
            " WHERE style_id = " . $ilDB->quote($a_style_id, "integer") .
            " AND name = " . $ilDB->quote($a_name, "text"));
        if ($rec = $ilDB->fetchAssoc($set)) {
            return (int) $rec["id"];
        }

        return null;
    }

Here is the caller graph for this function:

_lookupTemplateName()

static ilObjStyleSheet::_lookupTemplateName ( int  $a_t_id )

static

Lookup table template name for template ID.

Definition at line 3040 of file class.ilObjStyleSheet.php.

References $DIC, and $ilDB.

Referenced by ilObjStyleSheetGUI\updateTemplateObject().

                                                           : ?string
    {
        global $DIC;

        $ilDB = $DIC->database();

        $set = $ilDB->query("SELECT name FROM style_template WHERE " .
            " id = " . $ilDB->quote($a_t_id, "integer"));

        if ($rec = $ilDB->fetchAssoc($set)) {
            return $rec["name"];
        }

        return null;
    }

Here is the caller graph for this function:

_lookupUpToDate()

static ilObjStyleSheet::_lookupUpToDate ( int  $a_id )

static

Definition at line 577 of file class.ilObjStyleSheet.php.

References $DIC, $ilDB, and $res.

Referenced by getContentStylePath().

                                                     : bool
    {
        global $DIC;

        $ilDB = $DIC->database();

        $q = "SELECT uptodate FROM style_data " .
            " WHERE id = " . $ilDB->quote($a_id, "integer");
        $res = $ilDB->query($q);
        $sty = $ilDB->fetchAssoc($res);

        return (bool) $sty["uptodate"];
    }

Here is the caller graph for this function:

_RGBToHLS()

static ilObjStyleSheet::_RGBToHLS ( array  $a_rgb )

static

RGB to HLS (both arrays, 0..255)

Definition at line 2620 of file class.ilObjStyleSheet.php.

References Vendor\Package\$b.

Referenced by _getColorFlavor().

                                                  : array
    {
        $r = $a_rgb["r"] / 255;
        $g = $a_rgb["g"] / 255;
        $b = $a_rgb["b"] / 255;
        $h = 0;

        // max / min
        $max = max($r, $g, $b);
        $min = min($r, $g, $b);

        //lightness
        $l = ($max + $min) / 2;

        if ($max == $min) {
            $s = 0;
        } else {
            if ($l < 0.5) {
                $s = ($max - $min) / ($max + $min);
            } else {
                $s = ($max - $min) / (2.0 - $max - $min);
            }

            if ($r == $max) {
                $h = ($g - $b) / ($max - $min);
            } elseif ($g == $max) {
                $h = 2.0 + ($b - $r) / ($max - $min);
            } elseif ($b == $max) {
                $h = 4.0 + ($r - $g) / ($max - $min);
            }
        }

        $hls["h"] = round(($h / 6) * 255);
        $hls["l"] = round($l * 255);
        $hls["s"] = round($s * 255);

        return $hls;
    }

Here is the caller graph for this function:

_writeActive()

static ilObjStyleSheet::_writeActive ( int  $a_id, bool  $a_active  )

static

Definition at line 637 of file class.ilObjStyleSheet.php.

References $DIC, and $ilDB.

Referenced by ilContentStyleSettingsGUI\saveActiveStyles().

                                                                  : void
    {
        global $DIC;

        $ilDB = $DIC->database();

        $q = "UPDATE style_data SET active = " .
            $ilDB->quote((int) $a_active, "integer") .
            " WHERE id = " . $ilDB->quote($a_id, "integer");
        $ilDB->manipulate($q);
    }

Here is the caller graph for this function:

_writeScope()

static ilObjStyleSheet::_writeScope ( int  $a_id, int  $a_scope  )

static

Definition at line 608 of file class.ilObjStyleSheet.php.

References $DIC, and $ilDB.

Referenced by ilContentStyleSettingsGUI\saveScope().

                                                               : void
    {
        global $DIC;

        $ilDB = $DIC->database();

        $q = "UPDATE style_data SET category = " .
            $ilDB->quote($a_scope, "integer") .
            " WHERE id = " . $ilDB->quote($a_id, "integer");
        $ilDB->manipulate($q);
    }

Here is the caller graph for this function:

_writeStandard()

static ilObjStyleSheet::_writeStandard ( int  $a_id, bool  $a_std  )

static

Write standard flag.

Definition at line 594 of file class.ilObjStyleSheet.php.

References $DIC, and $ilDB.

Referenced by ilObjStyleSheetGUI\copyStyleObject(), ilObjStyleSheetGUI\importStyleObject(), and ilObjStyleSheetGUI\saveObject().

     : void {
        global $DIC;

        $ilDB = $DIC->database();

        $q = "UPDATE style_data SET standard = " .
            $ilDB->quote((int) $a_std, "integer") .
            " WHERE id = " . $ilDB->quote($a_id, "integer");
        $ilDB->manipulate($q);
    }

Here is the caller graph for this function:

_writeUpToDate()

static ilObjStyleSheet::_writeUpToDate ( int  $a_id, bool  $a_up_to_date  )

static

Definition at line 552 of file class.ilObjStyleSheet.php.

References $DIC, and $ilDB.

Referenced by ILIAS\Style\Content\CharacteristicManager\addCharacteristic(), addCharacteristic(), ILIAS\Style\Content\CharacteristicManager\deleteCharacteristic(), ilStyleCharacteristicGUI\pasteCharacteristics(), ILIAS\Style\Content\ColorManager\updateColor(), and writeCSSFile().

     : void {
        global $DIC;

        $ilDB = $DIC->database();

        $q = "UPDATE style_data SET uptodate = " .
            $ilDB->quote((int) $a_up_to_date, "integer") .
            " WHERE id = " . $ilDB->quote($a_id, "integer");
        $ilDB->manipulate($q);
    }

Here is the caller graph for this function:

addCharacteristic()

ilObjStyleSheet::addCharacteristic	(	string	$a_type,
		string	$a_char,
		bool	$a_hidden = false,
		int	$order_nr = 0,
		bool	$outdated = false
	)

Definition at line 918 of file class.ilObjStyleSheet.php.

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

     : void {
        $ilDB = $this->db;

        // delete characteristic record
        $ilDB->insert("style_char", [
            "style_id" => ["integer", $this->getId()],
            "type" => ["text", $a_type],
            "characteristic" => ["text", $a_char],
            "hide" => ["integer", (int) $a_hidden],
            "outdated" => ["integer", (int) $outdated],
            "order_nr" => ["integer", $order_nr]
        ]);

        $this->setUpToDate(false);
        $this->_writeUpToDate($this->getId(), false);
    }

Here is the call graph for this function:

addMediaQuery()

ilObjStyleSheet::addMediaQuery	(	string	$a_mquery,
		int	$order_nr = 0
	)

Definition at line 2749 of file class.ilObjStyleSheet.php.

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

Referenced by create().

     : int {
        $ilDB = $this->db;

        $id = $ilDB->nextId("sty_media_query");
        if ($order_nr == 0) {
            $order_nr = $this->getMaxMQueryOrderNr() + 10;
        }

        $ilDB->manipulate("INSERT INTO sty_media_query (id, style_id, mquery, order_nr)" .
            " VALUES (" .
            $ilDB->quote($id, "integer") . "," .
            $ilDB->quote($this->getId(), "integer") . "," .
            $ilDB->quote($a_mquery, "text") . "," .
            $ilDB->quote($order_nr, "integer") .
            ")");

        return $id;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addParameter()

ilObjStyleSheet::addParameter	(	string	$a_tag,
		string	$a_par,
		string	$a_type,
		int	$a_mq_id = 0,
		bool	$a_custom = false
	)

write style parameter to db

todo check usages add mq_id

Parameters

string	$a_tag	tag name (tag.class, e.g. "div.Mnemonic")
string	$a_par	tag parameter (e.g. "margin-left")
string	$a_type	style type (e.g. "section")

Definition at line 1059 of file class.ilObjStyleSheet.php.

References ilObject\$db, ilObject\$id, $ilDB, getAvailableParameters(), ilObject\getId(), read(), and writeCSSFile().

     : void {
        $ilDB = $this->db;

        $avail_params = $this->getAvailableParameters();
        $tag = explode(".", $a_tag);
        $value = $avail_params[$a_par][0];
        $id = $ilDB->nextId("style_parameter");
        $q = "INSERT INTO style_parameter (id,style_id, type, tag, class, parameter, value, mq_id, custom) VALUES " .
            "(" .
            $ilDB->quote($id, "integer") . "," .
            $ilDB->quote($this->getId(), "integer") . "," .
            $ilDB->quote($a_type, "text") . "," .
            $ilDB->quote($tag[0], "text") . "," .
            $ilDB->quote($tag[1], "text") . "," .
            $ilDB->quote($a_par, "text") . "," .
            $ilDB->quote($value, "text") . "," .
            $ilDB->quote($a_mq_id, "integer") . "," .
            $ilDB->quote($a_custom, "integer") .
            ")";
        $ilDB->manipulate($q);
        $this->read();
        $this->writeCSSFile();
    }

Here is the call graph for this function:

addTemplate()

ilObjStyleSheet::addTemplate	(	string	$a_type,
		string	$a_name,
		array	$a_classes
	)

Add table template.

Definition at line 2912 of file class.ilObjStyleSheet.php.

References $c, ilObject\$db, $ilDB, ilObjStyleSheetGUI\_getTemplatePreview(), ilObject\getId(), and writeTemplatePreview().

Referenced by create().

     : int {
        $ilDB = $this->db;

        $tid = $ilDB->nextId("style_template");
        $ilDB->manipulate("INSERT INTO style_template " .
            "(id, style_id, name, temp_type)" .
            " VALUES (" .
            $ilDB->quote($tid, "integer") . "," .
            $ilDB->quote($this->getId(), "integer") . "," .
            $ilDB->quote($a_name, "text") . "," .
            $ilDB->quote($a_type, "text") .
            ")");

        foreach ($a_classes as $t => $c) {
            $ilDB->manipulate("INSERT INTO style_template_class " .
                "(template_id, class_type, class)" .
                " VALUES (" .
                $ilDB->quote($tid, "integer") . "," .
                $ilDB->quote($t, "text") . "," .
                $ilDB->quote($c, "text") .
                ")");
        }

        $this->writeTemplatePreview(
            $tid,
            ilObjStyleSheetGUI::_getTemplatePreview($this, $a_type, $tid, true)
        );

        return $tid;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addTemplateClass()

ilObjStyleSheet::addTemplateClass	(	int	$a_t_id,
		string	$a_type,
		string	$a_class
	)

Definition at line 2976 of file class.ilObjStyleSheet.php.

References ilObject\$db, and $ilDB.

     : void {
        $ilDB = $this->db;

        $ilDB->manipulate("INSERT INTO style_template_class " .
            "(template_id, class_type, class)" .
            " VALUES (" .
            $ilDB->quote($a_t_id, "integer") . "," .
            $ilDB->quote($a_type, "text") . "," .
            $ilDB->quote($a_class, "text") .
            ")");
    }

characteristicExists()

ilObjStyleSheet::characteristicExists	(	string	$a_char,
		string	$a_style_type
	)

Check whether characteristic exists.

Definition at line 901 of file class.ilObjStyleSheet.php.

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

     : bool {
        $ilDB = $this->db;

        $set = $ilDB->queryF(
            "SELECT style_id FROM style_char WHERE style_id = %s AND characteristic = %s AND type = %s",
            array("integer", "text", "text"),
            array($this->getId(), $a_char, $a_style_type)
        );
        if ($ilDB->fetchAssoc($set)) {
            return true;
        }
        return false;
    }

Here is the call graph for this function:

cleanExportDirectory()

ilObjStyleSheet::cleanExportDirectory

(

)

Definition at line 1734 of file class.ilObjStyleSheet.php.

References ilFileUtils\delDir(), ilFileUtils\getDataDir(), and ilObject\getId().

Referenced by export().

                                          : void
    {
        $sty_data_dir = ilFileUtils::getDataDir() . "/sty";
        $style_dir = $sty_data_dir . "/sty_" . $this->getId();
        // create export subdirectory
        $ex_dir = $style_dir . "/export";

        if (is_dir($ex_dir)) {
            ilFileUtils::delDir($ex_dir, true);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

copyImagesToDir()

ilObjStyleSheet::copyImagesToDir

(

string

$a_target

)

Copy images to directory.

Definition at line 1045 of file class.ilObjStyleSheet.php.

References getImagesDirectory(), and ilFileUtils\rCopy().

                                                     : void
    {
        ilFileUtils::rCopy($this->getImagesDirectory(), $a_target);
    }

Here is the call graph for this function:

create()

ilObjStyleSheet::create	(	int	$a_from_style = 0,
		bool	$a_import_mode = false
	)

Create a new style.

Definition at line 778 of file class.ilObjStyleSheet.php.

References $c, ilObject\$db, $DIC, ilObject\$id, $ilDB, $service, _createImagesDirectory(), _getTemplateClassTypes(), addMediaQuery(), addTemplate(), createFromXMLFile(), createImagesDirectory(), ilObject\getId(), getImagesDirectory(), getScope(), ilFileUtils\rCopy(), read(), and writeCSSFile().

     : int {
        global $DIC;

        $ilDB = $this->db;

        $id = parent::create();

        $service = $DIC->contentStyle()
            ->internal();
        $access_manager = $service->domain()->access(
            0,
            $DIC->user()->getId()
        );
        $access_manager->enableWrite(true);
        $color_manager = $service->domain()->color($this->getId(), $access_manager);

        if ($a_from_style == 0) {
            if (!$a_import_mode) {
                // copy styles from basic style
                $this->createFromXMLFile(self::$basic_style_file, true);

                // copy images from basic style
                $this->createImagesDirectory();

                // cross filesystem (lib -> web) rCopy
                ilFileUtils::rCopy(
                    self::$basic_style_image_dir,
                    $this->getImagesDirectory()
                );
            } else {
                // add style_data record
                $q = "INSERT INTO style_data (id, uptodate, category) VALUES " .
                    "(" . $ilDB->quote($this->getId(), "integer") . ", 0," .
                    $ilDB->quote($this->getScope(), "integer") . ")";
                $ilDB->manipulate($q);
                ilObjStyleSheet::_createImagesDirectory($this->getId());
            }
        } else {
            // get style parameter records
            $def = array();
            $q = "SELECT * FROM style_parameter WHERE style_id = " .
                $ilDB->quote($a_from_style, "integer");
            $par_set = $ilDB->query($q);
            while ($par_rec = $ilDB->fetchAssoc($par_set)) {
                $def[] = array("tag" => $par_rec["tag"], "class" => $par_rec["class"],
                    "parameter" => $par_rec["parameter"], "value" => $par_rec["value"],
                    "type" => $par_rec["type"], "mq_id" => $par_rec["mq_id"], "custom" => $par_rec["custom"]);
            }

            $char_repo = $this->repo->characteristic();
            $char_repo->cloneAllFromStyle($a_from_style, $this->getId());


            // copy media queries
            $from_style = new ilObjStyleSheet($a_from_style);
            $mqs = $from_style->getMediaQueries();
            $mq_mapping = array();
            foreach ($mqs as $mq) {
                $nid = $this->addMediaQuery($mq["mquery"]);
                $mq_mapping[$mq["id"]] = $nid;
            }

            // default style settings
            foreach ($def as $sty) {
                $id = $ilDB->nextId("style_parameter");
                $q = "INSERT INTO style_parameter (id, style_id, tag, class, parameter, value, type, mq_id, custom) VALUES " .
                    "(" .
                    $ilDB->quote($id, "integer") . "," .
                    $ilDB->quote($this->getId(), "integer") . "," .
                    $ilDB->quote($sty["tag"], "text") . "," .
                    $ilDB->quote($sty["class"], "text") . "," .
                    $ilDB->quote($sty["parameter"], "text") . "," .
                    $ilDB->quote($sty["value"], "text") . "," .
                    $ilDB->quote($sty["type"], "text") . "," .
                    $ilDB->quote((int) ($mq_mapping[$sty["mq_id"]] ?? 0), "integer") . "," .
                    $ilDB->quote($sty["custom"], "integer") .
                    ")";
                $ilDB->manipulate($q);
            }

            // add style_data record
            $q = "INSERT INTO style_data (id, uptodate, category) VALUES " .
                "(" . $ilDB->quote($this->getId(), "integer") . ", 0," .
                $ilDB->quote($this->getScope(), "integer") . ")";
            $ilDB->manipulate($q);

            // copy images
            $this->createImagesDirectory();
            ilFileUtils::rCopy(
                $from_style->getImagesDirectory(),
                $this->getImagesDirectory()
            );

            // copy colors
            $colors = $from_style->getColors();
            foreach ($colors as $c) {
                $color_manager->addColor($c["name"], $c["code"]);
            }

            // copy templates
            $tcts = ilObjStyleSheet::_getTemplateClassTypes();
            foreach ($tcts as $tct => $v) {
                $templates = $from_style->getTemplates($tct);
                foreach ($templates as $t) {
                    $this->addTemplate($tct, $t["name"], $t["classes"]);
                }
            }
        }

        $this->read();
        if (!$a_import_mode) {
            $this->writeCSSFile();
        }

        return $id;
    }

Here is the call graph for this function:

createExportDirectory()

ilObjStyleSheet::createExportDirectory

(

)

Definition at line 1707 of file class.ilObjStyleSheet.php.

References ilFileUtils\getDataDir(), ilObject\getId(), and ilFileUtils\makeDir().

Referenced by createExportSubDirectory(), and export().

                                           : string
    {
        $sty_data_dir = ilFileUtils::getDataDir() . "/sty";
        ilFileUtils::makeDir($sty_data_dir);
        if (!is_writable($sty_data_dir)) {
            $this->ilias->raiseError("Style data directory (" . $sty_data_dir
                . ") not writeable.", $this->ilias->error_obj->FATAL);
        }

        $style_dir = $sty_data_dir . "/sty_" . $this->getId();
        ilFileUtils::makeDir($style_dir);
        if (!is_dir($style_dir)) {
            $this->ilias->raiseError("Creation of style directory failed (" .
                $style_dir . ").", $this->ilias->error_obj->FATAL);
        }

        // create export subdirectory
        $ex_dir = $style_dir . "/export";
        ilFileUtils::makeDir($ex_dir);
        if (!is_dir($ex_dir)) {
            $this->ilias->raiseError("Creation of Import Directory failed (" .
                $ex_dir . ").", $this->ilias->error_obj->FATAL);
        }

        return $ex_dir;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createExportSubDirectory()

ilObjStyleSheet::createExportSubDirectory

(

)

Definition at line 1746 of file class.ilObjStyleSheet.php.

References createExportDirectory(), getExportSubDir(), and ilFileUtils\makeDir().

Referenced by export().

    {
        $ex_dir = $this->createExportDirectory();
        $ex_sub_dir = $ex_dir . "/" . $this->getExportSubDir();
        ilFileUtils::makeDir($ex_sub_dir);
        if (!is_writable($ex_sub_dir)) {
            $this->ilias->raiseError("Style data directory (" . $ex_sub_dir
                . ") not writeable.", $this->ilias->error_obj->FATAL);
        }
        $ex_sub_images_dir = $ex_sub_dir . "/images";
        ilFileUtils::makeDir($ex_sub_images_dir);
        if (!is_writable($ex_sub_images_dir)) {
            $this->ilias->raiseError("Style data directory (" . $ex_sub_images_dir
                . ") not writeable.", $this->ilias->error_obj->FATAL);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createFromXMLFile()

ilObjStyleSheet::createFromXMLFile	(	string	$a_file,
		bool	$a_skip_parent_create = false
	)

create style from xml file todo: add mq_id and custom

Definition at line 1924 of file class.ilObjStyleSheet.php.

References ilObject\$db, ilObject\$id, $ilDB, do_3_10_Migration(), ilObject\getId(), read(), ilStr\subStr(), and update().

Referenced by create(), and import().

     : void {
        $ilDB = $this->db;

        $this->is_3_10_skin = false;

        if (!$a_skip_parent_create) {
            parent::create();
        }
        $importParser = new ilStyleImportParser($a_file, $this);
        $importParser->startParsing();

        // store style parameter
        foreach ($this->style as $style) {
            foreach ($style as $tag) {
                $id = $ilDB->nextId("style_parameter");

                // migrate old table PageFrame/PageContainer to div
                if (in_array($tag["class"], array("PageFrame", "PageContainer")) &&
                    $tag["tag"] == "table") {
                    $tag["tag"] = "div";
                    if ($tag["parameter"] == "width" && $tag["value"] == "100%") {
                        continue;
                    }
                }

                $q = "INSERT INTO style_parameter (id,style_id, tag, class, parameter, type, value, custom) VALUES " .
                    "(" .
                    $ilDB->quote($id, "integer") . "," .
                    $ilDB->quote($this->getId(), "integer") . "," .
                    $ilDB->quote($tag["tag"], "text") . "," .
                    $ilDB->quote($tag["class"], "text") . "," .
                    $ilDB->quote($tag["parameter"], "text") . "," .
                    $ilDB->quote($tag["type"], "text") . "," .
                    $ilDB->quote($tag["value"], "text") . "," .
                    $ilDB->quote((bool) $tag["custom"], "integer") .
                    ")";
                $ilDB->manipulate($q);
            }
        }

        // store characteristics
        $this->is_3_10_skin = true;
        foreach ($this->chars as $char) {
            if ($char["type"] != "") {
                $s = substr($char["class"], strlen($char["class"]) - 6);
                if ($s != ":hover") {
                    $ilDB->replace(
                        "style_char",
                        array(
                            "style_id" => array("integer", $this->getId()),
                            "type" => array("text", $char["type"]),
                            "characteristic" => array("text", ilStr::subStr($char["class"], 0, 30))),
                        array("hide" => array("integer", 0))
                    );
                    $this->is_3_10_skin = false;
                }
            }
        }

        // add style_data record
        $q = "INSERT INTO style_data (id, uptodate) VALUES " .
            "(" . $ilDB->quote($this->getId(), "integer") . ", 0)";
        $ilDB->manipulate($q);

        $this->update();
        $this->read();

        if ($this->is_3_10_skin) {
            $this->do_3_10_Migration();
        }
        //$this->writeCSSFile();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createImagesDirectory()

ilObjStyleSheet::createImagesDirectory

(

)

Create images directory <data_dir>/sty/sty_<id>/images.

Definition at line 1093 of file class.ilObjStyleSheet.php.

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

Referenced by create(), and import().

                                           : void
    {
        ilObjStyleSheet::_createImagesDirectory($this->getId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createImportDirectory()

ilObjStyleSheet::createImportDirectory

(

)

Definition at line 1834 of file class.ilObjStyleSheet.php.

References ilFileUtils\getDataDir(), ilObject\getId(), and ilFileUtils\makeDir().

Referenced by import().

                                           : string
    {
        $sty_data_dir = ilFileUtils::getDataDir() . "/sty";
        ilFileUtils::makeDir($sty_data_dir);
        if (!is_writable($sty_data_dir)) {
            $this->ilias->raiseError("Style data directory (" . $sty_data_dir
                . ") not writeable.", $this->ilias->error_obj->FATAL);
        }

        $style_dir = $sty_data_dir . "/sty_" . $this->getId();
        ilFileUtils::makeDir($style_dir);
        if (!is_dir($style_dir)) {
            $this->ilias->raiseError("Creation of style directory failed (" .
                $style_dir . ").", $this->ilias->error_obj->FATAL);
        }

        // create import subdirectory
        $im_dir = $style_dir . "/import";
        ilFileUtils::makeDir($im_dir);
        if (!is_dir($im_dir)) {
            $this->ilias->raiseError("Creation of Import Directory failed (" .
                $im_dir . ").", $this->ilias->error_obj->FATAL);
        }

        return $im_dir;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilObjStyleSheet::delete

(

)

Definition at line 1220 of file class.ilObjStyleSheet.php.

References ilObject\$db, $ilDB, ilObjContentObject\_deleteStyleAssignments(), ilObject\getId(), and ilFileUtils\getWebspaceDir().

                            : bool
    {
        $ilDB = $this->db;

        // delete object
        parent::delete();

        // check whether this style is global default
        $def_style = $this->ilias->getSetting("default_content_style_id");
        if ($def_style == $this->getId()) {
            $this->ilias->deleteSetting("default_content_style_id");
        }

        // check whether this style is global fixed
        $fixed_style = $this->ilias->getSetting("fixed_content_style_id");
        if ($fixed_style == $this->getId()) {
            $this->ilias->deleteSetting("fixed_content_style_id");
        }

        // delete style parameter
        $q = "DELETE FROM style_parameter WHERE style_id = " .
            $ilDB->quote($this->getId(), "integer");
        $ilDB->manipulate($q);

        // delete style file
        $css_file_name = ilFileUtils::getWebspaceDir() . "/css/style_" . $this->getId() . ".css";
        if (is_file($css_file_name)) {
            unlink($css_file_name);
        }

        // delete media queries
        $ilDB->manipulate(
            "DELETE FROM sty_media_query WHERE " .
            " style_id = " . $ilDB->quote($this->getId(), "integer")
        );

        // delete entries in learning modules
        ilObjContentObject::_deleteStyleAssignments($this->getId());

        // delete style data record
        $q = "DELETE FROM style_data WHERE id = " .
            $ilDB->quote($this->getId(), "integer");
        $ilDB->manipulate($q);

        return true;
    }

Here is the call graph for this function:

deleteCustomStylePars()

ilObjStyleSheet::deleteCustomStylePars	(	string	$a_tag,
		string	$a_class,
		string	$a_type,
		int	$a_mq_id = 0
	)

Delete style parameter by tag/class/parameter.

Parameters

string	$a_tag	tag
string	$a_class	class
string	$a_type	type
int	$a_mq_id	media query id

Definition at line 1183 of file class.ilObjStyleSheet.php.

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

     : void {
        $ilDB = $this->db;

        $q = "DELETE FROM style_parameter WHERE " .
            " style_id = " . $ilDB->quote($this->getId(), "integer") . " AND " .
            " tag = " . $ilDB->quote($a_tag, "text") . " AND " .
            " class = " . $ilDB->quote($a_class, "text") . " AND " .
            " mq_id = " . $ilDB->quote($a_mq_id, "integer") . " AND " .
            " custom = " . $ilDB->quote(1, "integer") . " AND " .
            " " . $ilDB->equals("type", $a_type, "text", true);

        $ilDB->manipulate($q);
    }

Here is the call graph for this function:

deleteMediaQuery()

ilObjStyleSheet::deleteMediaQuery

(

int

$a_id

)

Delete media query.

Parameters

int

$a_id

media query id

Definition at line 2823 of file class.ilObjStyleSheet.php.

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

     : void {
        $ilDB = $this->db;

        $ilDB->manipulate(
            "DELETE FROM sty_media_query WHERE " .
            " style_id = " . $ilDB->quote($this->getId(), "integer") .
            " AND id = " . $ilDB->quote($a_id, "integer")
        );
        $this->saveMediaQueryOrder();
    }

Here is the call graph for this function:

deleteParameter()

ilObjStyleSheet::deleteParameter

(

int

$a_id

)

delete style parameter

Definition at line 1166 of file class.ilObjStyleSheet.php.

References ilObject\$db, and $ilDB.

                                              : void
    {
        $ilDB = $this->db;

        $q = "DELETE FROM style_parameter WHERE id = " .
            $ilDB->quote($a_id, "integer");
        $ilDB->query($q);
    }

deleteStyleParOfChar()

ilObjStyleSheet::deleteStyleParOfChar	(	string	$a_type,
		string	$a_class
	)

Delete style parameters of characteristic.

Definition at line 1205 of file class.ilObjStyleSheet.php.

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

     : void {
        $ilDB = $this->db;

        $q = "DELETE FROM style_parameter WHERE " .
            " style_id = " . $ilDB->quote($this->getId(), "integer") . " AND " .
            " class = " . $ilDB->quote($a_class, "text") . " AND " .
            " " . $ilDB->equals("type", $a_type, "text", true);

        $ilDB->manipulate($q);
    }

Here is the call graph for this function:

determineTemplateStyleClassType()

ilObjStyleSheet::determineTemplateStyleClassType	(	string	$t,
		string	$k
	)

Definition at line 2134 of file class.ilObjStyleSheet.php.

     : string {
        return self::$templates[$t][$k];
    }

do_3_10_CharMigration()

ilObjStyleSheet::do_3_10_CharMigration

(

int

$a_id = 0

)

This is more or less a copy of Services/Migration/DBUpdate_1385/classes ilStyleMigration->addMissingStyleCharacteristics() Any changes here may also be interesting there.

Definition at line 2322 of file class.ilObjStyleSheet.php.

References ilObject\$db, and $ilDB.

Referenced by do_3_10_Migration().

                                                        : void
    {
        $ilDB = $this->db;

        $add_str = "";
        if ($a_id > 0) {
            $add_str = " AND style_id = " . $ilDB->quote($a_id, "integer");
        }

        $set = $ilDB->query($q = "SELECT DISTINCT style_id, tag, class FROM style_parameter WHERE " .
            $ilDB->equals("type", "", "text", true) . " " . $add_str);

        while ($rec = $ilDB->fetchAssoc($set)) {
            // derive types from tag
            $types = array();
            switch ($rec["tag"]) {
                case "div":
                case "p":
                    if (in_array($rec["class"], array("Headline3", "Headline1",
                        "Headline2", "TableContent", "List", "Standard", "Remark",
                        "Additional", "Mnemonic", "Citation", "Example"))) {
                        $types[] = "text_block";
                    }
                    if (in_array($rec["class"], array("Block", "Remark",
                        "Additional", "Mnemonic", "Example", "Excursus", "Special"))) {
                        $types[] = "section";
                    }
                    if (in_array($rec["class"], array("Page", "Footnote", "PageTitle", "LMNavigation"))) {
                        $types[] = "page";
                    }
                    break;

                case "td":
                    $types[] = "table_cell";
                    break;

                case "a":
                    if (in_array($rec["class"], array("ExtLink", "IntLink", "FootnoteLink"))) {
                        $types[] = "link";
                    }
                    break;

                case "span":
                    $types[] = "text_inline";
                    break;

                case "table":
                    $types[] = "table";
                    break;
            }

            // check if style_char set exists
            foreach ($types as $t) {
                // check if second type already exists
                $set4 = $ilDB->queryF(
                    "SELECT * FROM style_char " .
                    " WHERE style_id = %s AND type = %s AND characteristic = %s",
                    array("integer", "text", "text"),
                    array($rec["style_id"], $t, $rec["class"])
                );
                if ($rec4 = $ilDB->fetchAssoc($set4)) {
                    // ok
                } else {
                    //echo "<br>1-".$rec["style_id"]."-".$t."-".$rec["class"]."-";
                    $ilDB->manipulateF(
                        "INSERT INTO style_char " .
                        " (style_id, type, characteristic) VALUES " .
                        " (%s,%s,%s) ",
                        array("integer", "text", "text"),
                        array($rec["style_id"], $t, $rec["class"])
                    );
                }
            }

            // update types
            if ($rec["type"] == "") {
                if (count($types) > 0) {
                    $ilDB->manipulateF(
                        "UPDATE style_parameter SET type = %s " .
                        " WHERE style_id = %s AND class = %s AND " . $ilDB->equals("type", "", "text", true),
                        array("text", "integer", "text"),
                        array($types[0], $rec["style_id"], $rec["class"])
                    );
                    //echo "<br>3-".$types[0]."-".$rec["style_id"]."-".$rec["class"]."-";

                    // links extra handling
                    if ($types[0] == "link") {
                        $ilDB->manipulateF(
                            "UPDATE style_parameter SET type = %s " .
                            " WHERE style_id = %s AND (class = %s OR class = %s) AND " . $ilDB->equals("type", "", "text", true),
                            array("text", "integer", "text", "text"),
                            array($types[0], $rec["style_id"], $rec["class"] . ":visited",
                            $rec["class"] . ":hover")
                        );
                    }
                }

                if (count($types) == 2) {
                    // select all records of first type and add second type
                    // records if necessary.
                    $set2 = $ilDB->queryF(
                        "SELECT * FROM style_parameter " .
                        " WHERE style_id = %s AND class = %s AND type = %s",
                        array("integer", "text", "text"),
                        array($rec["style_id"], $rec["class"], $types[0])
                    );
                    while ($rec2 = $ilDB->fetchAssoc($set2)) {
                        // check if second type already exists
                        $set3 = $ilDB->queryF(
                            "SELECT * FROM style_parameter " .
                            " WHERE style_id = %s AND tag = %s AND class = %s AND type = %s AND parameter = %s",
                            array("integer", "text", "text", "text", "text"),
                            array($rec["style_id"], $rec["tag"], $rec["class"], $types[1], $rec["parameter"])
                        );
                        if ($rec3 = $ilDB->fetchAssoc($set3)) {
                            // ok
                        } else {
                            $nid = $ilDB->nextId("style_parameter");
                            $ilDB->manipulateF(
                                "INSERT INTO style_parameter " .
                                " (id, style_id, tag, class, parameter, value, type) VALUES " .
                                " (%s, %s,%s,%s,%s,%s,%s) ",
                                array("integer", "integer", "text", "text", "text", "text", "text"),
                                array($nid, $rec2["style_id"], $rec2["tag"], $rec2["class"],
                                    $rec2["parameter"], $rec2["value"], $types[1])
                            );
                        }
                    }
                }
            }
        }
    }

Here is the caller graph for this function:

do_3_10_Migration()

ilObjStyleSheet::do_3_10_Migration

(

)

Migrates 3.10 style to 3.11 style.

Definition at line 2264 of file class.ilObjStyleSheet.php.

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

Referenced by createFromXMLFile().

                                       : void
    {
        $ilDB = $this->db;

        $this->do_3_9_Migration($this->getId());

        $this->do_3_10_CharMigration($this->getId());

        // style_char: type for characteristic
        $st = $ilDB->prepareManip("UPDATE style_char SET type = ? WHERE characteristic = ?" .
            " AND style_id = ? ", array("text", "text", "integer"));
        $ilDB->execute($st, array("media_cont", "Media", $this->getId()));
        $ilDB->execute($st, array("media_caption", "MediaCaption", $this->getId()));
        $ilDB->execute($st, array("page_fn", "Footnote", $this->getId()));
        $ilDB->execute($st, array("page_nav", "LMNavigation", $this->getId()));
        $ilDB->execute($st, array("page_title", "PageTitle", $this->getId()));
        $ilDB->execute($st, array("page_cont", "Page", $this->getId()));

        // style_parameter: type for class
        $st = $ilDB->prepareManip("UPDATE style_parameter SET type = ? WHERE class = ?" .
            " AND style_id = ? ", array("text", "text", "integer"));
        $ilDB->execute($st, array("media_cont", "Media", $this->getId()));
        $ilDB->execute($st, array("media_caption", "MediaCaption", $this->getId()));
        $ilDB->execute($st, array("page_fn", "Footnote", $this->getId()));
        $ilDB->execute($st, array("page_nav", "LMNavigation", $this->getId()));
        $ilDB->execute($st, array("page_title", "PageTitle", $this->getId()));
        $ilDB->execute($st, array("table", "Page", $this->getId()));

        $st = $ilDB->prepareManip("UPDATE style_parameter SET tag = ? WHERE class = ?" .
            " AND style_id = ? ", array("text", "text", "integer"));
        $ilDB->execute($st, array("div", "MediaCaption", $this->getId()));

        // style_char: characteristic for characteristic
        $st = $ilDB->prepareManip("UPDATE style_char SET characteristic = ? WHERE characteristic = ?" .
            " AND style_id = ? ", array("text", "text", "integer"));
        $ilDB->execute($st, array("MediaContainer", "Media", $this->getId()));
        $ilDB->execute($st, array("PageContainer", "Page", $this->getId()));

        // style_parameter: class for class
        $st = $ilDB->prepareManip("UPDATE style_parameter SET class = ? WHERE class = ?" .
            " AND style_id = ? ", array("text", "text", "integer"));
        $ilDB->execute($st, array("MediaContainer", "Media", $this->getId()));
        $ilDB->execute($st, array("PageContainer", "Page", $this->getId()));

        // force rewriting of container style
        $st = $ilDB->prepareManip("DELETE FROM style_char WHERE type = ?" .
            " AND style_id = ? ", array("text", "integer"));
        $ilDB->execute($st, array("page_cont", $this->getId()));
        $st = $ilDB->prepareManip("DELETE FROM style_parameter WHERE type = ?" .
            " AND style_id = ? ", array("text", "integer"));
        $ilDB->execute($st, array("page_cont", $this->getId()));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

do_3_9_Migration()

ilObjStyleSheet::do_3_9_Migration

(

int

$a_id

)

Migrate old 3.9 styles.

Definition at line 2458 of file class.ilObjStyleSheet.php.

References ilObject\$db, and $ilDB.

Referenced by do_3_10_Migration().

                                               : void
    {
        $ilDB = $this->db;

        $classes = array("Example", "Additional", "Citation", "Mnemonic", "Remark");
        $pars = array("margin-top", "margin-bottom");

        foreach ($classes as $curr_class) {
            foreach ($pars as $curr_par) {
                $res2 = $ilDB->queryF(
                    "SELECT id FROM style_parameter WHERE style_id = %s" .
                    " AND tag = %s AND class= %s AND parameter = %s",
                    array("integer", "text", "text", "text"),
                    array($a_id, "p", $curr_class, $curr_par)
                );
                if ($row2 = $ilDB->fetchAssoc($res2)) {
                    $ilDB->manipulateF(
                        "UPDATE style_parameter SET value= %s WHERE id = %s",
                        array("text", "integer"),
                        array("10px", $row2["id"])
                    );
                } else {
                    $nid = $ilDB->nextId("style_parameter");
                    $ilDB->manipulateF(
                        "INSERT INTO style_parameter " .
                        "(id, style_id, tag, class, parameter,value) VALUES (%s,%s,%s,%s,%s,%s)",
                        array("integer", "integer", "text", "text", "text", "text"),
                        array($nid, $a_id, "div", $curr_class, $curr_par, "10px")
                    );
                }
            }
        }

        $ilDB->manipulateF(
            "UPDATE style_parameter SET tag = %s WHERE tag = %s and style_id = %s",
            array("text", "text", "integer"),
            array("div", "p", $a_id)
        );
    }

Here is the caller graph for this function:

export()

ilObjStyleSheet::export

(

)

Returns

string local file name of export file

Exceptions

Definition at line 1789 of file class.ilObjStyleSheet.php.

References cleanExportDirectory(), createExportDirectory(), createExportSubDirectory(), exportXML(), getExportSubDir(), getImagesDirectory(), ilFileUtils\rCopy(), and ilFileUtils\zip().

                            : string
    {
        $this->cleanExportDirectory();
        $ex_dir = $this->createExportDirectory();
        $this->createExportSubDirectory();
        $this->exportXML($ex_dir . "/" . $this->getExportSubDir());
        //echo "-".$this->getImagesDirectory()."-".$ex_dir."/".$this->getExportSubDir()."/images"."-";
        ilFileUtils::rCopy(
            $this->getImagesDirectory(),
            $ex_dir . "/" . $this->getExportSubDir() . "/images"
        );
        if (is_file($ex_dir . "/" . $this->getExportSubDir() . ".zip")) {
            unlink($ex_dir . "/" . $this->getExportSubDir() . ".zip");
        }
        ilFileUtils::zip(
            $ex_dir . "/" . $this->getExportSubDir(),
            $ex_dir . "/" . $this->getExportSubDir() . ".zip"
        );

        return $ex_dir . "/" . $this->getExportSubDir() . ".zip";
    }

Here is the call graph for this function:

exportXML()

ilObjStyleSheet::exportXML

(

string

$a_dir

)

export style xml file to directory

Definition at line 1814 of file class.ilObjStyleSheet.php.

References getXML().

Referenced by export().

                                            : void
    {
        $file = $a_dir . "/style.xml";

        // open file
        if (!($fp = fopen($file, 'wb'))) {
            die("<b>Error</b>: Could not open \"" . $file . "\" for writing" .
                    " in <b>" . __FILE__ . "</b> on line <b>" . __LINE__ . "</b><br />");
        }

        // set file permissions
        chmod($file, 0770);

        // write xml data into the file
        fwrite($fp, $this->getXML());

        // close file
        fclose($fp);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAvailableParameters()

static ilObjStyleSheet::getAvailableParameters ( )

static

Definition at line 2146 of file class.ilObjStyleSheet.php.

Referenced by addParameter().

                                                   : array
    {
        $pars = array();
        foreach (self::$parameter as $p => $v) {
            $pars[$p] = $v["values"];
        }

        return $pars;
    }

Here is the caller graph for this function:

getBasicImageDir()

static ilObjStyleSheet::getBasicImageDir ( )

static

Definition at line 769 of file class.ilObjStyleSheet.php.

Referenced by ilCOPageHTMLExport\exportStyles().

                                             : string
    {
        return self::$basic_style_image_dir;
    }

Here is the caller graph for this function:

getBasicZipPath()

static ilObjStyleSheet::getBasicZipPath ( )

static

Definition at line 524 of file class.ilObjStyleSheet.php.

Referenced by ilObjStyleSheetGUI\saveObject().

                                            : string
    {
        return self::$basic_style_zip;
    }

Here is the caller graph for this function:

getCharacteristics()

ilObjStyleSheet::getCharacteristics	(	string	$a_type = "",
		bool	$a_no_hidden = false,
		bool	$a_include_core = true
	)

Get characteristics.

Definition at line 944 of file class.ilObjStyleSheet.php.

References $c, and $chars.

Referenced by ilPCSectionGUI\_getCharacteristics(), and ilPCMediaObjectGUI\_getCharacteristics().

     : array {
        $chars = array();

        if ($a_type == "") {
            $chars = $this->chars;
        }
        if (isset($this->chars_by_type[$a_type])) {
            foreach ($this->chars_by_type[$a_type] as $c) {
                if ($a_include_core || !self::isCoreStyle($a_type, $c)) {
                    $chars[] = $c;
                }
            }
        }

        if ($a_no_hidden) {
            foreach ($chars as $k => $char) {
                if ($a_type == "" && $this->hidden_chars[$char["type"] . ":" . $char["class"]]) {
                    unset($chars[$k]);
                } elseif ($this->hidden_chars[$a_type . ":" . $char] ?? false) {
                    unset($chars[$k]);
                }
            }
        }

        return $chars;
    }

Here is the caller graph for this function:

getColorCodeForName()

ilObjStyleSheet::getColorCodeForName

(

string

$a_name

)

Definition at line 2536 of file class.ilObjStyleSheet.php.

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

Referenced by writeCSSFile().

                                                       : string
    {
        $ilDB = $this->db;
        $a_i = "";
        $pos = strpos($a_name, "(");
        if ($pos > 0) {
            $a_i = substr($a_name, $pos + 1);
            $a_i = str_replace(")", "", $a_i);
            $a_name = substr($a_name, 0, $pos);
        }

        $set = $ilDB->query("SELECT color_code FROM style_color WHERE " .
            " style_id = " . $ilDB->quote($this->getId(), "integer") . " AND " .
            " color_name = " . $ilDB->quote($a_name, "text"));
        if ($rec = $ilDB->fetchAssoc($set)) {
            if ($a_i == "") {
                return "#" . $rec["color_code"];
            } else {
                return "#" . ilObjStyleSheet::_getColorFlavor(
                    $rec["color_code"],
                    (int) $a_i
                );
            }
        }
        return "";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getColors()

ilObjStyleSheet::getColors

(

)

Get colors of style.

Definition at line 2505 of file class.ilObjStyleSheet.php.

References ilObject\$db, and $ilDB.

Referenced by getXML().

                               : array
    {
        $ilDB = $this->db;

        $set = $ilDB->query("SELECT * FROM style_color WHERE " .
            "style_id = " . $ilDB->quote($this->getId(), "integer") . " " .
            "ORDER BY color_name");

        $colors = array();
        while ($rec = $ilDB->fetchAssoc($set)) {
            $colors[] = array(
                "name" => $rec["color_name"],
                "code" => $rec["color_code"]
                );
        }

        return $colors;
    }

Here is the caller graph for this function:

getContentPrintStyle()

static ilObjStyleSheet::getContentPrintStyle ( )

static

Definition at line 1593 of file class.ilObjStyleSheet.php.

Referenced by ilCOPageHTMLExport\exportStyles(), and ILIAS\Export\PrintProcessGUI\renderPrintView().

                                                 : string
    {
        return "./Services/COPage/css/print_content.css";
    }

Here is the caller graph for this function:

getContentStylePath()

static ilObjStyleSheet::getContentStylePath ( int  $a_style_id, bool  $add_random = true, bool  $add_token = true  )

static

get content style path static (to avoid full reading)

Definition at line 1548 of file class.ilObjStyleSheet.php.

References $DIC, $ilSetting, $path, ilObject\_exists(), _lookupUpToDate(), ilFileUtils\getWebspaceDir(), ILIAS\Repository\int(), and ilWACSignedPath\signFile().

Referenced by ilDclDetailedViewDefinitionGUI\__construct(), ilImprintGUI\__construct(), ilPageLayoutGUI\__construct(), ilPortfolioPageGUI\__construct(), ilBlogPostingGUI\__construct(), ilDclDetailedViewGUI\__construct(), ilAssQuestionPreviewGUI\__construct(), ILIAS\Style\Content\GUIService\addCss(), ilPageObjectGUI\displayMedia(), assOrderingQuestionGUI\editNesting(), ilLOEditorGUI\executeCommand(), ilObjGroupGUI\executeCommand(), ilAssQuestionHintsGUI\executeCommand(), ilObjTestGUI\executeCommand(), ilCOPageHTMLExport\exportStyles(), ilAssQuestionPageCommandForwarder\forward(), ilAuthLoginPageEditorGUI\forwardToPageObject(), ILIAS\COPage\Editor\Components\Page\PageQueryActionHandler\getConfig(), ILIAS\Portfolio\Export\PortfolioHtmlExport\getInitialisedTemplate(), ILIAS\Blog\Export\BlogHtmlExport\getInitialisedTemplate(), ilCOPageHTMLExport\getPreparedMainTemplate(), ilObjQuestionPoolGUI\getQueryParamInt(), ilObjStyleSheetGUI\includeCSS(), ilCOPageHTMLExport\initResourceTemplate(), ILIAS\Glossary\Export\GlossaryHtmlExport\initScreen(), ilAssQuestionPreviewGUI\initStyleSheets(), ilGlossaryPresentationGUI\media(), ilTestServiceGUI\outCorrectSolution(), ilTestPlayerAbstractGUI\outCorrectSolution(), ilStyleCharacteristicGUI\outputTagStyleEditScreen(), ilTestPlayerAbstractGUI\populateContentStyleBlock(), ilObjStyleSheetGUI\propertiesObject(), ILIAS\Export\PrintProcessGUI\renderPrintView(), ilPCParagraphGUI\setStyle(), ilStartUpGUI\showLoginPage(), ilObjMediaPoolGUI\showMedia(), ilObjMediaPoolGUI\showPage(), and ilTestCorrectionsGUI\showSolution().

     : string {
        global $DIC;

        $ilSetting = $DIC->settings();

        $random = new \ilRandom();
        $rand = $random->int(1, 999999);


        // check global fixed content style
        $fixed_style = $ilSetting->get("fixed_content_style_id");
        if ($fixed_style > 0) {
            $a_style_id = (int) $fixed_style;
        }

        // check global default style
        if ($a_style_id <= 0) {
            $a_style_id = (int) $ilSetting->get("default_content_style_id");
        }

        if ($a_style_id > 0 && ilObject::_exists($a_style_id)) {
            // check whether file is up to date
            if (!ilObjStyleSheet::_lookupUpToDate($a_style_id)) {
                $style = new ilObjStyleSheet($a_style_id);
                $style->writeCSSFile();
            }

            $path = ilFileUtils::getWebspaceDir("output") . "/css/style_" . $a_style_id . ".css";
            if ($add_random) {
                $path .= "?dummy=$rand";
            }
            if ($add_token) {
                $path = ilWACSignedPath::signFile($path);
            }

            return $path;
        } else {                // todo: work this out
            return "./Services/COPage/css/content.css";
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getEffectiveContentStyleId()

static ilObjStyleSheet::getEffectiveContentStyleId ( int  $a_style_id )

static

Get effective Style Id.

Parameters

int	style id that may be set in object
string	object type

Definition at line 1508 of file class.ilObjStyleSheet.php.

References $DIC, $ilSetting, ilObject\_lookupType(), and ILIAS\Repository\int().

     : int {
        global $DIC;

        $ilSetting = $DIC->settings();

        // check global fixed content style
        $fixed_style = $ilSetting->get("fixed_content_style_id");
        if ($fixed_style > 0) {
            $a_style_id = (int) $fixed_style;
        }

        // check global default style
        if ($a_style_id <= 0) {
            $a_style_id = (int) $ilSetting->get("default_content_style_id");
        }

        if ($a_style_id > 0 && ilObject::_lookupType($a_style_id) === "sty") {
            return $a_style_id;
        }

        return 0;
    }

Here is the call graph for this function:

getExportSubDir()

ilObjStyleSheet::getExportSubDir

(

)

The local directory, that will be included within the zip file.

Definition at line 1774 of file class.ilObjStyleSheet.php.

References $export_sub_dir, and ilObject\getId().

Referenced by createExportSubDirectory(), and export().

                                     : string
    {
        if ($this->export_sub_dir == "") {
            return "sty_" . $this->getId();
        } else {
            return $this->export_sub_dir;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getHideStatus()

ilObjStyleSheet::getHideStatus	(	string	$a_type,
		string	$a_char
	)

Get characteristic hidden status.

Definition at line 1002 of file class.ilObjStyleSheet.php.

References ilObject\$db, and $ilDB.

     : bool {
        $ilDB = $this->db;

        $set = $ilDB->query(
            "SELECT hide FROM  style_char " .
            " WHERE style_id = " . $ilDB->quote($this->getId(), "integer") . " AND " .
            " type = " . $ilDB->quote($a_type, "text") . " AND " .
            " characteristic = " . $ilDB->quote($a_char, "text")
        );
        $rec = $ilDB->fetchAssoc($set);

        return (bool) ($rec["hide"] ?? false);
    }

getImagesDirectory()

ilObjStyleSheet::getImagesDirectory

(

)

Definition at line 1146 of file class.ilObjStyleSheet.php.

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

Referenced by copyImagesToDir(), create(), export(), getThumbnailsDirectory(), and import().

                                        : string
    {
        return ilObjStyleSheet::_getImagesDirectory($this->getId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMaxMQueryOrderNr()

ilObjStyleSheet::getMaxMQueryOrderNr

(

)

Get maximum media query order nr.

Definition at line 2774 of file class.ilObjStyleSheet.php.

References ilObject\$db, and $ilDB.

Referenced by addMediaQuery().

                                         : int
    {
        $ilDB = $this->db;

        $set = $ilDB->query(
            "SELECT max(order_nr) mnr FROM sty_media_query " .
            " WHERE style_id = " . $ilDB->quote($this->getId(), "integer")
        );
        $rec = $ilDB->fetchAssoc($set);

        return (int) $rec["mnr"];
    }

Here is the caller graph for this function:

getMediaQueries()

ilObjStyleSheet::getMediaQueries

(

)

Definition at line 2733 of file class.ilObjStyleSheet.php.

References ilObject\$db, and $ilDB.

Referenced by saveMediaQueryOrder(), and writeCSSFile().

                                     : array
    {
        $ilDB = $this->db;

        $set = $ilDB->query("SELECT * FROM sty_media_query WHERE " .
            "style_id = " . $ilDB->quote($this->getId(), "integer") . " " .
            "ORDER BY order_nr");

        $mq = array();
        while ($rec = $ilDB->fetchAssoc($set)) {
            $mq[] = $rec;
        }

        return $mq;
    }

Here is the caller graph for this function:

getMediaQueryForId()

ilObjStyleSheet::getMediaQueryForId

(

int

$a_id

)

Get media query for id.

Parameters

Definition at line 2806 of file class.ilObjStyleSheet.php.

References ilObject\$db, and $ilDB.

     : array {
        $ilDB = $this->db;

        $set = $ilDB->query(
            "SELECT * FROM sty_media_query " .
            " WHERE id = " . $ilDB->quote($a_id, "integer")
        );
        return $ilDB->fetchAssoc($set);
    }

getParametersOfClass()

ilObjStyleSheet::getParametersOfClass	(	string	$a_type,
		string	$a_class,
		int	$a_mq_id = 0
	)

Definition at line 1533 of file class.ilObjStyleSheet.php.

     : array {
        if (is_array($this->style_class[$a_type][$a_class][$a_mq_id])) {
            return $this->style_class[$a_type][$a_class][$a_mq_id];
        }
        return array();
    }

getPlaceHolderStylePath()

static ilObjStyleSheet::getPlaceHolderStylePath ( )

static

Definition at line 1603 of file class.ilObjStyleSheet.php.

Referenced by ilPageLayoutGUI\__construct(), ilPortfolioPageGUI\__construct(), ilPCPlaceHolder\getCssFiles(), ilPortfolioTemplatePageGUI\showPage(), and ilPageObjectGUI\showPage().

                                                    : string
    {
        return "./Services/COPage/css/placeholder.css";
    }

Here is the caller graph for this function:

getScope()

ilObjStyleSheet::getScope

(

)

Definition at line 547 of file class.ilObjStyleSheet.php.

References $scope.

Referenced by create(), and update().

                              : int
    {
        return $this->scope;
    }

Here is the caller graph for this function:

getStyle()

ilObjStyleSheet::getStyle

(

)

Definition at line 1639 of file class.ilObjStyleSheet.php.

References $style.

Referenced by writeCSSFile().

                              : array
    {
        return $this->style;
    }

Here is the caller graph for this function:

getStyleParameterGroups()

ilObjStyleSheet::getStyleParameterGroups

(

)

Get grouped parameter.

Definition at line 2003 of file class.ilObjStyleSheet.php.

References $parameter.

                                             : array
    {
        $groups = array();

        foreach (self::$parameter as $parameter => $props) {
            $groups[$props["group"]][] = $parameter;
        }
        return $groups;
    }

getSyntaxStylePath()

static ilObjStyleSheet::getSyntaxStylePath ( )

static

Definition at line 1598 of file class.ilObjStyleSheet.php.

Referenced by ilDclDetailedViewDefinitionGUI\__construct(), ilImprintGUI\__construct(), ilPageLayoutGUI\__construct(), ilWikiPageGUI\__construct(), ilPortfolioPageGUI\__construct(), ilBlogPostingGUI\__construct(), ilDclDetailedViewGUI\__construct(), ilAssQuestionPreviewGUI\__construct(), ilGlossaryTermGUI\confirmDefinitionDeletion(), ilObjGlossaryGUI\confirmDefinitionDeletion(), assOrderingQuestionGUI\editNesting(), ilTermDefinitionEditorGUI\executeCommand(), ilObjTestGUI\executeCommand(), ilCOPageHTMLExport\exportStyles(), ilAssQuestionPageCommandForwarder\forward(), ilAuthLoginPageEditorGUI\forwardToPageObject(), ilContainerGUI\forwardToPageObject(), ilContainerGUI\getContainerPageHTML(), ilContainerStartObjectsContentGUI\getPageHTML(), ilCOPageHTMLExport\getPreparedMainTemplate(), ilObjQuestionPoolGUI\getQueryParamInt(), ilObjForumGUI\getSafePostCommands(), ilCOPageHTMLExport\initResourceTemplate(), ilAssQuestionPreviewGUI\initStyleSheets(), ilObjContentPageGUI\initStyleSheets(), ilObjForumGUI\initStyleSheets(), ilGlossaryTermGUI\listDefinitions(), ilLMEditorGUI\main_header(), ilTestServiceGUI\outCorrectSolution(), ilTestPlayerAbstractGUI\outCorrectSolution(), ilTestPlayerAbstractGUI\populateSyntaxStyleBlock(), ilContentPageKioskModeView\renderContentStyle(), ILIAS\Export\PrintProcessGUI\renderPrintView(), ilGlossaryPresentationGUI\setContentStyles(), ilLMPresentationGUI\setContentStyles(), ilObjWikiGUI\setContentStyleSheet(), ilObjContentPageGUI\setTabs(), ilStartUpGUI\showLoginPage(), ilObjMediaPoolGUI\showPage(), and ilTestCorrectionsGUI\showSolution().

                                               : string
    {
        return "./Services/COPage/css/syntaxhighlight.css";
    }

Here is the caller graph for this function:

getTemplate()

ilObjStyleSheet::getTemplate

(

int

$a_t_id

)

Parameters

int

$a_t_id

template id

Definition at line 3012 of file class.ilObjStyleSheet.php.

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

Referenced by ilObjStyleSheetGUI\_getTemplatePreview().

                                            : array
    {
        $ilDB = $this->db;

        $set = $ilDB->query("SELECT * FROM style_template WHERE " .
            "style_id = " . $ilDB->quote($this->getId(), "integer") . " " .
            " AND id = " . $ilDB->quote($a_t_id, "integer"));

        if ($rec = $ilDB->fetchAssoc($set)) {
            $rec["classes"] = $this->getTemplateClasses((int) $rec["id"]);

            $template = $rec;
            return $template;
        }
        return array();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTemplateClasses()

ilObjStyleSheet::getTemplateClasses

(

int

$a_tid

)

Get template classes.

Definition at line 2892 of file class.ilObjStyleSheet.php.

References ilObject\$db, $ilDB, and ILIAS\LTI\ToolProvider\$key.

Referenced by getTemplate(), and getTemplates().

     : array {
        $ilDB = $this->db;
        $set = $ilDB->query("SELECT * FROM style_template_class WHERE " .
            "template_id = " . $ilDB->quote($a_tid, "integer"));

        $class = array();
        while ($rec = $ilDB->fetchAssoc($set)) {
            $key = $rec["class_type"];
            $class[$key] = $rec["class"];
        }

        return $class;
    }

Here is the caller graph for this function:

getTemplates()

ilObjStyleSheet::getTemplates

(

string

$a_type

)

Get table templates of style.

Definition at line 2870 of file class.ilObjStyleSheet.php.

References ilObject\$db, $ilDB, $templates, and getTemplateClasses().

Referenced by ilPageContentGUI\getTemplateOptions(), getTemplateXML(), and getXML().

     : array {
        $ilDB = $this->db;

        $set = $ilDB->query("SELECT * FROM style_template WHERE " .
            "style_id = " . $ilDB->quote($this->getId(), "integer") . " AND " .
            "temp_type = " . $ilDB->quote($a_type, "text") . " " .
            "ORDER BY name");

        $templates = array();
        while ($rec = $ilDB->fetchAssoc($set)) {
            $rec["classes"] = $this->getTemplateClasses((int) $rec["id"]);
            $templates[] = $rec;
        }

        return $templates;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTemplateXML()

ilObjStyleSheet::getTemplateXML

(

)

Get table template xml.

Definition at line 3059 of file class.ilObjStyleSheet.php.

References $c, ilObject\$db, $ilDB, ilObject\$type, _getTemplateClassTypes(), and getTemplates().

Referenced by ilObjStyleSheetGUI\_getTemplatePreview(), ilPCTableGUI\getCellContent(), and ilPCTableGUI\getPropertiesFormValues().

                                    : string
    {
        $ilDB = $this->db;

        $tag = "<StyleTemplates>";

        $ttypes = array("table", "vaccordion", "haccordion", "carousel");

        foreach ($ttypes as $ttype) {
            $ts = $this->getTemplates($ttype);

            foreach ($ts as $t) {
                $atts = ilObjStyleSheet::_getTemplateClassTypes($ttype);
                /*$atts = array("table" => "TableClass",
                    "caption" => "CaptionClass",
                    "row_head" => "RowHeadClass",
                    "row_foot" => "RowFootClass",
                    "col_head" => "ColHeadClass",
                    "col_foot" => "ColFootClass",
                    "odd_row" => "OddRowClass",
                    "even_row" => "EvenRowClass",
                    "odd_col" => "OddColClass",
                    "even_col" => "EvenColClass");*/
                $c = $t["classes"];

                $tag .= '<StyleTemplate Name="' . $t["name"] . '">';

                foreach ($atts as $type => $t2) {
                    if (($c[$type] ?? "") != "") {
                        $tag .= '<StyleClass Type="' . $type . '" Value="' . $c[$type] . '" />';
                    }
                }

                $tag .= "</StyleTemplate>";
            }
        }

        $tag .= "</StyleTemplates>";

        //echo htmlentities($tag);
        return $tag;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getThumbnailsDirectory()

ilObjStyleSheet::getThumbnailsDirectory

(

)

Definition at line 1157 of file class.ilObjStyleSheet.php.

References getImagesDirectory().

                                            : string
    {
        return $this->getImagesDirectory() .
            "/thumbnails";
    }

Here is the call graph for this function:

getUpToDate()

ilObjStyleSheet::getUpToDate

(

)

Definition at line 537 of file class.ilObjStyleSheet.php.

References $up_to_date.

                                 : bool
    {
        return $this->up_to_date;
    }

getXML()

ilObjStyleSheet::getXML

(

)

get xml representation of style object todo: add mq_id

Definition at line 1658 of file class.ilObjStyleSheet.php.

References $c, $xml, _determineTag(), _getTemplateClassTypes(), getColors(), ilObject\getDescription(), getTemplates(), ilObject\getTitle(), and handleXmlString().

Referenced by exportXML().

                            : string
    {
        $xml = "<StyleSheet>\n";

        // title and description
        $xml .= "<Title>" . $this->handleXmlString($this->getTitle()) . "</Title>";
        $xml .= "<Description>" . $this->handleXmlString($this->getDescription()) . "</Description>\n";

        // style classes
        foreach ($this->chars as $char) {
            $xml .= "<Style Tag=\"" . ilObjStyleSheet::_determineTag($char["type"]) .
                "\" Type=\"" . $char["type"] . "\" Class=\"" . $char["class"] . "\">\n";
            foreach ($this->style as $style) {
                if ($style[0]["type"] == $char["type"] && $style[0]["class"] == $char["class"]) {
                    foreach ($style as $tag) {
                        $xml .= "<StyleParameter Name=\"" . $tag["parameter"] . "\" Value=\"" . $tag["value"] . "\" Custom=\"" . $tag["custom"] . "\" />\n";
                    }
                }
            }
            $xml .= "</Style>\n";
        }

        // colors
        foreach ($this->getColors() as $color) {
            $xml .= "<StyleColor Name=\"" . $color["name"] . "\" Code=\"" . $color["code"] . "\"/>\n";
        }

        // templates
        $tcts = ilObjStyleSheet::_getTemplateClassTypes();
        foreach ($tcts as $tct => $v) {
            $ts = $this->getTemplates($tct);

            foreach ($ts as $t) {
                $xml .= "<StyleTemplate Type=\"" . $tct . "\" Name=\"" . $t["name"] . "\">\n";
                foreach ($t["classes"] as $ct => $c) {
                    if ($c != "") {
                        $xml .= "<StyleTemplateClass ClassType=\"" . $ct . "\" Class=\"" . $c . "\"/>\n";
                    }
                }
                $xml .= "</StyleTemplate>\n";
            }
        }


        $xml .= "</StyleSheet>";
        //echo "<pre>".htmlentities($xml)."</pre>"; exit;
        return $xml;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

handleXmlString()

ilObjStyleSheet::handleXmlString

(

string

$a_str

)

Definition at line 1649 of file class.ilObjStyleSheet.php.

Referenced by getXML().

                                                  : string
    {
        return str_replace("&", "&", $a_str);
    }

Here is the caller graph for this function:

hexdec()

static ilObjStyleSheet::hexdec ( string  $hex )

staticprotected

Definition at line 2608 of file class.ilObjStyleSheet.php.

                                                 : int
    {
        $hex = preg_replace("/[^a-fA-F0-9]+/", "", $hex);
        if ($hex === "") {
            $hex = "0";
        }
        return (int) hexdec($hex);
    }

ilClone()

ilObjStyleSheet::ilClone

(

)

clone style sheet (note: styles have no ref ids and return an object id)

Definition at line 1022 of file class.ilObjStyleSheet.php.

References ilObject\$lng, ilObject\getDescription(), ilObject\getId(), ilObject\getTitle(), ilObject\getType(), ilLanguage\loadLanguageModule(), lookupStyleSetting(), and ilLanguage\txt().

                             : int
    {
        $lng = $this->lng;

        $lng->loadLanguageModule("style");

        $new_obj = new ilObjStyleSheet();
        $new_obj->setTitle($this->getTitle() . " (" . $lng->txt("sty_acopy") . ")");
        $new_obj->setType($this->getType());
        $new_obj->setDescription($this->getDescription());
        $new_obj->create($this->getId());

        $new_obj->writeStyleSetting(
            "disable_auto_margins",
            $this->lookupStyleSetting("disable_auto_margins")
        );

        return $new_obj->getId();
    }

Here is the call graph for this function:

import()

ilObjStyleSheet::import

(

$a_file

)

Parameters

array | string

$a_file

Exceptions

Definition at line 1868 of file class.ilObjStyleSheet.php.

References _addMissingStyleClassesToStyle(), createFromXMLFile(), createImagesDirectory(), createImportDirectory(), ilObject\getId(), getImagesDirectory(), ilFileUtils\moveUploadedFile(), ilFileUtils\rCopy(), read(), ilFileUtils\unzip(), and writeCSSFile().

                                   : void
    {
        parent::create();

        $subdir = "";
        $im_dir = $this->createImportDirectory();

        // handle uploaded files
        if (is_array($a_file)) {
            ilFileUtils::moveUploadedFile(
                $a_file["tmp_name"],
                $a_file["name"],
                $im_dir . "/" . $a_file["name"]
            );
            $file_name = $a_file["name"];
        } else {        // handle not directly uploaded files
            $pi = pathinfo($a_file);
            $file_name = $pi["basename"];
            copy($a_file, $im_dir . "/" . $file_name);
        }
        $file = pathinfo($file_name);

        // unzip file
        if (strtolower($file["extension"]) == "zip") {
            ilFileUtils::unzip($im_dir . "/" . $file_name);
            $subdir = basename($file["basename"], "." . $file["extension"]);
            if (!is_dir($im_dir . "/" . $subdir)) {
                $subdir = "style";                              // check style subdir
            }
            $xml_file = $im_dir . "/" . $subdir . "/style.xml";
        } else {        // handle xml file directly (old style)
            $xml_file = $im_dir . "/" . $file_name;
        }

        // load information from xml file
        //echo "-$xml_file-";
        $this->createFromXMLFile($xml_file, true);

        // copy images
        $this->createImagesDirectory();
        if (is_dir($im_dir . "/" . $subdir . "/images")) {
            ilFileUtils::rCopy(
                $im_dir . "/" . $subdir . "/images",
                $this->getImagesDirectory()
            );
        }

        ilObjStyleSheet::_addMissingStyleClassesToStyle($this->getId());
        $this->read();
        $this->writeCSSFile();
    }

Here is the call graph for this function:

isCoreStyle()

static ilObjStyleSheet::isCoreStyle ( string  $a_type, string  $a_class  )

static

Definition at line 2103 of file class.ilObjStyleSheet.php.

Referenced by ILIAS\Style\Content\CharacteristicTableGUI\fillRow(), ilStyleCharacteristicGUI\removeOutdated(), and ilStyleCharacteristicGUI\setOutdated().

     : bool {
        foreach (self::$core_styles as $s) {
            if ($s["type"] == $a_type && $s["class"] == $a_class) {
                return true;
            }
        }
        return false;
    }

Here is the caller graph for this function:

lookupObjectForStyle()

static ilObjStyleSheet::lookupObjectForStyle ( int  $a_style_id )

static

Lookup objects for style.

Returns

int[]

Definition at line 3265 of file class.ilObjStyleSheet.php.

References $DIC, $ilDB, ilObject\_lookupType(), and ILIAS\Repository\int().

     : array {
        global $DIC;

        $ilDB = $DIC->database();

        $obj_ids = array();
        if (ilObject::_lookupType($a_style_id) == "sty") {
            $set = $ilDB->query(
                "SELECT DISTINCT obj_id FROM style_usage " .
                " WHERE style_id = " . $ilDB->quote($a_style_id, "integer")
            );

            while ($rec = $ilDB->fetchAssoc($set)) {
                $obj_ids[] = (int) $rec["obj_id"];
            }
        }
        return $obj_ids;
    }

Here is the call graph for this function:

lookupObjectStyle()

static ilObjStyleSheet::lookupObjectStyle ( int  $a_obj_id )

static

Lookup object style.

Definition at line 3238 of file class.ilObjStyleSheet.php.

References $DIC, $ilDB, and ilObject\_lookupType().

Referenced by ilStyleDataSet\getDependencies(), ILIAS\Style\Content\Object\ObjectManager\getStyleId(), ILIAS\Style\Content\Object\ObjectManager\inheritFromParent(), and ilContainerXmlWriter\writeSubitems().

     : int {
        global $DIC;

        $ilDB = $DIC->database();

        $set = $ilDB->query(
            "SELECT style_id FROM style_usage " .
            " WHERE obj_id = " . $ilDB->quote($a_obj_id, "integer")
        );
        $rec = $ilDB->fetchAssoc($set);
        if (!is_array($rec)) {
            return 0;
        }

        if (ilObject::_lookupType((int) $rec["style_id"]) == "sty") {
            return (int) $rec["style_id"];
        }

        return 0;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

lookupStyleSetting()

ilObjStyleSheet::lookupStyleSetting

(

string

$a_name

)

Lookup style setting.

Definition at line 3201 of file class.ilObjStyleSheet.php.

References ilObject\$db, and $ilDB.

Referenced by ilClone().

                                                      : string
    {
        $ilDB = $this->db;

        $set = $ilDB->query(
            "SELECT value FROM style_setting " .
            " WHERE style_id = " . $ilDB->quote($this->getId(), "integer") .
            " AND name = " . $ilDB->quote($a_name, "text")
        );
        $rec = $ilDB->fetchAssoc($set);

        return $rec["value"] ?? '';
    }

Here is the caller graph for this function:

lookupTemplateName()

ilObjStyleSheet::lookupTemplateName

(

int

$a_t_id

)

Lookup table template name for template ID.

Definition at line 3032 of file class.ilObjStyleSheet.php.

Referenced by ilObjStyleSheetGUI\_getTemplatePreview().

                                                   : string
    {
        return self::_lookupTemplateName($a_t_id);
    }

Here is the caller graph for this function:

lookupTemplatePreview()

ilObjStyleSheet::lookupTemplatePreview

(

int

$a_t_id

)

Lookup table template preview.

Definition at line 3127 of file class.ilObjStyleSheet.php.

References ilObject\$db, and $ilDB.

                                                      : string
    {
        $ilDB = $this->db;

        $set = $ilDB->query("SELECT preview FROM style_template " .
            " WHERE id = " . $ilDB->quote($a_t_id, "integer"));
        if ($rec = $ilDB->fetchAssoc($set)) {
            return $rec["preview"] ?? "";
        }

        return "";
    }

read()

ilObjStyleSheet::read

(

)

read style properties

Definition at line 1271 of file class.ilObjStyleSheet.php.

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

Referenced by addParameter(), create(), createFromXMLFile(), import(), and update().

                          : void
    {
        $ilDB = $this->db;

        parent::read();

        $q = "SELECT * FROM style_parameter WHERE style_id = " .
            $ilDB->quote($this->getId(), "integer") . " ORDER BY tag, class, type, mq_id ";
        $style_set = $ilDB->query($q);
        $ctag = "";
        $cclass = "";
        $ctype = "";
        $cmq_id = 0;
        $this->style = array();
        // workaround for bug #17586, see also http://stackoverflow.com/questions/3066356/multiple-css-classes-properties-overlapping-based-on-the-order-defined
        // e.g. ha_iheada must be written after ha_ihead, since they are acting on the same dom node
        // styles that must be added at the end
        $this->end_styles = array();
        $tag = null;
        while ($style_rec = $ilDB->fetchAssoc($style_set)) {
            if ($style_rec["tag"] != $ctag || $style_rec["class"] != $cclass
                || $style_rec["type"] != $ctype || $style_rec["mq_id"] != $cmq_id) {
                // add current tag array to style array
                if (is_array($tag)) {
                    if (in_array($ctype, array("ha_iheada", "va_iheada"))) {
                        $this->end_styles[] = $tag;
                    } else {
                        $this->style[] = $tag;
                    }
                }
                $tag = array();
            }
            $ctag = $style_rec["tag"];
            $cclass = $style_rec["class"];
            $ctype = $style_rec["type"];
            $cmq_id = $style_rec["mq_id"];
            $tag[] = $style_rec;
            // added $cmq_id
            $this->style_class[$ctype][$cclass][$cmq_id][$style_rec["parameter"]] = $style_rec["value"];
        }
        if (is_array($tag)) {
            $this->style[] = $tag;
        }
        foreach ($this->end_styles as $s) {
            $this->style[] = $s;
        }
        //var_dump($this->style_class);
        $q = "SELECT * FROM style_data WHERE id = " .
            $ilDB->quote($this->getId(), "integer");
        $res = $ilDB->query($q);
        $sty = $ilDB->fetchAssoc($res);
        $this->setUpToDate((bool) $sty["uptodate"]);
        $this->setScope((int) $sty["category"]);

        // get style characteristics records
        $this->chars = array();
        $this->chars_by_type = array();
        $q = "SELECT * FROM style_char WHERE style_id = " .
            $ilDB->quote($this->getId(), "integer") .
            " ORDER BY type ASC, characteristic ASC";
        $par_set = $ilDB->query($q);
        while ($par_rec = $ilDB->fetchAssoc($par_set)) {
            $this->chars[] = array("type" => $par_rec["type"], "class" => $par_rec["characteristic"], "hide" => $par_rec["hide"]);
            $this->chars_by_type[$par_rec["type"]][] = $par_rec["characteristic"];
            if ($par_rec["hide"]) {
                $this->hidden_chars[$par_rec["type"] . ":" . $par_rec["characteristic"]] = true;
            }
        }
        //              var_dump($this->style); exit;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

removeColor()

ilObjStyleSheet::removeColor

(

string

$a_name

)

Remove a color.

Definition at line 2527 of file class.ilObjStyleSheet.php.

References ilObject\$db, and $ilDB.

                                               : void
    {
        $ilDB = $this->db;

        $ilDB->manipulate("DELETE FROM style_color WHERE " .
            " style_id = " . $ilDB->quote($this->getId(), "integer") . " AND " .
            " color_name = " . $ilDB->quote($a_name, "text"));
    }

removeTemplate()

ilObjStyleSheet::removeTemplate

(

int

$a_t_id

)

Remove table template.

Definition at line 3164 of file class.ilObjStyleSheet.php.

References ilObject\$db, and $ilDB.

                                               : void
    {
        $ilDB = $this->db;

        $ilDB->manipulate("DELETE FROM style_template WHERE " .
            " style_id = " . $ilDB->quote($this->getId(), "integer") . " AND " .
            " id = " . $ilDB->quote($a_t_id, "integer"));

        $ilDB->manipulate(
            "DELETE FROM style_template_class WHERE " .
            "template_id = " . $ilDB->quote($a_t_id, "integer")
        );
    }

saveHideStatus()

ilObjStyleSheet::saveHideStatus	(	string	$a_type,
		string	$a_char,
		bool	$a_hide
	)

Save characteristic hidden status.

Definition at line 983 of file class.ilObjStyleSheet.php.

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

     : void {
        $ilDB = $this->db;

        $ilDB->manipulate(
            "UPDATE style_char SET " .
            " hide = " . $ilDB->quote((int) $a_hide, "integer") .
            " WHERE style_id = " . $ilDB->quote($this->getId(), "integer") . " AND " .
            " type = " . $ilDB->quote($a_type, "text") . " AND " .
            " characteristic = " . $ilDB->quote($a_char, "text")
        );
    }

Here is the call graph for this function:

saveMediaQueryOrder()

ilObjStyleSheet::saveMediaQueryOrder

(

array

$a_order_nr = null

)

Save media query order.

Definition at line 2839 of file class.ilObjStyleSheet.php.

References ilObject\$db, $ilDB, getMediaQueries(), and ilArrayUtil\sortArray().

Referenced by deleteMediaQuery().

     : void {
        $ilDB = $this->db;

        $mqueries = $this->getMediaQueries();
        if (is_array($a_order_nr)) {
            foreach ($mqueries as $k => $mq) {
                $mqueries[$k]["order_nr"] = $a_order_nr[$mq["id"]];
            }
            $mqueries = ilArrayUtil::sortArray($mqueries, "order_nr", "", true);
        }
        $cnt = 10;
        foreach ($mqueries as $mq) {
            $ilDB->manipulate(
                "UPDATE sty_media_query SET " .
                " order_nr = " . $ilDB->quote($cnt, "integer") .
                " WHERE id = " . $ilDB->quote($mq["id"], "integer")
            );
            $cnt += 10;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setCharacteristics()

ilObjStyleSheet::setCharacteristics

(

array

$a_chars

)

Definition at line 975 of file class.ilObjStyleSheet.php.

                                                      : void
    {
        $this->chars = $a_chars;
    }

setExportSubDir()

ilObjStyleSheet::setExportSubDir

(

string

$a_dir

)

Set local directory, that will be included within the zip file.

Definition at line 1766 of file class.ilObjStyleSheet.php.

                                                  : void
    {
        $this->export_sub_dir = $a_dir;
    }

setScope()

ilObjStyleSheet::setScope

(

int

$a_scope

)

Definition at line 542 of file class.ilObjStyleSheet.php.

Referenced by read().

                                          : void
    {
        $this->scope = $a_scope;
    }

Here is the caller graph for this function:

setStyle()

ilObjStyleSheet::setStyle

(

array

$a_style

)

Definition at line 1644 of file class.ilObjStyleSheet.php.

                                            : void
    {
        $this->style = $a_style;
    }

setUpToDate()

ilObjStyleSheet::setUpToDate

(

bool

$a_up_to_date = true

)

Set style up to date (false + update will trigger css generation next time)

Definition at line 532 of file class.ilObjStyleSheet.php.

Referenced by addCharacteristic(), read(), and writeCSSFile().

                                                          : void
    {
        $this->up_to_date = $a_up_to_date;
    }

Here is the caller graph for this function:

templateExists()

ilObjStyleSheet::templateExists

(

string

$a_template_name

)

Check whether template exists.

Definition at line 2995 of file class.ilObjStyleSheet.php.

References ilObject\$db, and $ilDB.

     : bool {
        $ilDB = $this->db;

        $set = $ilDB->query("SELECT * FROM style_template WHERE " .
            "style_id = " . $ilDB->quote($this->getId(), "integer") . " AND " .
            "name = " . $ilDB->quote($a_template_name, "text"));
        if ($ilDB->fetchAssoc($set)) {
            return true;
        }
        return false;
    }

update()

ilObjStyleSheet::update

(

)

Definition at line 1608 of file class.ilObjStyleSheet.php.

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

Referenced by createFromXMLFile().

                            : bool
    {
        $ilDB = $this->db;

        parent::update();
        $this->read();                          // this could be done better
        $this->writeCSSFile();

        $q = "UPDATE style_data " .
            "SET category = " . $ilDB->quote($this->getScope(), "integer") .
            " WHERE id = " . $ilDB->quote($this->getId(), "integer");
        $ilDB->manipulate($q);

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateMediaQuery()

ilObjStyleSheet::updateMediaQuery	(	int	$a_id,
		string	$a_mquery
	)

Definition at line 2787 of file class.ilObjStyleSheet.php.

References ilObject\$db, and $ilDB.

     : void {
        $ilDB = $this->db;

        $ilDB->manipulate(
            "UPDATE sty_media_query SET " .
            " mquery = " . $ilDB->quote($a_mquery, "text") .
            " WHERE id = " . $ilDB->quote($a_id, "integer")
        );
    }

updateStyleParameter()

ilObjStyleSheet::updateStyleParameter	(	int	$a_id,
		string	$a_value
	)

update style parameter per id

Definition at line 1627 of file class.ilObjStyleSheet.php.

References ilObject\$db, and $ilDB.

     : void {
        $ilDB = $this->db;

        $q = "UPDATE style_parameter SET VALUE = " .
            $ilDB->quote($a_value, "text") . " WHERE id = " .
            $ilDB->quote($a_id, "integer");
        $style_set = $ilDB->manipulate($q);
    }

updateTemplate()

ilObjStyleSheet::updateTemplate	(	int	$a_t_id,
		string	$a_name,
		array	$a_classes
	)

Update table template.

Definition at line 2950 of file class.ilObjStyleSheet.php.

References $c, ilObject\$db, and $ilDB.

     : void {
        $ilDB = $this->db;

        $ilDB->manipulate("UPDATE style_template SET " .
            "name = " . $ilDB->quote($a_name, "text") .
            " WHERE id = " . $ilDB->quote($a_t_id, "integer"));

        $ilDB->manipulate(
            "DELETE FROM style_template_class WHERE " .
            "template_id = " . $ilDB->quote($a_t_id, "integer")
        );
        foreach ($a_classes as $t => $c) {
            $ilDB->manipulate("INSERT INTO style_template_class " .
                "(template_id, class_type, class)" .
                " VALUES (" .
                $ilDB->quote($a_t_id, "integer") . "," .
                $ilDB->quote($t, "text") . "," .
                $ilDB->quote($c, "text") .
                ")");
        }
    }

writeCSSFile()

ilObjStyleSheet::writeCSSFile	(	string	$a_target_file = "",
		string	$a_image_dir = ""
	)

write css file to webspace directory

Definition at line 1345 of file class.ilObjStyleSheet.php.

References _writeUpToDate(), getColorCodeForName(), ilObject\getId(), getMediaQueries(), getStyle(), ilFileUtils\getWebspaceDir(), ILIAS\Repository\int(), ilFileUtils\makeDirParents(), and setUpToDate().

Referenced by addParameter(), create(), import(), and update().

     : void {
        $style = $this->getStyle();

        if (!is_dir(ilFileUtils::getWebspaceDir() . "/css")) {
            ilFileUtils::makeDirParents(ilFileUtils::getWebspaceDir() . "/css");
        }

        if ($a_target_file == "") {
            $css_file_name = ilFileUtils::getWebspaceDir() . "/css/style_" . $this->getId() . ".css";
        } else {
            $css_file_name = $a_target_file;
        }
        $css_file = fopen($css_file_name, 'wb');

        $page_background = "";

        $mqs = array(array("mquery" => "", "id" => 0));
        foreach ($this->getMediaQueries() as $mq) {
            $mqs[] = $mq;
        }

        // iterate all media queries
        foreach ($mqs as $mq) {
            if ($mq["id"] > 0) {
                fwrite($css_file, "@media " . $mq["mquery"] . " {\n");
            }
            reset($style);
            foreach ($style as $tag) {
                if ($tag[0]["mq_id"] != $mq["id"]) {
                    continue;
                }
                fwrite($css_file, $tag[0]["tag"] . ".ilc_" . $tag[0]["type"] . "_" . $tag[0]["class"] . "\n");
                //                              echo "<br>";
                //                              var_dump($tag[0]["type"]);
                if ($tag[0]["tag"] == "td") {
                    fwrite($css_file, ",th" . ".ilc_" . $tag[0]["type"] . "_" . $tag[0]["class"] . "\n");
                }
                if (in_array($tag[0]["tag"], array("h1", "h2", "h3"))) {
                    fwrite($css_file, ",div.ilc_text_block_" . $tag[0]["class"] . "\n");
                    fwrite($css_file, ",html.il-no-tiny-bg body#tinymce.ilc_text_block_" . $tag[0]["class"] . "\n");
                }
                if ($tag[0]["type"] == "section") {     // sections can use a tags, if links are used
                    fwrite($css_file, ",div a.ilc_" . $tag[0]["type"] . "_" . $tag[0]["class"] . "\n");
                }
                if ($tag[0]["type"] == "text_block") {
                    fwrite($css_file, ",html.il-no-tiny-bg body#tinymce.ilc_text_block_" . $tag[0]["class"] . "\n");
                }
                fwrite($css_file, "{\n");

                // collect table border attributes
                $t_border = array();

                foreach ($tag as $par) {
                    $cur_par = $par["parameter"];
                    $cur_val = $par["value"];

                    // replace named colors
                    if (is_int(strpos($cur_par, "color")) && substr(trim($cur_val), 0, 1) == "!") {
                        $cur_val = $this->getColorCodeForName(substr($cur_val, 1));
                    }

                    if ($tag[0]["type"] == "table" && is_int(strpos($par["parameter"], "border"))) {
                        $t_border[$cur_par] = $cur_val;
                    }

                    if (in_array($cur_par, array("background-image", "list-style-image"))) {
                        if (is_int(strpos($cur_val, "/"))) {    // external
                            $cur_val = "url('" . $cur_val . "')";
                        } else {                // internal
                            if ($a_image_dir == "") {
                                $cur_val = "url('../sty/sty_" . $this->getId() . "/images/" . $cur_val . "')";
                            } else {
                                $cur_val = "url('" . $a_image_dir . "/" . $cur_val . "')";
                            }
                        }
                    }

                    if ($cur_par == "opacity") {
                        $cur_val = ((int) $cur_val) / 100;
                    }

                    fwrite($css_file, "\t" . $cur_par . ": " . $cur_val . ";\n");

                    // IE6 fix for minimum height
                    /*
                    if ($cur_par == "min-height") {
                        fwrite($css_file, "\t" . "height" . ": " . "auto !important" . ";\n");
                        fwrite($css_file, "\t" . "height" . ": " . $cur_val . ";\n");
                    }*/

                    // opacity fix
                    if ($cur_par == "opacity") {
                        fwrite($css_file, "\t" . '-ms-filter:"progid:DXImageTransform.Microsoft.Alpha(Opacity=' . ($cur_val * 100) . ')"' . ";\n");
                        fwrite($css_file, "\t" . 'filter: alpha(opacity=' . ($cur_val * 100) . ')' . ";\n");
                        fwrite($css_file, "\t" . '-moz-opacity: ' . $cur_val . ";\n");
                    }

                    // transform fix
                    if ($cur_par == "transform") {
                        fwrite($css_file, "\t" . '-webkit-transform: ' . $cur_val . ";\n");
                        fwrite($css_file, "\t" . '-moz-transform: ' . $cur_val . ";\n");
                        fwrite($css_file, "\t" . '-ms-transform: ' . $cur_val . ";\n");
                    }

                    // transform-origin fix
                    if ($cur_par == "transform-origin") {
                        fwrite($css_file, "\t" . '-webkit-transform-origin: ' . $cur_val . ";\n");
                        fwrite($css_file, "\t" . '-moz-transform-origin: ' . $cur_val . ";\n");
                        fwrite($css_file, "\t" . '-ms-transform-origin: ' . $cur_val . ";\n");
                    }

                    // save page background
                    if ($tag[0]["tag"] == "div" && $tag[0]["class"] == "Page"
                        && $cur_par == "background-color") {
                        $page_background = $cur_val;
                    }
                }
                fwrite($css_file, "}\n");
                fwrite($css_file, "\n");

                // use table border attributes for th td as well
                /*                      if ($tag[0]["type"] == "table")
                            {
                                if (count($t_border) > 0)
                                {
                                    fwrite ($css_file, $tag[0]["tag"].".ilc_".$tag[0]["type"]."_".$tag[0]["class"]." th,".
                                        $tag[0]["tag"].".ilc_".$tag[0]["type"]."_".$tag[0]["class"]." td\n");
                                    fwrite ($css_file, "{\n");
                                    foreach ($t_border as $p => $v)
                                    {
                //                                              fwrite ($css_file, "\t".$p.": ".$v.";\n");
                                    }
                                    fwrite ($css_file, "}\n");
                                    fwrite ($css_file, "\n");
                                }
                            }*/
            }

            if ($page_background != "") {
                fwrite($css_file, "td.ilc_Page\n");
                fwrite($css_file, "{\n");
                fwrite($css_file, "\t" . "background-color: " . $page_background . ";\n");
                fwrite($css_file, "}\n");
            }
            if ($mq["id"] > 0) {
                fwrite($css_file, "}\n");
            }
        }
        fclose($css_file);
        //      exit;
        $this->setUpToDate();
        $this->_writeUpToDate($this->getId(), true);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

writeOwner()

static ilObjStyleSheet::writeOwner (   $obj_id,   $style_id  )

static

Definition at line 566 of file class.ilObjStyleSheet.php.

References $DIC, and $ilDB.

Referenced by ILIAS\Style\Content\Object\ObjectManager\cloneTo(), ilStyleDataSet\importRecord(), and ILIAS\Style\Content\Object\ObjectManager\setOwnerOfStyle().

    {
        global $DIC;
        $ilDB = $DIC->database();

        $q = "UPDATE style_data SET owner_obj = " .
            $ilDB->quote((int) $obj_id, "integer") .
            " WHERE id = " . $ilDB->quote($style_id, "integer");
        $ilDB->manipulate($q);
    }

Here is the caller graph for this function:

writeStyleSetting()

ilObjStyleSheet::writeStyleSetting	(	string	$a_name,
		string	$a_value
	)

Definition at line 3178 of file class.ilObjStyleSheet.php.

References ilObject\$db, and $ilDB.

     : void {
        $ilDB = $this->db;

        $ilDB->manipulate(
            "DELETE FROM style_setting WHERE " .
            " style_id = " . $ilDB->quote($this->getId(), "integer") .
            " AND name = " . $ilDB->quote($a_name, "text")
        );

        $ilDB->manipulate("INSERT INTO style_setting " .
            "(style_id, name, value) VALUES (" .
            $ilDB->quote($this->getId(), "integer") . "," .
            $ilDB->quote($a_name, "text") . "," .
            $ilDB->quote($a_value, "text") .
            ")");
    }

writeStyleUsage()

static ilObjStyleSheet::writeStyleUsage ( int  $a_obj_id, int  $a_style_id  )

static

Write style usage.

Definition at line 3218 of file class.ilObjStyleSheet.php.

References $DIC, and $ilDB.

Referenced by ILIAS\Style\Content\Object\ObjectManager\cloneTo(), ilContainerImporter\finalProcessing(), ilStyleDataSet\importRecord(), ILIAS\Style\Content\Object\ObjectManager\inheritFromParent(), and ILIAS\Style\Content\Object\ObjectManager\updateStyleId().

     : void {
        global $DIC;

        $ilDB = $DIC->database();

        $ilDB->replace(
            "style_usage",
            array(
            "obj_id" => array("integer", $a_obj_id)),
            array(
                "style_id" => array("integer", $a_style_id))
        );
    }

Here is the caller graph for this function:

writeTemplatePreview()

ilObjStyleSheet::writeTemplatePreview	(	int	$a_t_id,
		string	$a_preview_html
	)

Write table template preview.

Definition at line 3105 of file class.ilObjStyleSheet.php.

References ilObject\$db, and $ilDB.

Referenced by addTemplate().

     : void {
        $ilDB = $this->db;
        $a_preview_html = str_replace(' width=""', "", $a_preview_html);
        $a_preview_html = str_replace(' valign="top"', "", $a_preview_html);
        $a_preview_html = str_replace('<div class="ilc_text_block_TableContent">', "<div>", $a_preview_html);
        //echo "1-".strlen($a_preview_html)."-";
        //echo htmlentities($a_preview_html);
        if (strlen($a_preview_html) > 4000) {
            //echo "2";
            $a_preview_html = "";
        }
        $ilDB->manipulate("UPDATE style_template SET " .
            "preview = " . $ilDB->quote($a_preview_html, "text") .
            " WHERE id = " . $ilDB->quote($a_t_id, "integer"));
    }

Here is the caller graph for this function:

Field Documentation

$assigned_tags

array ilObjStyleSheet::$assigned_tags

static

Definition at line 303 of file class.ilObjStyleSheet.php.

$basic_style_dom

DOMDocument ilObjStyleSheet::$basic_style_dom = null

staticprotected

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

$basic_style_file

string ilObjStyleSheet::$basic_style_file = "./libs/ilias/Style/basic_style/style.xml"

staticprotected

Definition at line 500 of file class.ilObjStyleSheet.php.

$basic_style_image_dir

string ilObjStyleSheet::$basic_style_image_dir = "./libs/ilias/Style/basic_style/images"

staticprotected

Definition at line 502 of file class.ilObjStyleSheet.php.

$basic_style_zip

string ilObjStyleSheet::$basic_style_zip = "./libs/ilias/Style/basic_style/style.zip"

staticprotected

Definition at line 501 of file class.ilObjStyleSheet.php.

$chars

array ilObjStyleSheet::$chars = []

protected

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

Referenced by getCharacteristics().

$chars_by_type

array ilObjStyleSheet::$chars_by_type = []

protected

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

$core_styles

array ilObjStyleSheet::$core_styles

static

Definition at line 381 of file class.ilObjStyleSheet.php.

$end_styles

array ilObjStyleSheet::$end_styles = []

protected

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

$expandable_types

array ilObjStyleSheet::$expandable_types

static

Initial value:

= array(
            "text_block",
            "text_inline", "section", "media_cont", "media_caption", "table", "table_cell", "flist_li", "table_caption",
                "list_o", "list_u",
                "va_cntr", "va_icntr", "va_ihead", "va_iheada", "va_ihcap", "va_icont",
                "ha_cntr", "ha_icntr", "ha_ihead", "ha_iheada", "ha_ihcap", "ha_icont",
                "ca_cntr", "ca_icntr", "ca_ihead", "ca_icont"
        )

Definition at line 288 of file class.ilObjStyleSheet.php.

$export_sub_dir

string ilObjStyleSheet::$export_sub_dir = ""

protected

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

Referenced by getExportSubDir().

$filtered_groups

array ilObjStyleSheet::$filtered_groups

static

Initial value:

=
            array("ol" => array("ol"), "ul" => array("ul"),
                "table" => array("table"), "positioning" => array("h1", "h2", "h3", "div", "img", "table", "a", "figure"))

Definition at line 264 of file class.ilObjStyleSheet.php.

$hidden_chars

array ilObjStyleSheet::$hidden_chars = []

protected

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

$hideable_types

array ilObjStyleSheet::$hideable_types

static

Initial value:

= array(
            "table", "table_cell"
        )

Definition at line 298 of file class.ilObjStyleSheet.php.

$is_3_10_skin

bool ilObjStyleSheet::$is_3_10_skin = false

protected

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

$num_unit

array ilObjStyleSheet::$num_unit = array("px", "em", "ex", "%", "pt", "pc", "in", "mm", "cm")

static

Definition at line 41 of file class.ilObjStyleSheet.php.

$num_unit_no_perc

array ilObjStyleSheet::$num_unit_no_perc = array("px", "em", "ex", "pt", "pc", "in", "mm", "cm")

static

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

$parameter

array ilObjStyleSheet::$parameter

static

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

Referenced by getStyleParameterGroups().

$pseudo_classes

array ilObjStyleSheet::$pseudo_classes

static

Initial value:

=
        array("a" => array("hover"), "div" => array("hover"), "img" => array("hover"))

Definition at line 377 of file class.ilObjStyleSheet.php.

$repo

ILIAS Style Content InternalRepoService ilObjStyleSheet::$repo

protected

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

$scope

int ilObjStyleSheet::$scope = 0

protected

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

Referenced by getScope().

$style

array ilObjStyleSheet::$style = []

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

Referenced by getStyle().

$style_class

array ilObjStyleSheet::$style_class = []

protected

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

$style_super_types

array ilObjStyleSheet::$style_super_types

static

Initial value:

= array(
        "text_block" => array("text_block", "heading1", "heading2", "heading3", "code_block"),
        "text_inline" => array("text_inline", "sub", "sup", "code_inline"),
        "section" => array("section"),
        "link" => array("link"),
        "table" => array("table", "table_cell", "table_caption"),
        "list" => array("list_o", "list_u", "list_item"),
        "flist" => array("flist_cont", "flist_head", "flist", "flist_li", "flist_a"),
        "media" => array("media_cont", "media_caption", "iim", "marker"),
        "tabs" => array("va_cntr", "va_icntr", "va_ihead", "va_iheada", "va_ihcap", "va_icont",
            "ha_cntr", "ha_icntr", "ha_ihead", "ha_iheada", "ha_ihcap", "ha_icont", "ca_cntr", "ca_icntr", "ca_ihead", "ca_icont"),
        "question" => array("question", "qtitle", "qanswer", "qinput", "qlinput", "qsubmit", "qfeedr", "qfeedw",
            "qimg", "qordul", "qordli", "qimgd", "qetitem", "qetcorr", "qover"),
        "page" => array("page_frame", "page_cont", "page_title", "page_fn",
            "page_tnav", "page_bnav", "page_lnav", "page_rnav", "page_lnavlink", "page_rnavlink",
            "page_lnavimage", "page_rnavimage")
        )

Definition at line 269 of file class.ilObjStyleSheet.php.

$templates

array ilObjStyleSheet::$templates

static

Definition at line 463 of file class.ilObjStyleSheet.php.

Referenced by getTemplates().

$up_to_date

bool ilObjStyleSheet::$up_to_date = false

protected

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

Referenced by getUpToDate().

---

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

• Services/Style/Content/classes/class.ilObjStyleSheet.php