ilSystemStyleLessFile Class Reference

Collaboration diagram for ilSystemStyleLessFile:

Public Member Functions
	__construct (string $less_variables_file_path_name)
	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 (string $category='')
	getItemById (int $id)
	getVariableByName (string $name='')
	getReferencesToVariable (string $variable_name)
	getReferencesToVariableAsString (string $variable_name)
	getRefAndCommentAsString (string $variable_name, string $refs_wording)
	getLessVariablesFilePathName ()
	setLessVariablesFilePathName (string $less_variables_file_path_name)
	getItems ()
	getCommentsIds ()
	getVariablesIds ()
	getCategoriesIds ()

Protected Attributes
array	$items = []
array	$comments_ids = []
	Separated array with all comments ids (performance reasons) More...
array	$variables_ids = []
	Separated array with all variable ids (performance reasons) More...
array	$categories_ids = []
	Separated array with all category ids (performance reasons) More...
string	$less_variables_file_path_name = ''
	Complete path the the variables file on the file system. More...

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilSystemStyleLessFile::__construct

(

string

$less_variables_file_path_name

)

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

References $less_variables_file_path_name, and read().

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

Here is the call graph for this function:

Member Function Documentation

addItem()

ilSystemStyleLessFile::addItem

(

ilSystemStyleLessItem

$item

)

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

References $id.

Referenced by read().

                                                        : int
    {
        $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;
    }

Here is the caller graph for this function:

getCategories()

ilSystemStyleLessFile::getCategories

(

)

Returns

ilSystemStyleLessCategory[]

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

                                   : array
    {
        $categories = [];

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

        return $categories;
    }

getCategoriesIds()

ilSystemStyleLessFile::getCategoriesIds

(

)

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

References $categories_ids.

                                      : array
    {
        return $this->categories_ids;
    }

getCommentsIds()

ilSystemStyleLessFile::getCommentsIds

(

)

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

References $comments_ids.

                                    : array
    {
        return $this->comments_ids;
    }

getContent()

ilSystemStyleLessFile::getContent

(

)

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

Referenced by write().

                                : string
    {
        $output = '';

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

Here is the caller graph for this function:

getItemById()

ilSystemStyleLessFile::getItemById

(

int

$id

)

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

References $id.

Referenced by read().

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

Here is the caller graph for this function:

getItems()

ilSystemStyleLessFile::getItems

(

)

Returns

ilSystemStyleLessVariable[]

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

References $items.

                              : array
    {
        return $this->items;
    }

getLessVariablesFilePathName()

ilSystemStyleLessFile::getLessVariablesFilePathName

(

)

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

References $less_variables_file_path_name.

Referenced by read(), and write().

                                                  : string
    {
        return $this->less_variables_file_path_name;
    }

Here is the caller graph for this function:

getRefAndCommentAsString()

ilSystemStyleLessFile::getRefAndCommentAsString	(	string	$variable_name,
		string	$refs_wording
	)

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

References getReferencesToVariable(), and getVariableByName().

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

        $variable = $this->getVariableByName($variable_name);

        if ($references_string != '') {
            if ($variable->getComment()) {
                $info = $variable->getComment() . '</br>' . $refs_wording . ' ' . $references_string;
            } else {
                $info = $refs_wording . ' ' . $references_string;
            }
        } else {
            $info = $variable->getComment();
        }

        return $info;
    }

Here is the call graph for this function:

getReferencesToVariable()

ilSystemStyleLessFile::getReferencesToVariable

(

string

$variable_name

)

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

References $id.

Referenced by getRefAndCommentAsString(), and getReferencesToVariableAsString().

                                                                  : array
    {
        $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;
    }

Here is the caller graph for this function:

getReferencesToVariableAsString()

ilSystemStyleLessFile::getReferencesToVariableAsString

(

string

$variable_name

)

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

References getReferencesToVariable().

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

Here is the call graph for this function:

getVariableByName()

ilSystemStyleLessFile::getVariableByName

(

string

$name = ''

)

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

References $name.

Referenced by getRefAndCommentAsString().

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

Here is the caller graph for this function:

getVariablesIds()

ilSystemStyleLessFile::getVariablesIds

(

)

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

References $variables_ids.

                                     : array
    {
        return $this->variables_ids;
    }

getVariablesPerCategory()

ilSystemStyleLessFile::getVariablesPerCategory

(

string

$category = ''

)

Returns

ilSystemStyleLessVariable[]

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

                                                                  : array
    {
        $variables = [];

        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 63 of file class.ilSystemStyleLessFile.php.

References Vendor\Package\$e, $out, addItem(), ilSystemStyleException\FILE_OPENING_FAILED, getItemById(), and getLessVariablesFilePathName().

Referenced by __construct().

                          : void
    {
        $last_variable_comment = '';
        $last_category_id = '';
        $last_category_name = '';

        $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->getLessVariablesFilePathName(), 'r');
        } catch (Exception $e) {
            throw new ilSystemStyleException(
                ilSystemStyleException::FILE_OPENING_FAILED,
                $this->getLessVariablesFilePathName()
            );
        }

        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 = [];
                    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]),
                        $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);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setLessVariablesFilePathName()

ilSystemStyleLessFile::setLessVariablesFilePathName

(

string

$less_variables_file_path_name

)

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

References $less_variables_file_path_name.

                                                                                       : void
    {
        $this->less_variables_file_path_name = $less_variables_file_path_name;
    }

write()

ilSystemStyleLessFile::write

(

)

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

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

References getContent(), and getLessVariablesFilePathName().

Referenced by ilSkinStyleLessFileTest\testReadWriteDoubleFullLess(), and ilSystemStyleStyleLessFileTest\testReadWriteDoubleFullLess().

                           : void
    {
        file_put_contents($this->getLessVariablesFilePathName(), $this->getContent());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$categories_ids

array ilSystemStyleLessFile::$categories_ids = []

protected

Separated array with all category ids (performance reasons)

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

Referenced by getCategoriesIds().

$comments_ids

array ilSystemStyleLessFile::$comments_ids = []

protected

Separated array with all comments ids (performance reasons)

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

Referenced by getCommentsIds().

$items

array ilSystemStyleLessFile::$items = []

protected

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

Referenced by getItems().

$less_variables_file_path_name

string ilSystemStyleLessFile::$less_variables_file_path_name = ''

protected

Complete path the the variables file on the file system.

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

Referenced by __construct(), getLessVariablesFilePathName(), and setLessVariablesFilePathName().

$variables_ids

array ilSystemStyleLessFile::$variables_ids = []

protected

Separated array with all variable ids (performance reasons)

Definition at line 41 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