Style Import Parser. More...

Inheritance diagram for ilStyleImportParser:

Collaboration diagram for ilStyleImportParser:

Public Member Functions
	__construct (string $a_xml_file, ilObjStyleSheet $a_style_obj)

	setHandlers ($a_xml_parser)
	set event handler should be overwritten by inherited class private More...

	startParsing ()
	start the parser More...

	handlerBeginTag ( $a_xml_parser, string $a_name, array $a_attribs)

	handlerEndTag ( $a_xml_parser, string $a_name)

	handlerCharacterData ( $a_xml_parser, string $a_data)

Public Member Functions inherited from ilSaxParser
	__construct (?string $path_to_file='', ?bool $throw_exception=false)

	setXMLContent (string $a_xml_content)

	getXMLContent ()

	getInputType ()

	startParsing ()
	stores xml data in array More...

	createParser ()

	setHandlers ($a_xml_parser)

	parse ($a_xml_parser, $a_fp=null)

Protected Member Functions
	trimAndStripAttribs (array $attribs)

	trimAndStrip (string $input)

Protected Member Functions inherited from ilSaxParser
	openXMLFile ()

	handleError (string $message)

	setThrowException (bool $throw_exception)

Protected Attributes
string	$cdata = ""

array	$cur_template_classes

array	$cur_template

array	$current_tags = []

string	$current_type = ""

string	$current_class = ""

string	$current_tag = ""

array	$styles

ilObjStyleSheet	$style_obj

ilTree	$tree

Content ColorManager	$color_manager

array	$chars = []

Protected Attributes inherited from ilSaxParser
ilLanguage	$lng = null

Additional Inherited Members
Data Fields inherited from ilSaxParser
string	$xml_file

bool	$throw_exception = false

Detailed Description

Style Import Parser.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

ilStyleImportParser::__construct	(	string	$a_xml_file,
		ilObjStyleSheet	$a_style_obj
	)

Definition at line 43 of file class.ilStyleImportParser.php.

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

       {
         global $DIC;
 
         $this->lng = $DIC->language();
         $this->tree = $DIC->repositoryTree();
 
         $service = $DIC->contentStyle()->internal();
         $access_manager = $service->domain()->access(0, $DIC->user()->getId());
         $access_manager->enableWrite(true);
 
         $this->color_manager = $service->domain()->color(
             $a_style_obj->getId(),
             $access_manager
         );
 
         $this->style_obj = $a_style_obj;
 
         parent::__construct($a_xml_file);
     }

Here is the call graph for this function:

Member Function Documentation

◆ handlerBeginTag()

ilStyleImportParser::handlerBeginTag	(		$a_xml_parser,
		string	$a_name,
		array	$a_attribs
	)

Definition at line 90 of file class.ilStyleImportParser.php.

References trimAndStripAttribs().

      : void {
         $a_attribs = $this->trimAndStripAttribs($a_attribs);
         switch ($a_name) {
             case "Style":
                 $this->current_tag = $a_attribs["Tag"];
                 $this->current_class = $a_attribs["Class"];
                 $this->current_type = $a_attribs["Type"];
                 if ($this->current_class == "PageTitle" && $this->current_type == "page_title" && $this->current_tag == "div") {
                     $this->current_tag = "h1";
                 }
                 if ($this->current_class == "Headline1" && $this->current_tag == "div") {
                     $this->current_tag = "h1";
                     $this->current_type = "heading1";
                 }
                 if ($this->current_class == "Headline2" && $this->current_tag == "div") {
                     $this->current_tag = "h2";
                     $this->current_type = "heading2";
                 }
                 if ($this->current_class == "Headline3" && $this->current_tag == "div") {
                     $this->current_tag = "h3";
                     $this->current_type = "heading3";
                 }
                 $this->current_tags = array();
                 $this->chars[] = array("type" => $this->current_type,
                     "class" => $this->current_class);
                 break;
 
             case "StyleParameter":
                 $this->current_tags[] = array(
                     "tag" => $this->current_tag,
                     "class" => $this->current_class,
                     "parameter" => $a_attribs["Name"],
                     "type" => $this->current_type,
                     "value" => $a_attribs["Value"],
                     "custom" => $a_attribs["Custom"] ?? null);
                 break;
 
             case "StyleColor":
                 $this->color_manager->addColor($a_attribs["Name"], $a_attribs["Code"]);
                 break;
 
             case "StyleTemplate":
                 $this->cur_template = array("type" => $a_attribs["Type"],
                     "name" => $a_attribs["Name"]);
                 $this->cur_template_classes = array();
                 break;
 
             case "StyleTemplateClass":
                 $this->cur_template_classes[$a_attribs["ClassType"]] =
                     $a_attribs["Class"];
                 break;
 
         }
         $this->cdata = "";
     }

