Collaboration diagram for ilSystemStyleLessFile:

Public Member Functions
	__construct ($less_variables_file)
	KitchenSinkLessFile constructor. More...

	read ()
	Reads the file from the file system. More...

	write ()
	Write the complete file back to the file system (including comments and random content) More...

	getContent ()

	addItem (ilSystemStyleLessItem $item)

	getCategories ()

	getVariablesPerCategory ($category="")

	getItemById ($id)

	getVariableByName ($name="")

	getReferencesToVariable ($variable_name)

	getReferencesToVariableAsString ($variable_name)

	getLessVariablesFile ()

	setLessVariablesFile ($less_variables_file)

	getItems ()

	getCommentsIds ()

	getVariablesIds ()

	getCategoriesIds ()

Protected Attributes
	$items = array()

	$comments_ids = array()

	$variables_ids = array()

	$categories_ids = array()

	$less_variables_file_path = ""

Detailed Description

Definition at line 16 of file class.ilSystemStyleLessFile.php.

Constructor & Destructor Documentation

◆ __construct()

ilSystemStyleLessFile::__construct ( $less_variables_file )

KitchenSinkLessFile constructor.

Parameters

string $less_variables_file

Definition at line 57 of file class.ilSystemStyleLessFile.php.

    {
        $this->less_variables_file = $less_variables_file;
        $this->read();
    }

References read().

Here is the call graph for this function:

Member Function Documentation

◆ addItem()

ilSystemStyleLessFile::addItem ( ilSystemStyleLessItem $item )

Parameters

ilSystemStyleLessItem $item

Returns: int

Definition at line 175 of file class.ilSystemStyleLessFile.php.

    {
        $id = array_push($this->items, $item)-1;
 
 
        if (get_class($item)=="ilSystemStyleLessComment") {
            $this->comments_ids[] = $id;
        } elseif (get_class($item)=="ilSystemStyleLessCategory") {
            $this->categories_ids[] = $id;
        } elseif (get_class($item)=="ilSystemStyleLessVariable") {
            $this->variables_ids[] = $id;
        }
 
        return $id;
    }

References $id.

Referenced by read().

Here is the caller graph for this function:

◆ getCategories()

ilSystemStyleLessFile::getCategories ( )

Returns: ilSystemStyleLessCategory[]

Definition at line 194 of file class.ilSystemStyleLessFile.php.

    {
        $categories = array();
 
        foreach ($this->categories_ids as $category_id) {
            $categories[] = $this->items[$category_id];
        }
 
        return $categories;
    }

◆ getCategoriesIds()

ilSystemStyleLessFile::getCategoriesIds ( )

Returns: array

Definition at line 319 of file class.ilSystemStyleLessFile.php.

    {
        return $this->categories_ids;
    }

References $categories_ids.

◆ getCommentsIds()

ilSystemStyleLessFile::getCommentsIds ( )

Returns: array

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

    {
        return $this->comments_ids;
    }

References $comments_ids.

◆ getContent()

ilSystemStyleLessFile::getContent ( )

Returns: string

Definition at line 161 of file class.ilSystemStyleLessFile.php.

    {
        $output = "";
 
        foreach ($this->items as $item) {
            $output .= $item->__toString();
        }
        return $output;
    }

References $output.

Referenced by write().

Here is the caller graph for this function:

◆ getItemById()

ilSystemStyleLessFile::getItemById ( $id )

Parameters

$id

Returns: ilSystemStyleLessVariable

Definition at line 226 of file class.ilSystemStyleLessFile.php.

    {
        return $this->items[$id];
    }

References $id.

Referenced by read().

Here is the caller graph for this function:

◆ getItems()

ilSystemStyleLessFile::getItems ( )

Returns: ilSystemStyleLessVariable[]

Definition at line 295 of file class.ilSystemStyleLessFile.php.

    {
        return $this->items;
    }

References $items.

◆ getLessVariablesFile()

ilSystemStyleLessFile::getLessVariablesFile ( )

Returns: string

