Collaboration diagram for ilCtrlStructureReader:

Public Member Functions
	__construct ($a_ini_file=null)

	setIniFile ($a_ini_file)

	getStructure ()
	parse code files and store call structure in db More...

	readStructure ( $a_force=false, $a_dir="", $a_comp_prefix="", $a_plugin_path="")

	withDB (\ilDBInterface $db)

Data Fields
	$executed

	$db = null

const	INTERESTING_FILES_REGEXP = "~^(class\..*\.php)$~i"

const	GUI_CLASS_FILE_REGEXP = "~^.[/\\\\]class\.(.GUI)\.php$~i"

const	IL_CTRL_DECLARATION_REGEXP = '~^.@{WHICH}\s+([\w\\\\]+)\s:\s([\w\\\\]+(\s,\s[\w\\\\]+))\s*$~mi'

Protected Member Functions
	flushCaches ()

	readDirTo (string $a_cdir, \ilCtrlStructure $cs)

	getFilesIn (string $dir)

	shouldDescendToDirectory (string $dir)

	normalizePath (string $path)

	isInterestingFile (string $file)

	panicOnDuplicateClass (string $full_path, string $other_path, string $parent)

	storeToDB (\ilCtrlStructure $ctrl_structure, string $start_dir)

	setClassFileIdsInDB ()

	parseFileTo (\ilCtrlStructure $cs, string $full_path, string $content)

	getGUIClassNameFromClassPath (string $path)

	containsClassDefinitionFor (string $class, string $content)

	getIlCtrlCalls (string $content)

	getIlCtrlIsCalledBy (string $content)

	getIlCtrlDeclarations (string $content, string $which)

	getDB ()

	getILIASAbsolutePath ()

Protected Attributes
	$read_plugins = false

Detailed Description

Class ilCtrlStructureReader.

Reads call structure of classes into db

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilCtrlStructureReader::__construct ( $a_ini_file = null )

Definition at line 19 of file class.ilCtrlStructureReader.php.

     {
         $this->class_script = array();
         $this->class_childs = array();
         $this->executed = false;
         $this->ini = $a_ini_file;
     }

Member Function Documentation

◆ containsClassDefinitionFor()

ilCtrlStructureReader::containsClassDefinitionFor	(	string	$class,
		string	$content
	)

protected

Definition at line 356 of file class.ilCtrlStructureReader.php.

Referenced by parseFileTo().

                                                                                   : bool
     {
         $regexp = "~.*class\s+$class~mi";
         return preg_match($regexp, $content) != 0;
     }

Here is the caller graph for this function:

◆ flushCaches()

ilCtrlStructureReader::flushCaches ( )

protected

Definition at line 96 of file class.ilCtrlStructureReader.php.

References ilCachedCtrl\flush().

