613 lines
39 KiB
HTML
613 lines
39 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 » \SYSTEM\PAGE\text
|
|
</title>
|
|
<meta name="author" content=""/>
|
|
<meta name="description" content=""/>
|
|
|
|
<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="../namespaces/SYSTEM.html">SYSTEM</a></li>
|
|
<li><a href="../namespaces/LIB.html">LIB</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> 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> Errors
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="../markers.html">
|
|
<i class="icon-list-alt"></i> Markers
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="../deprecated.html">
|
|
<i class="icon-list-alt"></i> Deprecated
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="go_to_top">
|
|
<a href="#___" style="color: inherit">Back to top  <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_delete" title="delete :: Delete a text from the Database.">
|
|
<span class="description">Delete a text from the Database.</span><pre>delete</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_get" title="get :: Get a text with certain id and language">
|
|
<span class="description">Get a text with certain id and language</span><pre>get</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_get_adv" title="get_adv :: Get a text with certain id and language plus creation user info etc">
|
|
<span class="description">Get a text with certain id and language plus creation user info etc</span><pre>get_adv</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_get_latest" title="get_latest :: Get latest texts from database by tag and limit">
|
|
<span class="description">Get latest texts from database by tag and limit</span><pre>get_latest</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_get_tags" title="get_tags :: Get a tags of a text with certain id and limit the results">
|
|
<span class="description">Get a tags of a text with certain id and limit the results</span><pre>get_tags</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_id_tags" title="id_tags :: Get the tags of a textid">
|
|
<span class="description">Get the tags of a textid</span><pre>id_tags</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_save" title="save :: Save a text into the Database. Works like rename">
|
|
<span class="description">Save a text into the Database. Works like rename</span><pre>save</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_search" title="search :: Search with content of texts with given tag">
|
|
<span class="description">Search with content of texts with given tag</span><pre>search</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_tag" title="tag :: Get the texts with certain tag and language">
|
|
<span class="description">Get the texts with certain tag and language</span><pre>tag</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_tag_adv" title="tag_adv :: Get the texts with certain tag and language plus creation user info etc">
|
|
<span class="description">Get the texts with certain tag and language plus creation user info etc</span><pre>tag_adv</pre>
|
|
</a>
|
|
</li>
|
|
|
|
</ul>
|
|
</li>
|
|
<li class="nav-header protected">» Protected
|
|
<ul>
|
|
</ul>
|
|
</li>
|
|
<li class="nav-header private">» Private
|
|
<ul>
|
|
</ul>
|
|
</li>
|
|
<li class="nav-header">
|
|
<i class="icon-custom icon-constant"></i> Constants
|
|
<ul>
|
|
<li class="constant ">
|
|
<a href="#constant_NEW_ENTRY" title="NEW_ENTRY :: Entry of a new text temporary used">
|
|
<span class="description">Entry of a new text temporary used</span><pre>NEW_ENTRY</pre>
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
|
|
<div class="span8">
|
|
<div class="element class">
|
|
<h1>text</h1>
|
|
<small style="display: block; text-align: right">
|
|
</small>
|
|
<p class="short_description">Text Class provided by System to get Texts from the Database.</p>
|
|
<div class="details">
|
|
<div class="long_description">
|
|
|
|
</div>
|
|
<table class="table table-bordered">
|
|
<tr>
|
|
<th>
|
|
package
|
|
</th>
|
|
<td>
|
|
|
|
<p>SYSTEM\PAGE</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3><i class="icon-custom icon-method"></i> Methods</h3>
|
|
<a id="method_delete"></a>
|
|
<div class="element clickable method public method_delete" data-toggle="collapse" data-target=".method_delete .collapse">
|
|
<h2>Delete a text from the Database.</h2>
|
|
<pre>delete(string $id, string $lang = null) : boolean</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">
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>$id</h4>
|
|
<code>string</code><p><p>Id of the text</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$lang</h4>
|
|
<code>string</code><p><p>Language of the text</p></p>
|
|
</div>
|
|
|
|
<h3>Response</h3>
|
|
<code>boolean</code><p><p>Returns true or false</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_get"></a>
|
|
<div class="element clickable method public method_get" data-toggle="collapse" data-target=".method_get .collapse">
|
|
<h2>Get a text with certain id and language</h2>
|
|
<pre>get(string $id, string $lang = NULL, boolean $fallback = true) : 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">
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>$id</h4>
|
|
<code>string</code><p><p>Id of the text requested</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$lang</h4>
|
|
<code>string</code><p><p>Language for the requested text</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$fallback</h4>
|
|
<code>boolean</code><p><p>Fallback to default language if textid is not found for the specified language.</p></p>
|
|
</div>
|
|
|
|
<h3>Response</h3>
|
|
<code>string</code><p><p>Returns the text if found empty string if not.</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_get_adv"></a>
|
|
<div class="element clickable method public method_get_adv" data-toggle="collapse" data-target=".method_get_adv .collapse">
|
|
<h2>Get a text with certain id and language plus creation user info etc</h2>
|
|
<pre>get_adv(string $id, string $lang = NULL, boolean $fallback = true) : \SYSTEM\PAGE\Databaseresult</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">
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>$id</h4>
|
|
<code>string</code><p><p>Id of the text requested</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$lang</h4>
|
|
<code>string</code><p><p>Language for the requested text</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$fallback</h4>
|
|
<code>boolean</code><p><p>Fallback to default language if textid is not found for the specified language.</p></p>
|
|
</div>
|
|
|
|
<h3>Response</h3>
|
|
<code>\SYSTEM\PAGE\Databaseresult</code><p><p>Returns Database Result to loop over.</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_get_latest"></a>
|
|
<div class="element clickable method public method_get_latest" data-toggle="collapse" data-target=".method_get_latest .collapse">
|
|
<h2>Get latest texts from database by tag and limit</h2>
|
|
<pre>get_latest(string $tag, integer $limit) : 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">
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>$tag</h4>
|
|
<code>string</code><p><p>Id of the tag requested</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$limit</h4>
|
|
<code>integer</code><p><p>Amount of Texts to be requested</p></p>
|
|
</div>
|
|
|
|
<h3>Response</h3>
|
|
<code>array</code><p><p>Returns array with texts for given tag ordered by time</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_get_tags"></a>
|
|
<div class="element clickable method public method_get_tags" data-toggle="collapse" data-target=".method_get_tags .collapse">
|
|
<h2>Get a tags of a text with certain id and limit the results</h2>
|
|
<pre>get_tags(string $id, integer $limit) : 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">
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>$id</h4>
|
|
<code>string</code><p><p>Id of the text requested</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$limit</h4>
|
|
<code>integer</code><p><p>Amount of Tags to be requested</p></p>
|
|
</div>
|
|
|
|
<h3>Response</h3>
|
|
<code>array</code><p><p>Returns array with tags for given text id</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_id_tags"></a>
|
|
<div class="element clickable method public method_id_tags" data-toggle="collapse" data-target=".method_id_tags .collapse">
|
|
<h2>Get the tags of a textid</h2>
|
|
<pre>id_tags(string $id) : 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">
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>$id</h4>
|
|
<code>string</code><p><p>textid to be checked upon</p></p>
|
|
</div>
|
|
|
|
<h3>Response</h3>
|
|
<code>array</code><p><p>Returns array with tags for that textid.</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_save"></a>
|
|
<div class="element clickable method public method_save" data-toggle="collapse" data-target=".method_save .collapse">
|
|
<h2>Save a text into the Database. Works like rename</h2>
|
|
<pre>save(string $id, string $new_id, string $lang, array $tags, string $text) : boolean</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">
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>$id</h4>
|
|
<code>string</code><p><p>Id of the text</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$new_id</h4>
|
|
<code>string</code><p><p>New Id of the text</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$lang</h4>
|
|
<code>string</code><p><p>Language of the text</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$tags</h4>
|
|
<code>array</code><p><p>Array with tags for that text</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$text</h4>
|
|
<code>string</code><p><p>Text to be saved</p></p>
|
|
</div>
|
|
|
|
<h3>Response</h3>
|
|
<code>boolean</code><p><p>Returns true or false</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_search"></a>
|
|
<div class="element clickable method public method_search" data-toggle="collapse" data-target=".method_search .collapse">
|
|
<h2>Search with content of texts with given tag</h2>
|
|
<pre>search(string $search, string $tag) : 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">
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>$search</h4>
|
|
<code>string</code><p><p>Searchstring "%" are added inside</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$tag</h4>
|
|
<code>string</code><p><p>Search only texts with given tag</p></p>
|
|
</div>
|
|
|
|
<h3>Response</h3>
|
|
<code>array</code><p><p>Returns array with texts for given searchstring and tag</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_tag"></a>
|
|
<div class="element clickable method public method_tag" data-toggle="collapse" data-target=".method_tag .collapse">
|
|
<h2>Get the texts with certain tag and language</h2>
|
|
<pre>tag(string $tag, string $lang = NULL, boolean $fallback = true) : 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">
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>$tag</h4>
|
|
<code>string</code><p><p>tag to be checked upon</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$lang</h4>
|
|
<code>string</code><p><p>Language for the requested texts</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$fallback</h4>
|
|
<code>boolean</code><p><p>Fallback to default language if certain id is not found for the specified language.</p></p>
|
|
</div>
|
|
|
|
<h3>Response</h3>
|
|
<code>array</code><p><p>Returns array with texts for requested tag.</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_tag_adv"></a>
|
|
<div class="element clickable method public method_tag_adv" data-toggle="collapse" data-target=".method_tag_adv .collapse">
|
|
<h2>Get the texts with certain tag and language plus creation user info etc</h2>
|
|
<pre>tag_adv(string $tag, string $lang = NULL, boolean $fallback = true) : 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">
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>$tag</h4>
|
|
<code>string</code><p><p>tag to be checked upon</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$lang</h4>
|
|
<code>string</code><p><p>Language for the requested texts</p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>$fallback</h4>
|
|
<code>boolean</code><p><p>Fallback to default language if certain id is not found for the specified language.</p></p>
|
|
</div>
|
|
|
|
<h3>Response</h3>
|
|
<code>array</code><p><p>Returns array with texts for requested tag including usernames etc for the texts</p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<h3><i class="icon-custom icon-constant"></i> Constants</h3>
|
|
<a id="constant_NEW_ENTRY"> </a>
|
|
<div class="element clickable constant constant_NEW_ENTRY" data-toggle="collapse" data-target=".constant_NEW_ENTRY .collapse">
|
|
<h2>Entry of a new text temporary used</h2>
|
|
<pre>NEW_ENTRY</pre>
|
|
<div class="labels">
|
|
</div>
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="\SYSTEM\PAGE\text"></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="../namespaces/SYSTEM.PAGE.html">PAGE</a></li>
|
|
|
|
<li class="active"><span class="divider">\</span><a href="../classes/SYSTEM.PAGE.text.html">text</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<footer class="span12">
|
|
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by
|
|
<a href="http://glyphicons.com/">Glyphicons</a>.<br/>
|
|
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and<br/>
|
|
generated on Tue, 25 Jul 2017 11:33:07 +0200.<br/>
|
|
</footer>
|
|
</body>
|
|
</html>
|