Definition at line 279 of file class.ilSystemStyleLessFile.php.

    {
        return $this->less_variables_file;
    }

Referenced by read(), and write().

Here is the caller graph for this function:

◆ getReferencesToVariable()

ilSystemStyleLessFile::getReferencesToVariable ( $variable_name )

Parameters

$variable_name

Returns: array

Definition at line 249 of file class.ilSystemStyleLessFile.php.

    {
        $references = [];
 
        foreach ($this->variables_ids as $id) {
            foreach ($this->items[$id]->getReferences() as $reference) {
                if ($variable_name == $reference) {
                    $references[] = $this->items[$id]->getName();
                }
            }
        }
        return $references;
    }

References $id.

Referenced by getReferencesToVariableAsString().

Here is the caller graph for this function:

◆ getReferencesToVariableAsString()

ilSystemStyleLessFile::getReferencesToVariableAsString ( $variable_name )

Parameters

$variable_name

Returns: string

Definition at line 267 of file class.ilSystemStyleLessFile.php.

    {
        $references_string = "";
        foreach ($this->getReferencesToVariable($variable_name) as $reference) {
            $references_string .= "$reference; ";
        }
        return $references_string;
    }

References getReferencesToVariable().

Here is the call graph for this function:

◆ getVariableByName()

ilSystemStyleLessFile::getVariableByName ( $name = "" )

Parameters

string $name

Returns: ilSystemStyleLessVariable|null

Definition at line 235 of file class.ilSystemStyleLessFile.php.

    {
        foreach ($this->variables_ids as $variables_id) {
            if ($this->items[$variables_id]->getName() == $name) {
                return $this->items[$variables_id];
            }
        }
        return null;
    }

References $name.

◆ getVariablesIds()

ilSystemStyleLessFile::getVariablesIds ( )

Returns: array

Definition at line 311 of file class.ilSystemStyleLessFile.php.

    {
        return $this->variables_ids;
    }

References $variables_ids.

◆ getVariablesPerCategory()

ilSystemStyleLessFile::getVariablesPerCategory ( $category = "" )

Parameters

string $category

Returns: ilSystemStyleLessVariable[]|null

Definition at line 209 of file class.ilSystemStyleLessFile.php.

    {
        $variables = array();
 
        foreach ($this->variables_ids as $variables_id) {
            if (!$category || $this->items[$variables_id]->getCategoryName() == $category) {
                $variables[] = $this->items[$variables_id];
            }
        }
 
        return $variables;
    }

◆ read()

ilSystemStyleLessFile::read ( )

Reads the file from the file system.

Exceptions

ilSystemStyleException