Referenced by readStructure().

                                      : void
     {
         ilCachedCtrl::flush();
         ilGlobalCache::flushAll();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDB()

ilCtrlStructureReader::getDB ( )

protected

Definition at line 425 of file class.ilCtrlStructureReader.php.

References $db, and $ilDB.

Referenced by getStructure(), panicOnDuplicateClass(), readStructure(), setClassFileIdsInDB(), and storeToDB().

                                : \ilDBInterface
     {
         if (!is_null($this->db)) {
             return $this->db;
         }
         //return ilDB in any case - backward compat.
         global $ilDB;
         return $ilDB;
     }

Here is the caller graph for this function:

◆ getFilesIn()

ilCtrlStructureReader::getFilesIn ( string $dir )

protected

Definition at line 139 of file class.ilCtrlStructureReader.php.

References Vendor\Package\$e, Vendor\Package\$f, normalizePath(), and shouldDescendToDirectory().

Referenced by readDirTo().

                                                : \Generator
     {
         foreach (scandir($dir) as $e) {
             if ($e == "." || $e == "..") {
                 continue;
             }
             $f = $this->normalizePath("$dir/$e");
             if (@is_dir($f)) {
                 if (!$this->shouldDescendToDirectory($dir)) {
                     continue;
                 }
                 foreach ($this->getFilesIn($f) as $s) {
                     yield $s;
                 }
             }
             if (@is_file($f)) {
                 yield [$e, $f];
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getGUIClassNameFromClassPath()

ilCtrlStructureReader::getGUIClassNameFromClassPath ( string $path )

protected

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

References $res.

Referenced by parseFileTo().

                                                                   : ?string
     {
         $res = [];
         if (preg_match(self::GUI_CLASS_FILE_REGEXP, $path, $res)) {
             return strtolower($res[1]);
         }
         return null;
     }

Here is the caller graph for this function:

◆ getIlCtrlCalls()

ilCtrlStructureReader::getIlCtrlCalls ( string $content )

protected

Returns: null|(string,string[])

Definition at line 372 of file class.ilCtrlStructureReader.php.

References getIlCtrlDeclarations().

Referenced by parseFileTo().

                                                        : ?array
     {
         return $this->getIlCtrlDeclarations($content, "ilctrl_calls");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getIlCtrlDeclarations()

ilCtrlStructureReader::getIlCtrlDeclarations	(	string	$content,
		string	$which
	)

protected

Returns: null|(string,string[])

Definition at line 388 of file class.ilCtrlStructureReader.php.

References $res.

Referenced by getIlCtrlCalls(), and getIlCtrlIsCalledBy().

                                                                              : ?array
     {
         $regexp = str_replace("{WHICH}", $which, self::IL_CTRL_DECLARATION_REGEXP);
         $res = [];
         if (!preg_match_all($regexp, $content, $res)) {
             return null;
         }
 
         $class_names = array_unique($res[1]);
         if (count($class_names) != 1) {
             throw new \LogicException(
                 "Found different class names in ilctrl_calls: " . join(",", $class_names)
             );
         }
 
         $declaration = [];
         foreach ($res[2] as $ls) {
             foreach (explode(",", $ls) as $l) {
                 $declaration[] = strtolower(trim($l));
             }
         }
 
         return [strtolower(trim($class_names[0])), $declaration];
     }

Here is the caller graph for this function:

◆ getIlCtrlIsCalledBy()

ilCtrlStructureReader::getIlCtrlIsCalledBy ( string $content )

protected

Returns: null|(string,string[])

Definition at line 380 of file class.ilCtrlStructureReader.php.

References getIlCtrlDeclarations().

Referenced by parseFileTo().

                                                             : ?array
     {
         return $this->getIlCtrlDeclarations($content, "ilctrl_iscalledby");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getILIASAbsolutePath()

ilCtrlStructureReader::getILIASAbsolutePath ( )

protected

Definition at line 435 of file class.ilCtrlStructureReader.php.

References normalizePath().

Referenced by readStructure(), and shouldDescendToDirectory().

                                               : string
     {
         if (defined("ILIAS_ABSOLUTE_PATH")) {
             return $this->normalizePath(ILIAS_ABSOLUTE_PATH);
         } else {
             return dirname(__FILE__, 5);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStructure()

ilCtrlStructureReader::getStructure ( )

parse code files and store call structure in db

Definition at line 35 of file class.ilCtrlStructureReader.php.

References $ilDB, and getDB().

     {
         $ilDB = $this->getDB();
 
         $this->ini->setVariable("db", "structure_reload", "1");
         $this->ini->write();
         if ($this->ini->readVariable("db", "structure_reload") != "1") {
             echo "Error Cannot write client.ini.file.";
         }
         //$this->get_structure = true;
     }

Here is the call graph for this function:

◆ isInterestingFile()

ilCtrlStructureReader::isInterestingFile ( string $file )

protected

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

Referenced by readDirTo().

                                                        : bool
     {
         return preg_match(self::INTERESTING_FILES_REGEXP, $file);
     }

Here is the caller graph for this function:

◆ normalizePath()

ilCtrlStructureReader::normalizePath ( string $path )

protected

Definition at line 173 of file class.ilCtrlStructureReader.php.

Referenced by getFilesIn(), getILIASAbsolutePath(), and shouldDescendToDirectory().

                                                    : string
     {
         return realpath(str_replace(['//'], ['/'], $path));
     }

Here is the caller graph for this function:

◆ panicOnDuplicateClass()

ilCtrlStructureReader::panicOnDuplicateClass	(	string	$full_path,
		string	$other_path,
		string	$parent
	)

protected

Definition at line 190 of file class.ilCtrlStructureReader.php.

References $ilDB, and getDB().

Referenced by readDirTo().

                                                                                                     : void
     {
         $ilDB = $this->getDB();
 
         // delete all class to file assignments
         $ilDB->manipulate("DELETE FROM ctrl_classfile WHERE comp_prefix = " .
             $ilDB->quote($this->comp_prefix, "text"));
         if ($this->comp_prefix == "") {
             $ilDB->manipulate($q = "DELETE FROM ctrl_classfile WHERE " .
                 $ilDB->equals("comp_prefix", "", "text", true));
         }
 
         // delete all call entries
         $ilDB->manipulate("DELETE FROM ctrl_calls WHERE comp_prefix = " .
             $ilDB->quote($this->comp_prefix, "text"));
         if ($this->comp_prefix == "") {
             $ilDB->manipulate("DELETE FROM ctrl_calls WHERE comp_prefix IS NULL");
         }
 
         $msg = implode("\n", [
             "Error: Duplicate call structure definition found (Class %s) in files:",
             "- %s",
             "- %s",
             "",
             "Please remove the file, that does not belong to the official ILIAS distribution.",
             "After that invoke 'Tools' -> 'Reload Control Structure' in the ILIAS Setup."
         ]);
 
         throw new \Exception(
             sprintf(
                 $msg,
                 $parent,
                 $other_path,
                 $full_path
             )
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseFileTo()

ilCtrlStructureReader::parseFileTo	(	\ilCtrlStructure	$cs,
		string	$full_path,
		string	$content
	)

protected

Exceptions

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

References containsClassDefinitionFor(), getGUIClassNameFromClassPath(), getIlCtrlCalls(), getIlCtrlIsCalledBy(), ilCtrlStructure\withClassChild(), and ilCtrlStructure\withClassScript().

Referenced by readDirTo().

                                                                                              : \ilCtrlStructure
     {
         list($parent, $children) = $this->getIlCtrlCalls($content);
         if ($parent) {
             $cs = $cs->withClassScript($parent, $full_path);
         }
         if ($children) {
             foreach ($children as $child) {
                 $cs = $cs->withClassChild($parent, $child);
             }
         }
 
         list($child, $parents) = $this->getIlCtrlIsCalledBy($content);
         if ($child) {
             $cs = $cs->withClassScript($child, $full_path);
         }
         if ($parents) {
             foreach ($parents as $parent) {
                 $cs = $cs->withClassChild($parent, $child);
             }
         }
 
         $cl = $this->getGUIClassNameFromClassPath($full_path);
         if ($cl && $this->containsClassDefinitionFor($cl, $content)) {
             $cs = $cs->withClassScript($cl, $full_path);
         }
 
         return $cs;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readDirTo()

ilCtrlStructureReader::readDirTo	(	string	$a_cdir,
		\ilCtrlStructure	$cs
	)

protected

Definition at line 102 of file class.ilCtrlStructureReader.php.

References Vendor\Package\$e, ilCtrlStructure\getClassScriptOf(), getFilesIn(), isInterestingFile(), panicOnDuplicateClass(), and parseFileTo().

Referenced by readStructure().

                                                                        : \ilCtrlStructure
     {
         // check wether $a_cdir is a directory
         if (!@is_dir($a_cdir)) {
             throw new \LogicException("'$a_cdir' is not a directory.");
         }
 
         foreach ($this->getFilesIn($a_cdir) as list($file, $full_path)) {
             if (!$this->isInterestingFile($file)) {
                 continue;
             }
 
             $content = file_get_contents($full_path);
             try {
                 $cs = $this->parseFileTo($cs, $full_path, $content);
             } catch (\LogicException $e) {
                 throw new \LogicException("In file \"$full_path\": " . $e->getMessage(), $e->getCode(), $e);
             } catch (\RuntimeException $e) {
                 if (!isset($e->class) || !isset($e->file_path)) {
                     throw $e;
                 }
                 $this->panicOnDuplicateClass(
                     $e->file_path,
                     $cs->getClassScriptOf($e->class),
                     $e->class
                 );
             }
         }
 
         return $cs;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readStructure()

ilCtrlStructureReader::readStructure	(	$a_force = `false`,
		$a_dir = `""`,
		$a_comp_prefix = `""`,
		$a_plugin_path = `""`
	)

Definition at line 52 of file class.ilCtrlStructureReader.php.

References $ilDB, flushCaches(), getDB(), getILIASAbsolutePath(), readDirTo(), setClassFileIdsInDB(), and storeToDB().

       : void {
         $ilDB = $this->getDB();
 
         if (!$a_force && $this->ini->readVariable("db", "structure_reload") != "1") {
             return;
         }
 
         // only run one time per db_update request
         if ($this->executed) {
             return;
         }
 
         $this->flushCaches();
     
         // prefix for component
         $this->comp_prefix = $a_comp_prefix;
 
         // plugin path
         $this->plugin_path = $a_plugin_path;
 
         if ($this->plugin_path != "" && $this->comp_prefix != "") {
             $this->read_plugins = true;
         }
 
         if ($a_dir == "") {
             $a_dir = $this->getILIASAbsolutePath();
         }
 
         $ctrl_structure = $this->readDirTo($a_dir, new \ilCtrlStructure());
         $this->storeToDB($ctrl_structure, $a_dir);
         $this->setClassFileIdsInDB();
 
         $this->executed = true;
         if (!$a_force) {
             $this->ini->setVariable("db", "structure_reload", "0");
             $this->ini->write();
         }
     }

Here is the call graph for this function:

◆ setClassFileIdsInDB()

ilCtrlStructureReader::setClassFileIdsInDB ( )

protected

Definition at line 281 of file class.ilCtrlStructureReader.php.

References $ilDB, and getDB().

Referenced by readStructure().

                                              : void
     {
         $ilDB = $this->getDB();
 
         $ilDB->manipulate(
             "UPDATE ctrl_classfile SET " .
             " cid = " . $ilDB->quote("", "text")
         );
         $set = $ilDB->query("SELECT * FROM ctrl_classfile ");
         $cnt = 1;
         while ($rec = $ilDB->fetchAssoc($set)) {
             $cid = base_convert((string) $cnt, 10, 36);
             $ilDB->manipulate(
                 "UPDATE ctrl_classfile SET " .
                 " cid = " . $ilDB->quote($cid, "text") .
                 " WHERE class = " . $ilDB->quote($rec["class"], "text")
             );
             $cnt++;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setIniFile()

ilCtrlStructureReader::setIniFile ( $a_ini_file )

Definition at line 27 of file class.ilCtrlStructureReader.php.

     {
         $this->ini = $a_ini_file;
     }

◆ shouldDescendToDirectory()

ilCtrlStructureReader::shouldDescendToDirectory ( string $dir )

protected

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

References getILIASAbsolutePath(), and normalizePath().

Referenced by getFilesIn().

                                                              : bool
     {
         $il_absolute_path = $this->getILIASAbsolutePath();
         $data_dir = $this->normalizePath($il_absolute_path . "/data");
         $customizing_dir = $this->normalizePath($il_absolute_path . "/Customizing");
 
         $dir = $this->normalizePath($dir);
         if ($this->read_plugins) {
             return $dir != $data_dir;
         }
         return $dir != $customizing_dir && $dir != $data_dir;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ storeToDB()

ilCtrlStructureReader::storeToDB	(	\ilCtrlStructure	$ctrl_structure,
		string	$start_dir
	)

protected

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

References $ilDB, ilCtrlStructure\getClassChildren(), ilCtrlStructure\getClassScripts(), and getDB().

Referenced by readStructure().

                                                                                       : void
     {
         $ilDB = $this->getDB();
 
         // delete all class to file assignments
         $ilDB->manipulate("DELETE FROM ctrl_classfile WHERE comp_prefix = " .
             $ilDB->quote($this->comp_prefix, "text"));
         if ($this->comp_prefix == "") {
             $ilDB->manipulate($q = "DELETE FROM ctrl_classfile WHERE " .
                 $ilDB->equals("comp_prefix", "", "text", true));
         }
 
         // delete all call entries
         $ilDB->manipulate("DELETE FROM ctrl_calls WHERE comp_prefix = " .
             $ilDB->quote($this->comp_prefix, "text"));
         if ($this->comp_prefix == "") {
             $ilDB->manipulate("DELETE FROM ctrl_calls WHERE " .
                 $ilDB->equals("comp_prefix", "", "text", true));
         }
 
         foreach ($ctrl_structure->getClassScripts() as $class => $script) {
             $file = substr(realpath($script), strlen(realpath($start_dir)) + 1);
             // store class to file assignment
             $ilDB->manipulate(sprintf(
                 "INSERT IGNORE INTO ctrl_classfile (class, filename, comp_prefix, plugin_path) " .
                 " VALUES (%s,%s,%s,%s)",
                 $ilDB->quote($class, "text"),
                 $ilDB->quote($file, "text"),
                 $ilDB->quote($this->comp_prefix, "text"),
                 $ilDB->quote($this->plugin_path, "text")
             ));
         }
         //$this->class_childs[$parent][] = $child;
         foreach ($ctrl_structure->getClassChildren() as $parent => $children) {
             if (!strlen($parent)) {
                 continue;
             }
             foreach ($children as $child) {
                 if (!strlen(trim($child))) {
                     continue;
                 }
                 // store call entry
                 $ilDB->manipulate(sprintf(
                     "INSERT IGNORE INTO ctrl_calls (parent, child, comp_prefix) " .
                     "VALUES (%s,%s,%s)",
                     $ilDB->quote($parent, "text"),
                     $ilDB->quote($child, "text"),
                     $ilDB->quote($this->comp_prefix, "text")
                 ));
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ withDB()

ilCtrlStructureReader::withDB ( \ilDBInterface $db )

Definition at line 418 of file class.ilCtrlStructureReader.php.

References $db.

     {
         $clone = clone $this;
         $clone->db = $db;
         return $clone;
     }

Field Documentation

◆ $db

ilCtrlStructureReader::$db = null

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

Referenced by getDB(), and withDB().

◆ $executed

ilCtrlStructureReader::$executed

Definition at line 15 of file class.ilCtrlStructureReader.php.

◆ $read_plugins

ilCtrlStructureReader::$read_plugins = false

protected

Definition at line 17 of file class.ilCtrlStructureReader.php.

◆ GUI_CLASS_FILE_REGEXP

const ilCtrlStructureReader::GUI_CLASS_FILE_REGEXP = "~^.*[/\\\\]class\.(.*GUI)\.php$~i"

Definition at line 345 of file class.ilCtrlStructureReader.php.

◆ IL_CTRL_DECLARATION_REGEXP

const ilCtrlStructureReader::IL_CTRL_DECLARATION_REGEXP = '~^.*@{WHICH}\s+([\w\\\\]+)\s*:\s*([\w\\\\]+(\s*,\s*[\w\\\\]+)*)\s*$~mi'

Definition at line 367 of file class.ilCtrlStructureReader.php.

◆ INTERESTING_FILES_REGEXP

const ilCtrlStructureReader::INTERESTING_FILES_REGEXP = "~^(class\..*\.php)$~i"

Definition at line 178 of file class.ilCtrlStructureReader.php.

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

Services/UICore/classes/Setup/class.ilCtrlStructureReader.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ containsClassDefinitionFor()

◆ flushCaches()

◆ getDB()

◆ getFilesIn()

◆ getGUIClassNameFromClassPath()

◆ getIlCtrlCalls()

◆ getIlCtrlDeclarations()

◆ getIlCtrlIsCalledBy()

◆ getILIASAbsolutePath()

◆ getStructure()

◆ isInterestingFile()

◆ normalizePath()

◆ panicOnDuplicateClass()

◆ parseFileTo()

◆ readDirTo()

◆ readStructure()

◆ setClassFileIdsInDB()

◆ setIniFile()

◆ shouldDescendToDirectory()

◆ storeToDB()

◆ withDB()

Field Documentation

◆ $db

◆ $executed

◆ $read_plugins

◆ GUI_CLASS_FILE_REGEXP

◆ IL_CTRL_DECLARATION_REGEXP

◆ INTERESTING_FILES_REGEXP