docu_system/classes/SYSTEM-autoload.html
Ulf Gebhardt 50de610cf6
generated new version
missing changes

more

more

more
2024-11-21 02:49:15 +01:00

734 lines
46 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/>
<meta charset="utf-8"/>
<title> SYSTEM - PHP Framework &raquo; \SYSTEM\autoload
</title>
<meta name="author" content=""/>
<meta name="description" content=""/>
<base href="../">
<link href="css/template.css" rel="stylesheet" media="all"/>
<!--[if lt IE 9]>
<script src="https://html5shim.googlecode.com/svn/trunk/html5.js" type="text/javascript"></script>
<![endif]-->
<script src="js/jquery-1.7.1.min.js" type="text/javascript"></script>
<script src="js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script>
<script src="js/jquery.mousewheel.min.js" type="text/javascript"></script>
<script src="js/bootstrap.js" type="text/javascript"></script>
<script src="js/template.js" type="text/javascript"></script>
<script src="js/prettify/prettify.min.js" type="text/javascript"></script>
<link rel="shortcut icon" href="img/favicon.ico"/>
<link rel="apple-touch-icon" href="img/apple-touch-icon.png"/>
<link rel="apple-touch-icon" sizes="72x72" href="img/apple-touch-icon-72x72.png"/>
<link rel="apple-touch-icon" sizes="114x114" href="img/apple-touch-icon-114x114.png"/>
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span> <span class="icon-bar"></span>
<span class="icon-bar"></span> </a>
<a class="brand" href="index.html">SYSTEM - PHP Framework</a>
<div class="nav-collapse">
<ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li><a>Namespaces</a></li>
<li><a href="\LIB">LIB</a></li>
<li><a href="\GIT">GIT</a></li>
<li><a href="\vakata">vakata</a></li>
<li><a href="\Michelf">Michelf</a></li>
<li><a href="\MatthiasMullie">MatthiasMullie</a></li>
<li><a href="\PHPDocMD">PHPDocMD</a></li>
<li><a href="\ScssPhp">ScssPhp</a></li>
<li><a href="\SYSTEM">SYSTEM</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li>
<a href="graph_class.html">
<i class="icon-list-alt"></i>&#160;Class hierarchy diagram
</a>
</li>
</ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li>
<a href="errors.html">
<i class="icon-list-alt"></i>&#160;Errors
</a>
</li>
<li>
<a href="markers.html">
<i class="icon-list-alt"></i>&#160;Markers
</a>
</li>
<li>
<a href="deprecated.html">
<i class="icon-list-alt"></i>&#160;Deprecated
</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div class="go_to_top">
<a href="#___" style="color: inherit">Back to top&#160;&#160;<i class="icon-upload icon-white"></i></a>
</div>
</div>
<div id="___" class="container">
<noscript>
<div class="alert alert-warning">
Javascript is disabled; several features are only available if Javascript is enabled.
</div>
</noscript>
<style>
.deprecated h2 {
text-decoration: line-through;
}
</style>
<div class="row">
<div class="span4">
<div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button>
<button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<div class="btn-group visibility" data-toggle="buttons-checkbox">
<button class="btn public active" title="Show public elements">Public</button>
<button class="btn protected" title="Show protected elements">Protected</button>
<button class="btn private" title="Show private elements">Private</button>
<button class="btn inherited active" title="Show inherited elements">Inherited</button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods
<ul>
<li class="method public">
<a href="#method_autoload" title="autoload :: Autoloads a class. This function is registered against the PHP Environment.">
<span class="description">Autoloads a class. This function is registered against the PHP Environment.</span><pre>autoload</pre>
</a>
</li>
<li class="method public">
<a href="#method_register_autoload" title="register_autoload :: Registers the Autoload Handler against the PHP Environment">
<span class="description">Registers the Autoload Handler against the PHP Environment</span><pre>register_autoload</pre>
</a>
</li>
<li class="method public">
<a href="#method_registerFile" title="registerFile :: Registers a file to the autoload feature
The file has to be named class.php">
<span class="description">Registers a file to the autoload feature
The file has to be named class.php</span><pre>registerFile</pre>
</a>
</li>
<li class="method public">
<a href="#method_registerFolder" title="registerFolder :: Registers a folder to the autoload feature
All Classes within that Folder can be loaded if
the file is named: class.php">
<span class="description">Registers a folder to the autoload feature
All Classes within that Folder can be loaded if
the file is named: class.php</span><pre>registerFolder</pre>
</a>
</li>
<li class="method public">
<a href="#method_registerFunc" title="registerFunc :: Registers a function to the autoload feature">
<span class="description">Registers a function to the autoload feature</span><pre>registerFunc</pre>
</a>
</li>
</ul>
</li>
<li class="nav-header protected">» Protected
<ul>
</ul>
</li>
<li class="nav-header private">» Private
<ul>
<li class="method private">
<a href="#method_autoload_" title="autoload_ :: The autoload Feature. Searches within all registered file, folders and
functions if a matching class can be found, respecting namespaces in the
process.">
<span class="description">The autoload Feature. Searches within all registered file, folders and
functions if a matching class can be found, respecting namespaces in the
process.</span><pre>autoload_</pre>
</a>
</li>
<li class="method private">
<a href="#method_getClassFromFile" title="getClassFromFile :: Get the Classname of a File by removing its extension and containing folders.">
<span class="description">Get the Classname of a File by removing its extension and containing folders.</span><pre>getClassFromFile</pre>
</a>
</li>
<li class="method private">
<a href="#method_getClassNamespaceFromClass" title="getClassNamespaceFromClass :: Seperates Class and Namespace of a combined string.">
<span class="description">Seperates Class and Namespace of a combined string.</span><pre>getClassNamespaceFromClass</pre>
</a>
</li>
</ul>
</li>
<li class="nav-header">
<i class="icon-custom icon-constant"></i> Constants
<ul>
</ul>
</li>
</ul>
</div>
<div class="span8">
<div class="element class">
<h1>autoload</h1>
<small style="display: block; text-align: right">
</small>
<p class="short_description">autoload Class provided by System to Autoload Classes</p>
<div class="details">
<div class="long_description">
</div>
<table class="table table-bordered">
<tr>
<th>
package
</th>
<td>
<p>SYSTEM</p>
</td>
</tr>
</table>
<h3><i class="icon-custom icon-method"></i> Methods</h3>
<a id="method_autoload"></a>
<div class="element clickable method public method_autoload" data-toggle="collapse" data-target=".method_autoload .collapse">
<h2>Autoloads a class. This function is registered against the PHP Environment.</h2>
<pre>autoload(stringclass) : bool</pre>
<div class="labels">
<span class="label">static</span> </div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"><p>It is called from PHP if a new class is required.</p>
</div>
<table class="table">
<tr>
<th>
</th>
<td>
</td>
</tr>
</table>
<h3>Arguments</h3>
<div class="subelement argument">
<h4>class</h4>
<code>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
string</code><p><p>Class to be autoloaded</p>
</p>
</div>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
<h3>Response</h3>
<code>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
bool</code><p><p>Returns true if successfull.</p>
</p>
</div>
</div>
</div>
<a id="method_autoload_"></a>
<div class="element clickable method private method_autoload_" data-toggle="collapse" data-target=".method_autoload_ .collapse">
<h2>The autoload Feature. Searches within all registered file, folders and
functions if a matching class can be found, respecting namespaces in the
process.</h2>
<pre>autoload_(stringclass, stringnamespace = &#039;&#039;) : bool</pre>
<div class="labels">
<span class="label">static</span> </div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
<tr>
<th>
</th>
<td>
</td>
</tr>
</table>
<h3>Arguments</h3>
<div class="subelement argument">
<h4>class</h4>
<code>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
string</code><p><p>Class to be autoloaded</p>
</p>
</div>
<div class="subelement argument">
<h4>namespace</h4>
<code>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
string</code><p><p>Namespace of the Request</p>
</p>
</div>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
<h3>Response</h3>
<code>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
bool</code><p><p>Returns true or false.</p>
</p>
</div>
</div>
</div>
<a id="method_getClassFromFile"></a>
<div class="element clickable method private method_getClassFromFile" data-toggle="collapse" data-target=".method_getClassFromFile .collapse">
<h2>Get the Classname of a File by removing its extension and containing folders.</h2>
<pre>getClassFromFile(stringfile) : string</pre>
<div class="labels">
<span class="label">static</span> </div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
<tr>
<th>
</th>
<td>
</td>
</tr>
</table>
<h3>Arguments</h3>
<div class="subelement argument">
<h4>file</h4>
<code>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
string</code><p><p>Filepath to be reduced to classname</p>
</p>
</div>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
<h3>Response</h3>
<code>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
string</code><p><p>Returns classname</p>
</p>
</div>
</div>
</div>
<a id="method_getClassNamespaceFromClass"></a>
<div class="element clickable method private method_getClassNamespaceFromClass" data-toggle="collapse" data-target=".method_getClassNamespaceFromClass .collapse">
<h2>Seperates Class and Namespace of a combined string.</h2>
<pre>getClassNamespaceFromClass(stringclass) : array</pre>
<div class="labels">
<span class="label">static</span> </div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
<tr>
<th>
</th>
<td>
</td>
</tr>
</table>
<h3>Arguments</h3>
<div class="subelement argument">
<h4>class</h4>
<code>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
string</code><p><p>Class including possible Namespaces</p>
</p>
</div>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
<h3>Response</h3>
<code>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
array</code><p><p>Returns array(class,namespace).</p>
</p>
</div>
</div>
</div>
<a id="method_register_autoload"></a>
<div class="element clickable method public method_register_autoload" data-toggle="collapse" data-target=".method_register_autoload .collapse">
<h2>Registers the Autoload Handler against the PHP Environment</h2>
<pre>register_autoload() : null</pre>
<div class="labels">
<span class="label">static</span> </div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
<tr>
<th>
</th>
<td>
</td>
</tr>
</table>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
<h3>Response</h3>
<code>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
null</code><p><p>Returns null</p>
</p>
</div>
</div>
</div>
<a id="method_registerFile"></a>
<div class="element clickable method public method_registerFile" data-toggle="collapse" data-target=".method_registerFile .collapse">
<h2>Registers a file to the autoload feature
The file has to be named class.php</h2>
<pre>registerFile(stringfile, stringnamespace = &#039;&#039;) : null</pre>
<div class="labels">
<span class="label">static</span> </div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
<tr>
<th>
</th>
<td>
</td>
</tr>
</table>
<h3>Arguments</h3>
<div class="subelement argument">
<h4>file</h4>
<code>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
string</code><p><p>Filepath to be autoloaded from</p>
</p>
</div>
<div class="subelement argument">
<h4>namespace</h4>
<code>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
string</code><p><p>Namespace of the File</p>
</p>
</div>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
<h3>Response</h3>
<code>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
null</code><p><p>Returns null.</p>
</p>
</div>
</div>
</div>
<a id="method_registerFolder"></a>
<div class="element clickable method public method_registerFolder" data-toggle="collapse" data-target=".method_registerFolder .collapse">
<h2>Registers a folder to the autoload feature
All Classes within that Folder can be loaded if
the file is named: class.php</h2>
<pre>registerFolder(stringfolder, stringnamespace = &#039;&#039;) : null</pre>
<div class="labels">
<span class="label">static</span> </div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
<tr>
<th>
</th>
<td>
</td>
</tr>
</table>
<h3>Arguments</h3>
<div class="subelement argument">
<h4>folder</h4>
<code>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
string</code><p><p>Folderpath to be autoloaded from</p>
</p>
</div>
<div class="subelement argument">
<h4>namespace</h4>
<code>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
string</code><p><p>Namespace of the Folder</p>
</p>
</div>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
<h3>Response</h3>
<code>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
null</code><p><p>Returns null.</p>
</p>
</div>
</div>
</div>
<a id="method_registerFunc"></a>
<div class="element clickable method public method_registerFunc" data-toggle="collapse" data-target=".method_registerFunc .collapse">
<h2>Registers a function to the autoload feature</h2>
<pre>registerFunc(stringfunc, stringnamespace = &#039;&#039;) : null</pre>
<div class="labels">
<span class="label">static</span> </div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
<tr>
<th>
todo
</th>
<td>
<p>Does this work? Is it useful?</p>
</td>
</tr>
<tr>
<th>
</th>
<td>
</td>
</tr>
</table>
<h3>Arguments</h3>
<div class="subelement argument">
<h4>func</h4>
<code>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
string</code><p><p>Function to be &quot;autoloaded&quot;</p>
</p>
</div>
<div class="subelement argument">
<h4>namespace</h4>
<code>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
string</code><p><p>Namespace of the Function</p>
</p>
</div>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
<h3>Response</h3>
<code>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
null</code><p><p>Returns null.</p>
</p>
</div>
</div>
</div>
<h3><i class="icon-custom icon-property"></i> Properties</h3>
<a id="property_files"> </a>
<div class="element clickable property private property_files" data-toggle="collapse" data-target=".property_files .collapse">
<h2>array Registered Files Format array(class, namespace, file)</h2>
<pre>files : </pre>
<div class="labels">
<span class="label">static</span> </div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
<tr>
<th>
</th>
<td>
</td>
</tr>
<tr>
<th>
</th>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<a id="property_folders"> </a>
<div class="element clickable property private property_folders" data-toggle="collapse" data-target=".property_folders .collapse">
<h2>array Registered Folders Format array(class, namespace, folder)</h2>
<pre>folders : </pre>
<div class="labels">
<span class="label">static</span> </div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
<tr>
<th>
</th>
<td>
</td>
</tr>
<tr>
<th>
</th>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<a id="property_func"> </a>
<div class="element clickable property private property_func" data-toggle="collapse" data-target=".property_func .collapse">
<h2>string Registered Func Format array(namespace, func)</h2>
<pre>func : </pre>
<div class="labels">
<span class="label">static</span> </div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
<tr>
<th>
</th>
<td>
</td>
</tr>
<tr>
<th>
</th>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
</div>
</div>
<a id="\SYSTEM\autoload"></a>
<ul class="breadcrumb">
<li><a href="index.html"><i class="icon-custom icon-class"></i></a></li>
<li><span class="divider">\</span><a href="\SYSTEM">SYSTEM</a></li>
<li class="active"><span class="divider">\</span><a href="\SYSTEM\autoload">autoload</a></li>
</ul>
</div>
</div>
</div>
<footer class="span12">
Template is built using <a href="https://getbootstrap.com/">Twitter Bootstrap 2</a> and icons provided by
<a href="https://glyphicons.com/">Glyphicons</a>.<br/>
Documentation is powered by <a href="https://www.phpdoc.org/">phpDocumentor </a> and<br/>
generated on Thu, 21 Nov 2024 01:33:25 +0000.<br/>
</footer>
</body>
</html>