Here is the call graph for this function:

◆ handlerCharacterData()

ilStyleImportParser::handlerCharacterData	(		$a_xml_parser,
		string	$a_data
	)

Definition at line 179 of file class.ilStyleImportParser.php.

      : void {
         // i don't know why this is necessary, but
         // the parser seems to convert "&gt;" to ">" and "&lt;" to "<"
         // in character data, but we don't want that, because it's the
         // way we mask user html in our content, so we convert back...
         $a_data = str_replace("<", "&lt;", $a_data);
         $a_data = str_replace(">", "&gt;", $a_data);
 
         // DELETE WHITESPACES AND NEWLINES OF CHARACTER DATA
         $a_data = preg_replace("/\n/", "", $a_data);
         $a_data = preg_replace("/\t+/", "", $a_data);
         if (!empty($a_data)) {
             $this->cdata .= $a_data;
         }
     }

◆ handlerEndTag()

ilStyleImportParser::handlerEndTag	(		$a_xml_parser,
		string	$a_name
	)

Definition at line 150 of file class.ilStyleImportParser.php.

References $current_tags, and trimAndStrip().

      : void {
         $this->cdata = $this->trimAndStrip($this->cdata);
         switch ($a_name) {
             case "Title":
                 $this->style_obj->setTitle($this->cdata);
                 break;
 
             case "Description":
                 $this->style_obj->setDescription($this->cdata);
                 break;
 
             case "Style":
                 $this->styles[] = $this->current_tags;
                 break;
 
             case "StyleTemplate":
                 $this->style_obj->addTemplate(
                     $this->cur_template["type"],
                     $this->cur_template["name"],
                     $this->cur_template_classes
                 );
                 break;
 
         }
     }

Here is the call graph for this function:

◆ setHandlers()

ilStyleImportParser::setHandlers ( $a_xml_parser )

set event handler should be overwritten by inherited class private

Definition at line 72 of file class.ilStyleImportParser.php.

                                               : void
     {
         xml_set_object($a_xml_parser, $this);
         xml_set_element_handler($a_xml_parser, 'handlerBeginTag', 'handlerEndTag');
         xml_set_character_data_handler($a_xml_parser, 'handlerCharacterData');
     }

◆ startParsing()

ilStyleImportParser::startParsing ( )

start the parser

Definition at line 82 of file class.ilStyleImportParser.php.

                                   : void
     {
         $this->styles = array();
         parent::startParsing();
         $this->style_obj->setStyle($this->styles);
         $this->style_obj->setCharacteristics($this->chars);
     }

◆ trimAndStrip()

ilStyleImportParser::trimAndStrip ( string $input )

protected

Definition at line 207 of file class.ilStyleImportParser.php.

References ilUtil\stripSlashes().

Referenced by handlerEndTag(), and trimAndStripAttribs().

                                                   : string
     {
         return ilUtil::stripSlashes(trim($input));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ trimAndStripAttribs()

ilStyleImportParser::trimAndStripAttribs ( array $attribs )

protected

Definition at line 198 of file class.ilStyleImportParser.php.

References trimAndStrip().

Referenced by handlerBeginTag().

                                                           : array
     {
         $ret = [];
         foreach ($attribs as $k => $v) {
             $ret[$k] = $this->trimAndStrip((string) $v);
         }
         return $ret;
     }