Collaboration diagram for ilSystemStyleLessGUI:

Public Member Functions
	__construct ($skin_id="", $style_id="")
	ilSystemStyleLessGUI constructor. More...

	executeCommand ()
	Execute command. More...

	initSystemStyleLessForm ($modify=true)

	getVariablesValues (ilPropertyFormGUI $form)

	reset ()

	update ()

	getStyleContainer ()

	setStyleContainer ($style_container)

	getLessFile ()

	setLessFile ($less_file)

	getMessageStack ()

	setMessageStack ($message_stack)

Protected Member Functions
	checkRequirements ()

	checkLessInstallation ()

	edit ()

Protected Attributes
	$ctrl

	$lng

	$tpl

	$style_container

	$less_file

	$message_stack

Detailed Description

Author: Timon Amstutz timon.nosp@m..ams.nosp@m.tutz@.nosp@m.ilub.nosp@m..unib.nosp@m.e.ch

Version: $Id$*

Definition at line 13 of file class.ilSystemStyleLessGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilSystemStyleLessGUI::__construct	(	$skin_id = `""`,
		$style_id = `""`
	)

ilSystemStyleLessGUI constructor.

Parameters

string	$skin_id
string	$style_id

Definition at line 51 of file class.ilSystemStyleLessGUI.php.

References $_GET, $DIC, $less_file, ilSystemStyleSkinContainer\generateFromId(), getMessageStack(), getStyleContainer(), setLessFile(), setMessageStack(), setStyleContainer(), and ilSystemStyleMessage\TYPE_ERROR.

         {
                 global $DIC;
 
                 $this->ctrl = $DIC->ctrl();
                 $this->lng = $DIC->language();
                 $this->tpl = $DIC["tpl"];
 
                 $this->setMessageStack(new ilSystemStyleMessageStack());
 
                 if($skin_id == ""){
                         $skin_id = $_GET["skin_id"];
                 }
                 if($style_id == ""){
                         $style_id = $_GET["style_id"];
                 }
 
                 try{
                         $this->setStyleContainer(ilSystemStyleSkinContainer::generateFromId($skin_id));
                         $less_file = new ilSystemStyleLessFile($this->getStyleContainer()->getLessVariablesFilePath($style_id));
                         $this->setLessFile($less_file);
                 }catch(ilSystemStyleException $e){
                         $this->getMessageStack()->addMessage(
                                 new ilSystemStyleMessage($e->getMessage(),ilSystemStyleMessage::TYPE_ERROR)
                         );
                 }
 
 
         }

Here is the call graph for this function:

Member Function Documentation

◆ checkLessInstallation()

ilSystemStyleLessGUI::checkLessInstallation ( )

protected

Returns: bool

Definition at line 148 of file class.ilSystemStyleLessGUI.php.

References $pass, getMessageStack(), and ilSystemStyleMessage\TYPE_ERROR.

