Inheritance diagram for ILIAS\UI\Implementation\Crawler\EntriesYamlParser:

Collaboration diagram for ILIAS\UI\Implementation\Crawler\EntriesYamlParser:

Public Member Functions
	__construct ()
	FactoryCrawler constructor. More...

	parseYamlStringArrayFromFile (string $filePath)

	parseArrayFromFile (string $filePath)

	parseEntriesFromFile (string $filePath)

	parseYamlStringArrayFromString (string $content)

	parseArrayFromString (string $content)

	parseEntriesFromString (string $content)
	Returns a list UI Component Entries of the parsed YAML entries in a given string. More...

Static Public Member Functions
static	toUpperCamelCase (string $string, string $seperator)

static	toLowerCamelCase (string $string, string $seperator)

static	fromCamelCaseToWords (string $camelCaseString)

Data Fields
const	PARSER_STATE_OUTSIDE = 1

const	PARSER_STATE_ENTRY = 2

const	PARSER_STATE_SEEKING_RETURN = 3

const	PARSER_STATE_SEEKING_FUNCTION_NAME = 4

Protected Member Functions
	getFileContentAsString (string $filePath)

	getYamlEntriesFromString (string $content)

	purifyYamlLine (string $line)

	getPHPArrayFromYamlArray (array $yaml_entries)

	getEntriesFromArray (array $entries_array)

	getEntryFromData (array $entry_data)

Protected Attributes
array	$items = array()

Exception Factory	$ef = null

string	$file_path = "none"
	Used to add for Information in Exceptions. More...

Detailed Description

Definition at line 30 of file EntriesYamlParser.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\UI\Implementation\Crawler\EntriesYamlParser::__construct ( )

FactoryCrawler constructor.

Definition at line 48 of file EntriesYamlParser.php.

     {
         $this->ef = new Exception\Factory();
     }

Member Function Documentation

◆ fromCamelCaseToWords()

static ILIAS\UI\Implementation\Crawler\EntriesYamlParser::fromCamelCaseToWords ( string $camelCaseString )

static

Definition at line 319 of file EntriesYamlParser.php.

                                                                         : string
     {
         return implode(' ', preg_split('/(?<=[a-z])(?=[A-Z])/x', ucwords($camelCaseString)));
     }

◆ getEntriesFromArray()

ILIAS\UI\Implementation\Crawler\EntriesYamlParser::getEntriesFromArray ( array $entries_array )

protected

Definition at line 252 of file EntriesYamlParser.php.

References ILIAS\UI\Implementation\Crawler\EntriesYamlParser\getEntryFromData().

