ilSystemStyleScssSettingsFile Class Reference

Collaboration diagram for ilSystemStyleScssSettingsFile:

Public Member Functions
	__construct (string $scss_variables_settings_path, string $file_name)
	write (string $scss_variables_settings_path="")
	Write the complete file back to the file system (including comments and random content) More...
	getContent ()
	addItem (ilSystemStyleScssItem $item)
	getCategories ()
	getVariables ()
	getItems ()
	getScssVariablesSettingsPath ()

Protected Member Functions
	openFile (string $scss_variables_settings_path)
	readFile (string $scss_variables_settings_path)
	Reads the file from the file system. More...
	getItemById (int $id)

Protected Attributes
array	$items = []
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	$scss_variables_settings_path
	Complete path to the settings file. More...
string	$file_name

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilSystemStyleScssSettingsFile::__construct	(	string	$scss_variables_settings_path,
		string	$file_name
	)

Definition at line 50 of file class.ilSystemStyleScssSettingsFile.php.

References $file_name, $scss_variables_settings_path, and openFile().

    {
        $this->file_name = $file_name;
        $this->scss_variables_settings_path = $scss_variables_settings_path;
        $this->openFile($scss_variables_settings_path);
    }

Here is the call graph for this function:

Member Function Documentation

addItem()

ilSystemStyleScssSettingsFile::addItem

(

ilSystemStyleScssItem

$item

)

Definition at line 180 of file class.ilSystemStyleScssSettingsFile.php.

References $id.

Referenced by readFile().

                                                        : int
    {
        $id = array_push($this->items, $item) - 1;

        if (get_class($item) == ilSystemStyleScssCategory::class) {
            $this->categories_ids[] = $id;
        } elseif (get_class($item) == ilSystemStyleScssVariable::class) {
            $this->variables_ids[] = $id;
        }

        return $id;
    }

Here is the caller graph for this function:

getCategories()

ilSystemStyleScssSettingsFile::getCategories

(

)

Returns

ilSystemStyleScssCategory[]

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

                                   : array
    {
        $categories = [];

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

        return $categories;
    }

getContent()

ilSystemStyleScssSettingsFile::getContent

(

)

Definition at line 170 of file class.ilSystemStyleScssSettingsFile.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()

ilSystemStyleScssSettingsFile::getItemById ( int  $id )

protected

Definition at line 223 of file class.ilSystemStyleScssSettingsFile.php.

References $id.

Referenced by readFile().

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

Here is the caller graph for this function:

getItems()

ilSystemStyleScssSettingsFile::getItems

(

)

Definition at line 228 of file class.ilSystemStyleScssSettingsFile.php.

References $items.

                              : array
    {
        return $this->items;
    }

getScssVariablesSettingsPath()

ilSystemStyleScssSettingsFile::getScssVariablesSettingsPath

(

)

Returns

string

Definition at line 236 of file class.ilSystemStyleScssSettingsFile.php.

References $scss_variables_settings_path.

                                                  : string
    {
        return $this->scss_variables_settings_path;
    }

getVariables()

ilSystemStyleScssSettingsFile::getVariables

(

)

Returns

ilSystemStyleScssCategory[]

Definition at line 211 of file class.ilSystemStyleScssSettingsFile.php.

                                  : array
    {
        $variables = [];

        foreach ($this->variables_ids as $variable_id) {
            $variable = $this->items[$variable_id];
            $variables[$variable->getName()] = $variable;
        }

        return $variables;
    }

openFile()

ilSystemStyleScssSettingsFile::openFile ( string  $scss_variables_settings_path )

protected

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

References ilSystemStyleException\FILE_OPENING_FAILED, and readFile().

Referenced by __construct().

                                                                     : void
    {
        if (is_file($scss_variables_settings_path.'/'.$this->file_name)) {
            $this->readFile($scss_variables_settings_path);
        } else {
            throw new ilSystemStyleException(
                ilSystemStyleException::FILE_OPENING_FAILED,
                $scss_variables_settings_path
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

readFile()

ilSystemStyleScssSettingsFile::readFile ( string  $scss_variables_settings_path )

protected

Reads the file from the file system.

Exceptions

ilSystemStyleException

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

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

Referenced by openFile().

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

        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 ilSystemStyleScssCategory($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);
                    }

                    //do not store the !default attribute in the variable
                    $value = str_replace(' !default', '', ltrim($value[1]));

                    $this->addItem(new ilSystemStyleScssVariable(
                        $variable[1],
                        $value,
                        $last_variable_comment,
                        $last_category_name,
                        $references
                    ));
                    $last_variable_comment = '';
                } else {
                    $this->addItem(new ilSystemStyleScssComment($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:

write()

ilSystemStyleScssSettingsFile::write

(

string

$scss_variables_settings_path = ""

)

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

Definition at line 160 of file class.ilSystemStyleScssSettingsFile.php.

References $path, $scss_variables_settings_path, and getContent().

                                                                    : void
    {
        if ($scss_variables_settings_path == "") {
            $path = $this->scss_variables_settings_path;
        } else {
            $path = $scss_variables_settings_path ;
        }
        file_put_contents($path . $this->file_name, $this->getContent());
    }

Here is the call graph for this function:

Field Documentation

$categories_ids

array ilSystemStyleScssSettingsFile::$categories_ids = []

protected

Separated array with all category ids (performance reasons)

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

$file_name

string ilSystemStyleScssSettingsFile::$file_name

protected

Definition at line 48 of file class.ilSystemStyleScssSettingsFile.php.

Referenced by __construct().

$items

array ilSystemStyleScssSettingsFile::$items = []

protected

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

Referenced by getItems().

$scss_variables_settings_path

string ilSystemStyleScssSettingsFile::$scss_variables_settings_path

protected

Complete path to the settings file.

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

Referenced by __construct(), getScssVariablesSettingsPath(), and write().

$variables_ids

array ilSystemStyleScssSettingsFile::$variables_ids = []

protected

Separated array with all variable ids (performance reasons)

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

---

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

• Services/Style/System/classes/Scss/class.ilSystemStyleScssSettingsFile.php