Referenced by checkRequirements().

                                                   {
                 $pass = true;
 
                 if(!PATH_TO_LESSC){
                         $this->getMessageStack()->addMessage(
                                 new ilSystemStyleMessage($this->lng->txt("no_less_path_set"),ilSystemStyleMessage::TYPE_ERROR)
                         );
                         $pass = false;
                 }else if(!shell_exec(PATH_TO_LESSC)){
                         $this->getMessageStack()->addMessage(
                                 new ilSystemStyleMessage($this->lng->txt("invalid_less_path"),ilSystemStyleMessage::TYPE_ERROR)
                         );
                         $this->getMessageStack()->addMessage(
                                 new ilSystemStyleMessage($this->lng->txt("provided_less_path")." ".PATH_TO_LESSC,ilSystemStyleMessage::TYPE_ERROR)
                         );
                         $pass = false;
                 }
 
                 if(!$pass && shell_exec("which lessc")){
                         $this->getMessageStack()->addMessage(
                                 new ilSystemStyleMessage($this->lng->txt("less_less_installation_detected").shell_exec("which lessc"),ilSystemStyleMessage::TYPE_ERROR)
                         );
                 }
 
                 return $pass;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkRequirements()

ilSystemStyleLessGUI::checkRequirements ( )

protected

Returns: bool

Definition at line 106 of file class.ilSystemStyleLessGUI.php.

References $_GET, $pass, checkLessInstallation(), getMessageStack(), getStyleContainer(), and ilSystemStyleMessage\TYPE_ERROR.

Referenced by edit().

                                               {
                 $style_id = $_GET['style_id'];
                 $less_path = $this->getStyleContainer()->getLessFilePath($style_id);
 
                 $pass = $this->checkLessInstallation();
 
                 if(file_exists($less_path)){
                         $less_variables_name = $this->getStyleContainer()->getLessVariablesName($style_id);
                         $content = "";
                         try{
                                 $content = file_get_contents($less_path);
                         }catch(Exception $e){
                                 $this->getMessageStack()->addMessage(
                                         new ilSystemStyleMessage($this->lng->txt("can_not_read_less_file")." ".$less_path,ilSystemStyleMessage::TYPE_ERROR)
                                 );
                                 $pass = false;
                         }
                         if($content){
                                 $reg_exp = "/".preg_quote ($less_variables_name,"/")."/";
 
                                 if(!preg_match($reg_exp,$content)){
                                         $this->getMessageStack()->addMessage(
                                                 new ilSystemStyleMessage($this->lng->txt("less_variables_file_not_included")." ".$less_variables_name
                                                         ." ".$this->lng->txt("in_main_less_file")." ".$less_path,ilSystemStyleMessage::TYPE_ERROR)
                                         );
                                         $pass = false;
                                 }
                         }
 
 
                 }else{
                         $this->getMessageStack()->addMessage(
                                 new ilSystemStyleMessage($this->lng->txt("less_file_does_not_exist").$less_path,ilSystemStyleMessage::TYPE_ERROR)
                         );
                         $pass = false;
                 }
                 return $pass;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ edit()

ilSystemStyleLessGUI::edit ( )

protected

Definition at line 176 of file class.ilSystemStyleLessGUI.php.

References checkRequirements(), getLessFile(), getMessageStack(), getVariablesValues(), initSystemStyleLessForm(), and ilSystemStyleMessage\TYPE_ERROR.

Referenced by executeCommand(), and reset().

                                  {
 
                 $modify = true;
 
                 if(!$this->checkRequirements()){
                         $this->getMessageStack()->prependMessage(
                                 new ilSystemStyleMessage($this->lng->txt("less_can_not_be_modified"), ilSystemStyleMessage::TYPE_ERROR));
                         $modify = false;
                 }
 
                 if($this->getLessFile()){
                         $form = $this->initSystemStyleLessForm($modify);
                         $this->getVariablesValues($form);
                         $this->tpl->setContent($form->getHTML());
                 }
 
                 $this->getMessageStack()->sendMessages(true);
 
 
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilSystemStyleLessGUI::executeCommand ( )

Execute command.

Definition at line 84 of file class.ilSystemStyleLessGUI.php.

References $cmd, and edit().

         {
                 $cmd = $this->ctrl->getCmd();
 
                 switch ($cmd)
                 {
                         case "save":
                         case "edit":
                         case "reset":
                         case "update":
                                 $this->$cmd();
                                 break;
                         default:
                                 $this->edit();
                                 break;
                 }
         }

Here is the call graph for this function:

◆ getLessFile()

ilSystemStyleLessGUI::getLessFile ( )

Returns: ilSystemStyleLessFile

Definition at line 331 of file class.ilSystemStyleLessGUI.php.

References $less_file.

Referenced by edit(), getVariablesValues(), initSystemStyleLessForm(), and update().

         {
                 return $this->less_file;
         }

Here is the caller graph for this function:

◆ getMessageStack()

ilSystemStyleLessGUI::getMessageStack ( )

Returns: ilSystemStyleMessageStack

Definition at line 347 of file class.ilSystemStyleLessGUI.php.

References $message_stack.

Referenced by __construct(), checkLessInstallation(), checkRequirements(), and edit().

         {
                 return $this->message_stack;
         }

Here is the caller graph for this function:

◆ getStyleContainer()

ilSystemStyleLessGUI::getStyleContainer ( )

Returns: ilSystemStyleSkinContainer

Definition at line 315 of file class.ilSystemStyleLessGUI.php.

References $style_container.

Referenced by __construct(), checkRequirements(), reset(), and update().

         {
                 return $this->style_container;
         }

Here is the caller graph for this function:

◆ getVariablesValues()

ilSystemStyleLessGUI::getVariablesValues ( ilPropertyFormGUI $form )

Parameters

ilPropertyFormGUI $form

Definition at line 257 of file class.ilSystemStyleLessGUI.php.

References getLessFile(), and ilPropertyFormGUI\setValuesByArray().

Referenced by edit().

         {
                 $values = [];
                 foreach($this->getLessFile()->getCategories() as $category){
                         foreach($this->getLessFile()->getVariablesPerCategory($category->getName()) as $variable){
                                 $values[$variable->getName()] = $variable->getValue();
                         }
                 }
 
                 $form->setValuesByArray($values);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initSystemStyleLessForm()

ilSystemStyleLessGUI::initSystemStyleLessForm ( $modify = true )

Parameters

bool | true $modify

Returns: ilPropertyFormGUI

Definition at line 201 of file class.ilSystemStyleLessGUI.php.

References $_GET, $info, $section, getLessFile(), and ilFormPropertyGUI\setRequired().

Referenced by edit(), and update().

         {
                 $form = new ilPropertyFormGUI();
 
                 $form->setTitle($this->lng->txt("adapt_less"));
                 $form->setDescription($this->lng->txt("adapt_less_description"));
                 $focus_variable = $_GET['id_less_variable'];
                 if($focus_variable){
                         $this->tpl->addOnLoadCode("setTimeout(function() { $('#".$focus_variable."').focus();}, 100);");
                 }
 
                 foreach($this->getLessFile()->getCategories() as $category){
                         $section = new ilFormSectionHeaderGUI();
                         $section->setTitle($category->getName());
                         $section->setInfo($category->getComment());
                         //$section->setSectionAnchor($category->getName());
                         $form->addItem($section);
                         foreach($this->getLessFile()->getVariablesPerCategory($category->getName()) as $variable){
                                 $input = new ilTextInputGUI($variable->getName(), $variable->getName());
                                 $input->setRequired(true);
                                 $input->setDisabled(!$modify);
 
                                 $references = $this->getLessFile()->getReferencesToVariableAsString($variable->getName());
 
                                 if($references != ""){
                                         if($variable->getComment()){
                                                 $info = $variable->getComment()."</br>".$this->lng->txt("usages")." ".$references;
                                         }else{
                                                 $info = $this->lng->txt("usages")." ".$references;
                                         }
                                 }else{
                                         $info = $variable->getComment();
                                 }
                                 $input->setInfo($info);
 
                                 $form->addItem($input);
 
                         }
                 }
 
                 if($modify){
                         $form->addCommandButton("update", $this->lng->txt("update_variables"));
                         $form->addCommandButton("reset", $this->lng->txt("reset_variables"));
                         $form->addCommandButton("cancel", $this->lng->txt("cancel"));
                 }
 
 
                 $form->setFormAction($this->ctrl->getFormAction($this));
 
                 return $form;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reset()

ilSystemStyleLessGUI::reset ( )

Definition at line 272 of file class.ilSystemStyleLessGUI.php.

References $_GET, $style, edit(), getStyleContainer(), ilUtil\sendFailure(), and setLessFile().

         {
                 $style = $this->getStyleContainer()->getSkin()->getStyle($_GET["style_id"]);
                 $this->setLessFile($this->getStyleContainer()->copyVariablesFromDefault($style));
                 try{
                         $this->getStyleContainer()->compileLess($style->getId());
                 }catch(ilSystemStyleException $e){
                         ilUtil::sendFailure($this->lng->txt($e->getMessage()),true);
                 }
 
                 $this->edit();
         }

Here is the call graph for this function:

◆ setLessFile()

ilSystemStyleLessGUI::setLessFile ( $less_file )

Parameters

ilSystemStyleLessFile $less_file

Definition at line 339 of file class.ilSystemStyleLessGUI.php.

References $less_file.

Referenced by __construct(), and reset().

         {
                 $this->less_file = $less_file;
         }

Here is the caller graph for this function:

◆ setMessageStack()

ilSystemStyleLessGUI::setMessageStack ( $message_stack )

Parameters

ilSystemStyleMessageStack $message_stack

Definition at line 355 of file class.ilSystemStyleLessGUI.php.

References $message_stack.

Referenced by __construct().

         {
                 $this->message_stack = $message_stack;
         }

Here is the caller graph for this function:

◆ setStyleContainer()

ilSystemStyleLessGUI::setStyleContainer ( $style_container )

Parameters

ilSystemStyleSkinContainer $style_container

Definition at line 323 of file class.ilSystemStyleLessGUI.php.

References $style_container.

Referenced by __construct().

         {
                 $this->style_container = $style_container;
         }

Here is the caller graph for this function:

◆ update()

ilSystemStyleLessGUI::update ( )

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

References $_GET, getLessFile(), getStyleContainer(), initSystemStyleLessForm(), ilUtil\sendFailure(), and ilUtil\sendSuccess().

         {
                 $form = $this->initSystemStyleLessForm();
                 if ($form->checkInput())
                 {
                         foreach($this->getLessFile()->getCategories() as $category){
                                 foreach($this->getLessFile()->getVariablesPerCategory($category->getName()) as $variable){
                                         $variable->setValue($form->getInput($variable->getName()));
                                 }
                         }
                         try{
                                 $this->getLessFile()->write();
                                 $this->getStyleContainer()->compileLess($_GET["style_id"]);
                                 $skin = $this->getStyleContainer()->getSkin();
                                 $skin->getVersionStep($skin->getVersion());
                                 $this->getStyleContainer()->updateSkin($skin);
                                 ilUtil::sendSuccess($this->lng->txt("less_file_updated"));
                         }catch(Exception $e){
                                 ilUtil::sendFailure($this->lng->txt($e->getMessage()),true);
                         }
                 }
 
                 $form->setValuesByPost();
                 $this->tpl->setContent($form->getHTML());
 
         }