Definition at line 68 of file class.ilSystemStyleLessFile.php.

    {
        $last_variable_comment = null;
        $last_category_id = null;
        $last_category_name = null;
 
        $regex_category = '/\/\/==\s(.*)/'; //Matches //== Category Name
        $regex_category_by_line = '/^\/\/[\s]?$/'; //Matches // at the end of the line with not comment
        $regex_category_comment = '/\/\/##\s(.*)/'; //Matches Matches //## Category Description
        $regex_variable = '/^@(.*)/'; //Matches @VariableName value;
        $regex_variable_comment = '/\/\/\*\*\s(.*)/'; //Matches //** Variable Comment
        $regex_variable_name = '/(?:@)(.*)(?:\:)/'; //Matches @variableName
        $regex_variable_value = '/(?::)(.*)(?:;)/'; //Matches value;
        $regex_variable_references = '/(?:@)([a-zA-Z0-9_-]*)/'; //Matches references in value
 
        try {
            $handle = fopen($this->getLessVariablesFile(), "r");
        } catch (Exception $e) {
            throw new ilSystemStyleException(ilSystemStyleException::FILE_OPENING_FAILED, $this->getLessVariablesFile());
        }
 
 
        if ($handle) {
            $line_number = 1;
            $last_line_is_category = false;
            //Reads file line by line
            while (($line = fgets($handle)) !== false) {
                //This might be part of the categories structure, if so, ignore
                if ($last_line_is_category && preg_match($regex_category_by_line, $line, $out)) {
                    $line = fgets($handle);
                }
                $last_line_is_category = false;
                if (preg_match($regex_category, $line, $out)) {
                    //Check Category
                    $last_category_id = $this->addItem(new ilSystemStyleLessCategory($out[1]));
                    $last_category_name = $out[1];
                    $last_line_is_category = true;
                } elseif (preg_match($regex_category_comment, $line, $out)) {
                    //Check Comment Category
                    $last_category = $this->getItemById($last_category_id);
                    $last_category->setComment($out[1]);
                } elseif (preg_match($regex_variable_comment, $line, $out)) {
                    //Check Variables Comment
                    $last_variable_comment = $out[1];
                } elseif (preg_match($regex_variable, $line, $out)) {
                    //Check Variables
 
                    //Name
                    preg_match($regex_variable_name, $out[0], $variable);
 
                    //Value
                    preg_match($regex_variable_value, $line, $value);
 
                    //References
                    $temp_value = $value[0];
                    $references = array();
                    while (preg_match($regex_variable_references, $temp_value, $reference)) {
                        $references[] = $reference[1];
                        $temp_value = str_replace($reference, "", $temp_value);
                    }
 
                    $this->addItem(new ilSystemStyleLessVariable(
                        $variable[1],
                        ltrim($value[1], " \t\n\r\0\x0B"),
                        $last_variable_comment,
                        $last_category_name,
                        $references
                    ));
                    $last_variable_comment = "";
                } else {
                    $this->addItem(new ilSystemStyleLessComment($line));
                }
 
 
                $line_number++;
            }
            fclose($handle);
        } else {
            throw new ilSystemStyleException(ilSystemStyleException::FILE_OPENING_FAILED);
        }
    }

References $out, addItem(), ilSystemStyleException\FILE_OPENING_FAILED, getItemById(), and getLessVariablesFile().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setLessVariablesFile()

ilSystemStyleLessFile::setLessVariablesFile ( $less_variables_file )

Parameters

string $less_variables_file

Definition at line 287 of file class.ilSystemStyleLessFile.php.

    {
        $this->less_variables_file = $less_variables_file;
    }

◆ write()

ilSystemStyleLessFile::write ( )

Write the complete file back to the file system (including comments and random content)

Definition at line 153 of file class.ilSystemStyleLessFile.php.

    {
        file_put_contents($this->getLessVariablesFile(), $this->getContent());
    }

References getContent(), and getLessVariablesFile().

Here is the call graph for this function:

Field Documentation

◆ $categories_ids

ilSystemStyleLessFile::$categories_ids = array()

protected

Definition at line 44 of file class.ilSystemStyleLessFile.php.

Referenced by getCategoriesIds().

◆ $comments_ids

ilSystemStyleLessFile::$comments_ids = array()

protected

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

Referenced by getCommentsIds().

◆ $items

ilSystemStyleLessFile::$items = array()

protected

Definition at line 23 of file class.ilSystemStyleLessFile.php.

Referenced by getItems().

◆ $less_variables_file_path

ilSystemStyleLessFile::$less_variables_file_path = ""

protected

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

◆ $variables_ids

ilSystemStyleLessFile::$variables_ids = array()

protected

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

Referenced by getVariablesIds().

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

Services/Style/System/classes/Less/class.ilSystemStyleLessFile.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addItem()

◆ getCategories()

◆ getCategoriesIds()

◆ getCommentsIds()

◆ getContent()

◆ getItemById()

◆ getItems()

◆ getLessVariablesFile()

◆ getReferencesToVariable()

◆ getReferencesToVariableAsString()

◆ getVariableByName()

◆ getVariablesIds()

◆ getVariablesPerCategory()

◆ read()

◆ setLessVariablesFile()

◆ write()

Field Documentation

◆ $categories_ids

◆ $comments_ids

◆ $items

◆ $less_variables_file_path

◆ $variables_ids