Referenced by ILIAS\UI\Implementation\Crawler\EntriesYamlParser\parseEntriesFromString().

                                                                 : Entry\ComponentEntries
     {
         $entries = new Entry\ComponentEntries();
 
         foreach ($entries_array as $entry_data) {
             $entries->addEntry($this->getEntryFromData($entry_data));
         }
 
         return $entries;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getEntryFromData()

ILIAS\UI\Implementation\Crawler\EntriesYamlParser::getEntryFromData ( array $entry_data )

protected

Exceptions

Exception

Definition at line 266 of file EntriesYamlParser.php.

References Vendor\Package\$e, and ILIAS\UI\Implementation\Crawler\EntriesYamlParser\$file_path.

Referenced by ILIAS\UI\Implementation\Crawler\EntriesYamlParser\getEntriesFromArray().

                                                           : Entry\ComponentEntry
     {
         $entry_data['title'] = self::fromCamelCaseToWords($entry_data['function_name']);
 
         if (!array_key_exists("title", $entry_data) || !$entry_data['title'] || $entry_data['title'] == "") {
             throw $this->ef->exception(Exception\CrawlerException::ENTRY_TITLE_MISSING, " File: " . $this->file_path);
         }
         if (!array_key_exists("namespace", $entry_data) || !$entry_data['namespace'] || $entry_data['namespace'] == "") {
             throw $this->ef->exception(Exception\CrawlerException::ENTRY_WITH_NO_VALID_RETURN_STATEMENT, " File: " . $this->file_path);
         }
         $entry_data['namespace'] = str_replace('[]', '', $entry_data['namespace']);
 
         $entry_data['id'] = str_replace(
             "\\",
             "",
             str_replace("\\ILIAS\\UI\\", "", str_replace("\\ILIAS\\UI\\Component\\", "", $entry_data['namespace']))
         )
                 . self::toUpperCamelCase($entry_data['title'], ' ');
         $entry_data['abstract'] = preg_match("/Factory/", $entry_data['namespace']);
         $entry_data['path'] = str_replace("/ILIAS/UI", "components/ILIAS/UI/src", str_replace("\\", "/", $entry_data['namespace']));
 
         if (str_contains($entry_data['path'], 'tests/UI/')) {
             $entry_data['path'] = str_replace("tests/UI/", "components/ILIAS/UI/tests/", $entry_data['path']);
         }
 
         try {
             $entry = new Entry\ComponentEntry($entry_data);
         } catch (\Exception $e) {
             throw $this->ef->exception(
                 Exception\CrawlerException::PARSING_YAML_ENTRY_FAILED,
                 " could not convert data to entry, message: '" . $e->getMessage() . "' file: " . $this->file_path
             );
         }
 
         return $entry;
     }

Here is the caller graph for this function:

◆ getFileContentAsString()

ILIAS\UI\Implementation\Crawler\EntriesYamlParser::getFileContentAsString ( string $filePath )

protected

Exceptions

Exception

Definition at line 110 of file EntriesYamlParser.php.

Referenced by ILIAS\UI\Implementation\Crawler\EntriesYamlParser\parseArrayFromFile(), ILIAS\UI\Implementation\Crawler\EntriesYamlParser\parseEntriesFromFile(), and ILIAS\UI\Implementation\Crawler\EntriesYamlParser\parseYamlStringArrayFromFile().

                                                                : string
     {
         if (!file_exists($filePath)) {
             throw $this->ef->exception(Exception\CrawlerException::INVALID_FILE_PATH, $filePath);
         }
         $content = file_get_contents($filePath);
         if (!$content) {
             throw $this->ef->exception(Exception\CrawlerException::FILE_OPENING_FAILED, $filePath);
         }
         return $content;
     }

Here is the caller graph for this function:

◆ getPHPArrayFromYamlArray()

ILIAS\UI\Implementation\Crawler\EntriesYamlParser::getPHPArrayFromYamlArray ( array $yaml_entries )

protected

Exceptions

Exception

Definition at line 227 of file EntriesYamlParser.php.

References Vendor\Package\$e.

Referenced by ILIAS\UI\Implementation\Crawler\ExamplesYamlParser\getYamlEntriesFromString(), and ILIAS\UI\Implementation\Crawler\EntriesYamlParser\parseArrayFromString().

                                                                     : array
     {
         $entries = array();
         $parser = new Yaml\Parser();
 
         foreach ($yaml_entries as $yaml_entry) {
             try {
                 $entries[] = $parser->parse($yaml_entry);
             } catch (\Exception $e) {
                 throw $this->ef->exception(Exception\CrawlerException::PARSING_YAML_ENTRY_FAILED, " file: " . $this->file_path . "; " . $e);
             }
         }
 
 
         array_walk_recursive($entries, function (&$item) {
             if (!is_null($item)) {
                 $item = rtrim($item, PHP_EOL);
             } else {
                 $item = '';
             }
         });
 
         return $entries;
     }

Here is the caller graph for this function:

◆ getYamlEntriesFromString()

ILIAS\UI\Implementation\Crawler\EntriesYamlParser::getYamlEntriesFromString ( string $content )

protected

Exceptions

Exception

Definition at line 125 of file EntriesYamlParser.php.

References ILIAS\UI\Implementation\Crawler\EntriesYamlParser\purifyYamlLine().

Referenced by ILIAS\UI\Implementation\Crawler\EntriesYamlParser\parseArrayFromString(), and ILIAS\UI\Implementation\Crawler\EntriesYamlParser\parseYamlStringArrayFromString().

                                                                 : array
     {
         $parser_state = self::PARSER_STATE_OUTSIDE;
         $current_entry = "";
         $yaml_entries = array();
 
         foreach (preg_split("/((\r?\n)|(\r\n?))/", $content) as $line) {
             if ($parser_state === self::PARSER_STATE_OUTSIDE) {
                 if (preg_match('/---/', $line)) {
                     $current_entry = "";
                     $parser_state = self::PARSER_STATE_ENTRY;
                 }
                 if (preg_match('/\@return/', $line)) {
                     throw $this->ef->exception(
                         Exception\CrawlerException::ENTRY_WITH_NO_YAML_DESCRIPTION,
                         " in file: " . $this->file_path . ", " . $line
                     );
                 }
                 if (preg_match('/public function (.*)\(/', $line)) {
                     throw $this->ef->exception(
                         Exception\CrawlerException::ENTRY_WITH_NO_YAML_DESCRIPTION,
                         " in file: " . $this->file_path . ", " . $line
                     );
                 }
             } elseif ($parser_state === self::PARSER_STATE_ENTRY) {
                 if (!preg_match('/(\*$)|(---)/', $line)) {
                     $current_entry .= $this->purifyYamlLine($line);
                 }
                 if (preg_match('/---/', $line)) {
                     $parser_state = self::PARSER_STATE_SEEKING_RETURN;
                 }
                 if (preg_match('/\@return/', $line)) {
                     throw $this->ef->exception(
                         Exception\CrawlerException::ENTRY_WITH_NO_YAML_DESCRIPTION,
                         " in file: " . $this->file_path . ", " . $line
                     );
                 }
                 if (preg_match('/public function (.*)\(/', $line)) {
                     throw $this->ef->exception(
                         Exception\CrawlerException::ENTRY_WITH_NO_YAML_DESCRIPTION,
                         " in file: " . $this->file_path . ", " . $line
                     );
                 }
             } elseif ($parser_state === self::PARSER_STATE_SEEKING_RETURN) {
                 if (preg_match('/\@return/', $line)) {
                     $current_entry .= "namespace: " . ltrim($this->purifyYamlLine($line), '@return');
                     $parser_state = self::PARSER_STATE_SEEKING_FUNCTION_NAME;
                 }
                 if (preg_match('/---/', $line)) {
                     throw $this->ef->exception(
                         Exception\CrawlerException::ENTRY_WITH_NO_VALID_RETURN_STATEMENT,
                         " in file: " . $this->file_path . " line " . $current_entry
                     );
                 }
                 if (preg_match('/public function (.*)\(/', $line)) {
                     throw $this->ef->exception(
                         Exception\CrawlerException::ENTRY_WITH_NO_VALID_RETURN_STATEMENT,
                         " in file: " . $this->file_path . " line " . $current_entry
                     );
                 }
             } else {
                 if (preg_match('/public function (.*)\(/', $line, $matches)) {
                     preg_match('/public function (.*)\(/', $line, $matches);
                     $current_entry .= "function_name: " . $matches[1];
                     $yaml_entries[] = $current_entry;
                     $parser_state = self::PARSER_STATE_OUTSIDE;
                 }
                 if (preg_match('/---/', $line)) {
                     throw $this->ef->exception(
                         Exception\CrawlerException::ENTRY_WITHOUT_FUNCTION,
                         " in file: " . $this->file_path . " line " . $current_entry
                     );
                 }
             }
         }
         if ($parser_state === self::PARSER_STATE_SEEKING_RETURN) {
             throw $this->ef->exception(
                 Exception\CrawlerException::ENTRY_WITH_NO_VALID_RETURN_STATEMENT,
                 " in file: " . $this->file_path . " line " . $current_entry
             );
         } elseif ($parser_state === self::PARSER_STATE_ENTRY) {
             throw $this->ef->exception(
                 Exception\CrawlerException::ENTRY_WITH_NO_YAML_DESCRIPTION,
                 " in file: " . $this->file_path
             );
         } elseif ($parser_state === self::PARSER_STATE_SEEKING_FUNCTION_NAME) {
             throw $this->ef->exception(
                 Exception\CrawlerException::ENTRY_WITHOUT_FUNCTION,
                 " in file: " . $this->file_path
             );
         }
         return $yaml_entries;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseArrayFromFile()

ILIAS\UI\Implementation\Crawler\EntriesYamlParser::parseArrayFromFile ( string $filePath )

Exceptions

Exception

Implements ILIAS\UI\Implementation\Crawler\YamlParser.

Definition at line 66 of file EntriesYamlParser.php.

References ILIAS\UI\Implementation\Crawler\EntriesYamlParser\getFileContentAsString(), and ILIAS\UI\Implementation\Crawler\EntriesYamlParser\parseArrayFromString().

                                                         : array
     {
         $this->file_path = $filePath;
         $content = $this->getFileContentAsString($filePath);
         return $this->parseArrayFromString($content);
     }

Here is the call graph for this function:

◆ parseArrayFromString()

ILIAS\UI\Implementation\Crawler\EntriesYamlParser::parseArrayFromString ( string $content )

Exceptions

Exception

Implements ILIAS\UI\Implementation\Crawler\YamlParser.

Definition at line 94 of file EntriesYamlParser.php.

References ILIAS\UI\Implementation\Crawler\EntriesYamlParser\getPHPArrayFromYamlArray(), and ILIAS\UI\Implementation\Crawler\EntriesYamlParser\getYamlEntriesFromString().

Referenced by ILIAS\UI\Implementation\Crawler\EntriesYamlParser\parseArrayFromFile(), and ILIAS\UI\Implementation\Crawler\EntriesYamlParser\parseEntriesFromString().

                                                          : array
     {
         return $this->getPHPArrayFromYamlArray(
             $this->getYamlEntriesFromString($content)
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseEntriesFromFile()

ILIAS\UI\Implementation\Crawler\EntriesYamlParser::parseEntriesFromFile ( string $filePath )

Exceptions

Exception

Implements ILIAS\UI\Implementation\Crawler\YamlParser.

Definition at line 76 of file EntriesYamlParser.php.

References ILIAS\UI\Implementation\Crawler\EntriesYamlParser\getFileContentAsString(), and ILIAS\UI\Implementation\Crawler\EntriesYamlParser\parseEntriesFromString().

                                                           : Entry\ComponentEntries
     {
         $this->file_path = $filePath;
         $content = $this->getFileContentAsString($filePath);
         return $this->parseEntriesFromString($content);
     }

Here is the call graph for this function:

◆ parseEntriesFromString()

ILIAS\UI\Implementation\Crawler\EntriesYamlParser::parseEntriesFromString ( string $content )

Returns a list UI Component Entries of the parsed YAML entries in a given string.

Implements ILIAS\UI\Implementation\Crawler\YamlParser.

Definition at line 101 of file EntriesYamlParser.php.

References ILIAS\UI\Implementation\Crawler\EntriesYamlParser\getEntriesFromArray(), and ILIAS\UI\Implementation\Crawler\EntriesYamlParser\parseArrayFromString().

Referenced by ILIAS\UI\Implementation\Crawler\EntriesYamlParser\parseEntriesFromFile().

                                                            : Entry\ComponentEntries
     {
         $entries_array = $this->parseArrayFromString($content);
         return $this->getEntriesFromArray($entries_array);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseYamlStringArrayFromFile()

ILIAS\UI\Implementation\Crawler\EntriesYamlParser::parseYamlStringArrayFromFile ( string $filePath )

Exceptions

Exception

Implements ILIAS\UI\Implementation\Crawler\YamlParser.

Definition at line 56 of file EntriesYamlParser.php.

References ILIAS\UI\Implementation\Crawler\EntriesYamlParser\getFileContentAsString(), and ILIAS\UI\Implementation\Crawler\EntriesYamlParser\parseYamlStringArrayFromString().

                                                                   : array
     {
         $this->file_path = $filePath;
         $content = $this->getFileContentAsString($filePath);
         return $this->parseYamlStringArrayFromString($content);
     }

Here is the call graph for this function:

◆ parseYamlStringArrayFromString()

ILIAS\UI\Implementation\Crawler\EntriesYamlParser::parseYamlStringArrayFromString ( string $content )

Exceptions

Exception

Implements ILIAS\UI\Implementation\Crawler\YamlParser.

Definition at line 86 of file EntriesYamlParser.php.

References ILIAS\UI\Implementation\Crawler\EntriesYamlParser\getYamlEntriesFromString().

Referenced by ILIAS\UI\Implementation\Crawler\EntriesYamlParser\parseYamlStringArrayFromFile().

                                                                    : array
     {
         return $this->getYamlEntriesFromString($content);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ purifyYamlLine()

ILIAS\UI\Implementation\Crawler\EntriesYamlParser::purifyYamlLine ( string $line )

protected

Definition at line 219 of file EntriesYamlParser.php.

Referenced by ILIAS\UI\Implementation\Crawler\ExamplesYamlParser\getYamlEntriesFromString(), and ILIAS\UI\Implementation\Crawler\EntriesYamlParser\getYamlEntriesFromString().

                                                    : string
     {
         return str_replace("* ", "", ltrim($line)) . PHP_EOL;
     }

Here is the caller graph for this function:

◆ toLowerCamelCase()

static ILIAS\UI\Implementation\Crawler\EntriesYamlParser::toLowerCamelCase	(	string	$string,
		string	$seperator
	)

static

Returns: string|string[]

Definition at line 314 of file EntriesYamlParser.php.

     {
         return str_replace($seperator, '', lcfirst(ucwords($string)));
     }

◆ toUpperCamelCase()

static ILIAS\UI\Implementation\Crawler\EntriesYamlParser::toUpperCamelCase	(	string	$string,
		string	$seperator
	)

static

Returns: string|string[]

Definition at line 306 of file EntriesYamlParser.php.

     {
         return str_replace($seperator, '', ucwords($string));
     }

Field Documentation

◆ $ef

Exception Factory ILIAS\UI\Implementation\Crawler\EntriesYamlParser::$ef = null

protected

Definition at line 38 of file EntriesYamlParser.php.

◆ $file_path

string ILIAS\UI\Implementation\Crawler\EntriesYamlParser::$file_path = "none"

protected

Used to add for Information in Exceptions.

Definition at line 43 of file EntriesYamlParser.php.

Referenced by ILIAS\UI\Implementation\Crawler\EntriesYamlParser\getEntryFromData().

◆ $items

array ILIAS\UI\Implementation\Crawler\EntriesYamlParser::$items = array()

protected

Definition at line 37 of file EntriesYamlParser.php.

◆ PARSER_STATE_ENTRY

const ILIAS\UI\Implementation\Crawler\EntriesYamlParser::PARSER_STATE_ENTRY = 2

Definition at line 33 of file EntriesYamlParser.php.

◆ PARSER_STATE_OUTSIDE

const ILIAS\UI\Implementation\Crawler\EntriesYamlParser::PARSER_STATE_OUTSIDE = 1

Definition at line 32 of file EntriesYamlParser.php.

◆ PARSER_STATE_SEEKING_FUNCTION_NAME

const ILIAS\UI\Implementation\Crawler\EntriesYamlParser::PARSER_STATE_SEEKING_FUNCTION_NAME = 4

Definition at line 35 of file EntriesYamlParser.php.

◆ PARSER_STATE_SEEKING_RETURN

const ILIAS\UI\Implementation\Crawler\EntriesYamlParser::PARSER_STATE_SEEKING_RETURN = 3

Definition at line 34 of file EntriesYamlParser.php.

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

components/ILIAS/UI/src/Implementation/Crawler/EntriesYamlParser.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ fromCamelCaseToWords()

◆ getEntriesFromArray()

◆ getEntryFromData()

◆ getFileContentAsString()

◆ getPHPArrayFromYamlArray()

◆ getYamlEntriesFromString()

◆ parseArrayFromFile()

◆ parseArrayFromString()

◆ parseEntriesFromFile()

◆ parseEntriesFromString()

◆ parseYamlStringArrayFromFile()

◆ parseYamlStringArrayFromString()

◆ purifyYamlLine()

◆ toLowerCamelCase()

◆ toUpperCamelCase()

Field Documentation

◆ $ef

◆ $file_path

◆ $items

◆ PARSER_STATE_ENTRY

◆ PARSER_STATE_OUTSIDE

◆ PARSER_STATE_SEEKING_FUNCTION_NAME

◆ PARSER_STATE_SEEKING_RETURN