2968 lines
205 KiB
HTML
2968 lines
205 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\SAI\saimod_sys_todo
|
|
</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> 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 inherited">
|
|
<a href="#method_call_account_action_change_email" title="call_account_action_change_email :: System Account Request Change EMail Token">
|
|
<span class="description">System Account Request Change EMail Token</span><pre>call_account_action_change_email</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_call_account_action_change_password" title="call_account_action_change_password :: System Account Change Password">
|
|
<span class="description">System Account Change Password</span><pre>call_account_action_change_password</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_call_account_action_check" title="call_account_action_check :: System Account Right Check">
|
|
<span class="description">System Account Right Check</span><pre>call_account_action_check</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_call_account_action_confirm" title="call_account_action_confirm :: System Account Confirm Tokens">
|
|
<span class="description">System Account Confirm Tokens</span><pre>call_account_action_confirm</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_call_account_action_confirm_email" title="call_account_action_confirm_email :: System Account Request Confirm EMail Token">
|
|
<span class="description">System Account Request Confirm EMail Token</span><pre>call_account_action_confirm_email</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_call_account_action_create" title="call_account_action_create :: System Account Create">
|
|
<span class="description">System Account Create</span><pre>call_account_action_create</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_call_account_action_isloggedin" title="call_account_action_isloggedin :: System Account isloggedin check">
|
|
<span class="description">System Account isloggedin check</span><pre>call_account_action_isloggedin</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_call_account_action_login" title="call_account_action_login :: System Account Login">
|
|
<span class="description">System Account Login</span><pre>call_account_action_login</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_call_account_action_logout" title="call_account_action_logout :: System Account Logout">
|
|
<span class="description">System Account Logout</span><pre>call_account_action_logout</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_call_account_action_reset_password" title="call_account_action_reset_password :: System Account Request Reset Password Token">
|
|
<span class="description">System Account Request Reset Password Token</span><pre>call_account_action_reset_password</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_call_bug" title="call_bug :: API Bug Call to report Bugs">
|
|
<span class="description">API Bug Call to report Bugs</span><pre>call_bug</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_call_cache" title="call_cache :: API Cache Call to request cached Data (usually js and css)">
|
|
<span class="description">API Cache Call to request cached Data (usually js and css)</span><pre>call_cache</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_call_cron" title="call_cron :: System run Cron Call">
|
|
<span class="description">System run Cron Call</span><pre>call_cron</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_call_files" title="call_files :: System File Request Call">
|
|
<span class="description">System File Request Call</span><pre>call_files</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_call_pages" title="call_pages :: System State-Pages Request Call">
|
|
<span class="description">System State-Pages Request Call</span><pre>call_pages</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_call_text" title="call_text :: System Text Request Call">
|
|
<span class="description">System Text Request Call</span><pre>call_text</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_default_page" title="default_page :: Default Page anchor to catch all calls not answered by the saimod api">
|
|
<span class="description">Default Page anchor to catch all calls not answered by the saimod api</span><pre>default_page</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_get_apigroup" title="get_apigroup :: Get the Api Group this Api is operating on">
|
|
<span class="description">Get the Api Group this Api is operating on</span><pre>get_apigroup</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_get_class" title="get_class :: Get the Classname of this class or derived registered saimod">
|
|
<span class="description">Get the Classname of this class or derived registered saimod</span><pre>get_class</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_get_default_state" title="get_default_state :: Get default state for this statesystem">
|
|
<span class="description">Get default state for this statesystem</span><pre>get_default_state</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_get_params" title="get_params :: Fixes Classnames for sai postfield">
|
|
<span class="description">Fixes Classnames for sai postfield</span><pre>get_params</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_js" title="js :: Get all js System Paths required for this Saimod">
|
|
<span class="description">Get all js System Paths required for this Saimod</span><pre>js</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_menu" title="menu :: Generate <li> Menu for the Saimod">
|
|
<span class="description">Generate <li> Menu for the Saimod</span><pre>menu</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_register" title="register :: Register a todo_stats">
|
|
<span class="description">Register a todo_stats</span><pre>register</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_report" title="report :: Save a Report to the ToDo Database">
|
|
<span class="description">Save a Report to the ToDo Database</span><pre>report</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_right_public" title="right_public :: Returns if the Saimod is public(access for everyone)">
|
|
<span class="description">Returns if the Saimod is public(access for everyone)</span><pre>right_public</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_right_right" title="right_right :: Returns if the requesting user has the required rights to access the Saimod">
|
|
<span class="description">Returns if the requesting user has the required rights to access the Saimod</span><pre>right_right</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_sai_mod__SYSTEM_SAI_saimod_sys_todo" title="sai_mod__SYSTEM_SAI_saimod_sys_todo :: Generate the HTML for the Saimods startpage">
|
|
<span class="description">Generate the HTML for the Saimods startpage</span><pre>sai_mod__SYSTEM_SAI_saimod_sys_todo</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_add" title="sai_mod__SYSTEM_SAI_saimod_sys_todo_action_add :: Add a new Todo">
|
|
<span class="description">Add a new Todo</span><pre>sai_mod__SYSTEM_SAI_saimod_sys_todo_action_add</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_assign" title="sai_mod__SYSTEM_SAI_saimod_sys_todo_action_assign :: Assign a Todo to the User">
|
|
<span class="description">Assign a Todo to the User</span><pre>sai_mod__SYSTEM_SAI_saimod_sys_todo_action_assign</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_close" title="sai_mod__SYSTEM_SAI_saimod_sys_todo_action_close :: Close a Todo">
|
|
<span class="description">Close a Todo</span><pre>sai_mod__SYSTEM_SAI_saimod_sys_todo_action_close</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_close_all" title="sai_mod__SYSTEM_SAI_saimod_sys_todo_action_close_all :: Close all Generated ToDos">
|
|
<span class="description">Close all Generated ToDos</span><pre>sai_mod__SYSTEM_SAI_saimod_sys_todo_action_close_all</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_deassign" title="sai_mod__SYSTEM_SAI_saimod_sys_todo_action_deassign :: Deassign a Todo from the User">
|
|
<span class="description">Deassign a Todo from the User</span><pre>sai_mod__SYSTEM_SAI_saimod_sys_todo_action_deassign</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_dotolist" title="sai_mod__SYSTEM_SAI_saimod_sys_todo_action_dotolist :: Generate the HTML for the list of closed Todos">
|
|
<span class="description">Generate the HTML for the list of closed Todos</span><pre>sai_mod__SYSTEM_SAI_saimod_sys_todo_action_dotolist</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_edit" title="sai_mod__SYSTEM_SAI_saimod_sys_todo_action_edit :: Edit the message of a Todo">
|
|
<span class="description">Edit the message of a Todo</span><pre>sai_mod__SYSTEM_SAI_saimod_sys_todo_action_edit</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_new" title="sai_mod__SYSTEM_SAI_saimod_sys_todo_action_new :: Generate the HTML for the form to add a new Todo">
|
|
<span class="description">Generate the HTML for the form to add a new Todo</span><pre>sai_mod__SYSTEM_SAI_saimod_sys_todo_action_new</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_open" title="sai_mod__SYSTEM_SAI_saimod_sys_todo_action_open :: Open a Todo">
|
|
<span class="description">Open a Todo</span><pre>sai_mod__SYSTEM_SAI_saimod_sys_todo_action_open</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_priority_down" title="sai_mod__SYSTEM_SAI_saimod_sys_todo_action_priority_down :: Decrease the Priority of a Todo">
|
|
<span class="description">Decrease the Priority of a Todo</span><pre>sai_mod__SYSTEM_SAI_saimod_sys_todo_action_priority_down</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_priority_up" title="sai_mod__SYSTEM_SAI_saimod_sys_todo_action_priority_up :: Increase the Priority of a Todo">
|
|
<span class="description">Increase the Priority of a Todo</span><pre>sai_mod__SYSTEM_SAI_saimod_sys_todo_action_priority_up</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_stats" title="sai_mod__SYSTEM_SAI_saimod_sys_todo_action_stats :: Generate the HTML for the statistics of the ToDos">
|
|
<span class="description">Generate the HTML for the statistics of the ToDos</span><pre>sai_mod__SYSTEM_SAI_saimod_sys_todo_action_stats</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_stats_name_assigned" title="sai_mod__SYSTEM_SAI_saimod_sys_todo_action_stats_name_assigned :: Calculate the Stats of assigned ToDos">
|
|
<span class="description">Calculate the Stats of assigned ToDos</span><pre>sai_mod__SYSTEM_SAI_saimod_sys_todo_action_stats_name_assigned</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_stats_name_closed" title="sai_mod__SYSTEM_SAI_saimod_sys_todo_action_stats_name_closed :: Calculate the Stats of closed ToDos">
|
|
<span class="description">Calculate the Stats of closed ToDos</span><pre>sai_mod__SYSTEM_SAI_saimod_sys_todo_action_stats_name_closed</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_todo" title="sai_mod__SYSTEM_SAI_saimod_sys_todo_action_todo :: Returns the HTML for a ToDo">
|
|
<span class="description">Returns the HTML for a ToDo</span><pre>sai_mod__SYSTEM_SAI_saimod_sys_todo_action_todo</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_todolist" title="sai_mod__SYSTEM_SAI_saimod_sys_todo_action_todolist :: Generate the HTML for the list of open Todos">
|
|
<span class="description">Generate the HTML for the list of open Todos</span><pre>sai_mod__SYSTEM_SAI_saimod_sys_todo_action_todolist</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_static__" title="static__ :: Static Time-Parameter _ Call to avoid caching and API Errors for JS requests">
|
|
<span class="description">Static Time-Parameter _ Call to avoid caching and API Errors for JS requests</span><pre>static__</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_static__escaped_fragment_" title="static__escaped_fragment_ :: Static Call handler for Hashbang-Crawling Requests">
|
|
<span class="description">Static Call handler for Hashbang-Crawling Requests</span><pre>static__escaped_fragment_</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_static__lang" title="static__lang :: Static Call to change Language for the current Session/User">
|
|
<span class="description">Static Call to change Language for the current Session/User</span><pre>static__lang</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_static__result" title="static__result :: Static Call to change Result-Type for the current Session/User">
|
|
<span class="description">Static Call to change Result-Type for the current Session/User</span><pre>static__result</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_statistics" title="statistics :: Generates an array with values from all registered Todo Stats and Summary">
|
|
<span class="description">Generates an array with values from all registered Todo Stats and Summary</span><pre>statistics</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_check_stats" title="check_stats :: Check if a todo_stats is valid">
|
|
<span class="description">Check if a todo_stats is valid</span><pre>check_stats</pre>
|
|
</a>
|
|
</li>
|
|
<li class="method private">
|
|
<a href="#method_generate_list" title="generate_list :: Internal Function to generate the HTML for the todo list">
|
|
<span class="description">Internal Function to generate the HTML for the todo list</span><pre>generate_list</pre>
|
|
</a>
|
|
</li>
|
|
<li class="method private">
|
|
<a href="#method_state" title="state :: Internal Function to generate the text for Todo Status Open & Closed">
|
|
<span class="description">Internal Function to generate the text for Todo Status Open & Closed</span><pre>state</pre>
|
|
</a>
|
|
</li>
|
|
<li class="method private">
|
|
<a href="#method_statebtn" title="statebtn :: Internal Function to generate the Buttons for Todo Status Open & Closed">
|
|
<span class="description">Internal Function to generate the Buttons for Todo Status Open & Closed</span><pre>statebtn</pre>
|
|
</a>
|
|
</li>
|
|
<li class="method private">
|
|
<a href="#method_trclass" title="trclass :: Internal Function to generate the Trclass(color) for the Todo">
|
|
<span class="description">Internal Function to generate the Trclass(color) for the Todo</span><pre>trclass</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>saimod_sys_todo</h1>
|
|
<small style="display: block; text-align: right">
|
|
Extends <a href="classes/SYSTEM-SAI-sai-module.html"><abbr title="\SYSTEM\SAI\sai_module">sai_module</abbr></a>
|
|
</small>
|
|
<p class="short_description">saimod_sys_todo Class provided by System as saimod to manage the system_todo, system_todo_assign table</p>
|
|
<div class="details">
|
|
<div class="long_description">
|
|
|
|
</div>
|
|
<table class="table table-bordered">
|
|
<tr>
|
|
<th>
|
|
package
|
|
</th>
|
|
<td>
|
|
|
|
<p>SYSTEM\SAI</p>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3><i class="icon-custom icon-method"></i> Methods</h3>
|
|
<a id="method_call_account_action_change_email"></a>
|
|
<div class="element clickable method public method_call_account_action_change_email inherited" data-toggle="collapse" data-target=".method_call_account_action_change_email .collapse">
|
|
<h2>System Account Request Change EMail Token</h2>
|
|
<pre>call_account_action_change_email(stringnew_email) : \SYSTEM\API\JSON</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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>new_email</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>Users new EMail Address</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
|
|
\SYSTEM\API\JSON</code><p><p>Returns JSON result with success/failure status</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_call_account_action_change_password"></a>
|
|
<div class="element clickable method public method_call_account_action_change_password inherited" data-toggle="collapse" data-target=".method_call_account_action_change_password .collapse">
|
|
<h2>System Account Change Password</h2>
|
|
<pre>call_account_action_change_password(stringold_password_sha1, stringnew_password_sha1) : \SYSTEM\API\JSON</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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>old_password_sha1</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>Users Old Password SHA1 String</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>new_password_sha1</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>Users New Password SHA1 String</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
|
|
\SYSTEM\API\JSON</code><p><p>Returns JSON result with success/failure status</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_call_account_action_check"></a>
|
|
<div class="element clickable method public method_call_account_action_check inherited" data-toggle="collapse" data-target=".method_call_account_action_check .collapse">
|
|
<h2>System Account Right Check</h2>
|
|
<pre>call_account_action_check(intrightid) : \SYSTEM\API\JSON</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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>rightid</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
|
|
int</code><p><p>RightID of the right to be checked</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
|
|
\SYSTEM\API\JSON</code><p><p>Returns JSON result with success/failure status</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_call_account_action_confirm"></a>
|
|
<div class="element clickable method public method_call_account_action_confirm inherited" data-toggle="collapse" data-target=".method_call_account_action_confirm .collapse">
|
|
<h2>System Account Confirm Tokens</h2>
|
|
<pre>call_account_action_confirm(stringtoken) : \SYSTEM\API\JSON</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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>token</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>Token to do specifics with your Account</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
|
|
\SYSTEM\API\JSON</code><p><p>Returns JSON result with success/failure status</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_call_account_action_confirm_email"></a>
|
|
<div class="element clickable method public method_call_account_action_confirm_email inherited" data-toggle="collapse" data-target=".method_call_account_action_confirm_email .collapse">
|
|
<h2>System Account Request Confirm EMail Token</h2>
|
|
<pre>call_account_action_confirm_email() : \SYSTEM\API\JSON</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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
|
|
\SYSTEM\API\JSON</code><p><p>Returns JSON result with success/failure status</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_call_account_action_create"></a>
|
|
<div class="element clickable method public method_call_account_action_create inherited" data-toggle="collapse" data-target=".method_call_account_action_create .collapse">
|
|
<h2>System Account Create</h2>
|
|
<pre>call_account_action_create(stringusername, \SYSTEM\API\sha1password_sha1, \SYSTEM\API\emailemail, \SYSTEM\API\langlocale = null) : \SYSTEM\API\JSON</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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>username</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>Username</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>password_sha1</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
|
|
\SYSTEM\API\sha1</code><p><p>User Password SHA1 String</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>email</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
|
|
\SYSTEM\API\email</code><p><p>Email of the new User</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>locale</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
|
|
\SYSTEM\API\lang</code><p><p>Locale which the User wants to register or null for default language</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
|
|
\SYSTEM\API\JSON</code><p><p>Returns JSON result with success/failure status</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_call_account_action_isloggedin"></a>
|
|
<div class="element clickable method public method_call_account_action_isloggedin inherited" data-toggle="collapse" data-target=".method_call_account_action_isloggedin .collapse">
|
|
<h2>System Account isloggedin check</h2>
|
|
<pre>call_account_action_isloggedin() : \SYSTEM\API\JSON</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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
|
|
\SYSTEM\API\JSON</code><p><p>Returns JSON result with success/failure status</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_call_account_action_login"></a>
|
|
<div class="element clickable method public method_call_account_action_login inherited" data-toggle="collapse" data-target=".method_call_account_action_login .collapse">
|
|
<h2>System Account Login</h2>
|
|
<pre>call_account_action_login(stringusername, \SYSTEM\API\sha1password_sha1, \SYSTEM\API\langlocale = null) : \SYSTEM\API\JSON</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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>username</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>Username</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>password_sha1</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
|
|
\SYSTEM\API\sha1</code><p><p>User Password SHA1 String</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>locale</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
|
|
\SYSTEM\API\lang</code><p><p>Locale which the User wants to login with</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
|
|
\SYSTEM\API\JSON</code><p><p>Returns JSON result with success/failure status</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_call_account_action_logout"></a>
|
|
<div class="element clickable method public method_call_account_action_logout inherited" data-toggle="collapse" data-target=".method_call_account_action_logout .collapse">
|
|
<h2>System Account Logout</h2>
|
|
<pre>call_account_action_logout() : \SYSTEM\API\JSON</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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
|
|
\SYSTEM\API\JSON</code><p><p>Returns JSON result with success/failure status</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_call_account_action_reset_password"></a>
|
|
<div class="element clickable method public method_call_account_action_reset_password inherited" data-toggle="collapse" data-target=".method_call_account_action_reset_password .collapse">
|
|
<h2>System Account Request Reset Password Token</h2>
|
|
<pre>call_account_action_reset_password(stringusername) : \SYSTEM\API\JSON</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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>username</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>Username</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
|
|
\SYSTEM\API\JSON</code><p><p>Returns JSON result with success/failure status</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_call_bug"></a>
|
|
<div class="element clickable method public method_call_bug inherited" data-toggle="collapse" data-target=".method_call_bug .collapse">
|
|
<h2>API Bug Call to report Bugs</h2>
|
|
<pre>call_bug(stringmessage, \SYSTEM\API\JSONdata) : null</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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>message</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>Bugreport Message</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>data</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
|
|
\SYSTEM\API\JSON</code><p><p>Bugreport Data</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 JSON result with success/failure status</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_call_cache"></a>
|
|
<div class="element clickable method public method_call_cache inherited" data-toggle="collapse" data-target=".method_call_cache .collapse">
|
|
<h2>API Cache Call to request cached Data (usually js and css)</h2>
|
|
<pre>call_cache(intid, \SYSTEM\API\sha1ident) : mixed</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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>id</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
|
|
int</code><p><p>Cache id to be queried</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>ident</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
|
|
\SYSTEM\API\sha1</code><p><p>Cache ident to be queried</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
|
|
mixed</code><p><p>Returns cached Data from Database</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_call_cron"></a>
|
|
<div class="element clickable method public method_call_cron inherited" data-toggle="collapse" data-target=".method_call_cron .collapse">
|
|
<h2>System run Cron Call</h2>
|
|
<pre>call_cron() : \SYSTEM\API\JSON</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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
|
|
\SYSTEM\API\JSON</code><p><p>Returns JSON result with success/failure status</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_call_files"></a>
|
|
<div class="element clickable method public method_call_files inherited" data-toggle="collapse" data-target=".method_call_files .collapse">
|
|
<h2>System File Request Call</h2>
|
|
<pre>call_files(stringcat, stringid = null) : mixed</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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>cat</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>File category</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>id</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>File name</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
|
|
mixed</code><p><p>Returns JSON result with failure status or streams the File</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_call_pages"></a>
|
|
<div class="element clickable method public method_call_pages inherited" data-toggle="collapse" data-target=".method_call_pages .collapse">
|
|
<h2>System State-Pages Request Call</h2>
|
|
<pre>call_pages(intgroup, stringstate) : mixed</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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>group</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
|
|
int</code><p><p>Page Group for Statesystem</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>state</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>Full name of the State.</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
|
|
mixed</code><p><p>Returns JSON result with data/failure status</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_call_text"></a>
|
|
<div class="element clickable method public method_call_text inherited" data-toggle="collapse" data-target=".method_call_text .collapse">
|
|
<h2>System Text Request Call</h2>
|
|
<pre>call_text(mixedrequest, \SYSTEM\API\langlang) : \SYSTEM\API\JSON</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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>request</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
|
|
mixed</code><p><p>Request String for Text API</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>lang</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
|
|
\SYSTEM\API\lang</code><p><p>Request Language for given text</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
|
|
\SYSTEM\API\JSON</code><p><p>Returns JSON result with data/failure status</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_check_stats"></a>
|
|
<div class="element clickable method private method_check_stats" data-toggle="collapse" data-target=".method_check_stats .collapse">
|
|
<h2>Check if a todo_stats is valid</h2>
|
|
<pre>check_stats(stringstats) : 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>stats</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>Classname of the todo_stats</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_default_page"></a>
|
|
<div class="element clickable method public method_default_page inherited" data-toggle="collapse" data-target=".method_default_page .collapse">
|
|
<h2>Default Page anchor to catch all calls not answered by the saimod api</h2>
|
|
<pre>default_page(string_escaped_fragment_ = null) : string</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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>_escaped_fragment_</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>Param for Hashbangcrawling</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 HTML of the defaultpage</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_generate_list"></a>
|
|
<div class="element clickable method private method_generate_list" data-toggle="collapse" data-target=".method_generate_list .collapse">
|
|
<h2>Internal Function to generate the HTML for the todo list</h2>
|
|
<pre>generate_list(intstate, stringfilter, stringsearch, intpage) : 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>state</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
|
|
int</code><p><p>Todo State</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>filter</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>Category Filter</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>search</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>Search Parameter</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>page</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
|
|
int</code><p><p>Page Number (returns only 100)</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 HTML</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_get_apigroup"></a>
|
|
<div class="element clickable method public method_get_apigroup inherited" data-toggle="collapse" data-target=".method_get_apigroup .collapse">
|
|
<h2>Get the Api Group this Api is operating on</h2>
|
|
<pre>get_apigroup() : int</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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
|
|
int</code><p><p>Returns api group id.</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_get_class"></a>
|
|
<div class="element clickable method public method_get_class inherited" data-toggle="collapse" data-target=".method_get_class .collapse">
|
|
<h2>Get the Classname of this class or derived registered saimod</h2>
|
|
<pre>get_class(arrayparams = NULL) : string</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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>params</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
|
|
array</code><p><p>Parameters with which the Saimodule was called</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 name of the class this api operates on.</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_get_default_state"></a>
|
|
<div class="element clickable method public method_get_default_state inherited" data-toggle="collapse" data-target=".method_get_default_state .collapse">
|
|
<h2>Get default state for this statesystem</h2>
|
|
<pre>get_default_state() : string</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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
|
|
string</code><p><p>Returns name of the startstate.</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_get_params"></a>
|
|
<div class="element clickable method public method_get_params inherited" data-toggle="collapse" data-target=".method_get_params .collapse">
|
|
<h2>Fixes Classnames for sai postfield</h2>
|
|
<pre>get_params(arrayparams) : array</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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>params</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
|
|
array</code><p><p>Params to be corrected</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 of corrected Params.</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_js"></a>
|
|
<div class="element clickable method public method_js" data-toggle="collapse" data-target=".method_js .collapse">
|
|
<h2>Get all js System Paths required for this Saimod</h2>
|
|
<pre>js() : 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>
|
|
|
|
|
|
|
|
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 of Pathobjects pointing to the saimods js</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_menu"></a>
|
|
<div class="element clickable method public method_menu" data-toggle="collapse" data-target=".method_menu .collapse">
|
|
<h2>Generate <li> Menu for the Saimod</h2>
|
|
<pre>menu() : 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>
|
|
|
|
|
|
|
|
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 <li> Menu for the Saimod</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_register"></a>
|
|
<div class="element clickable method public method_register" data-toggle="collapse" data-target=".method_register .collapse">
|
|
<h2>Register a todo_stats</h2>
|
|
<pre>register(stringstats) : 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>stats</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>Classname of the todo_stats</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_report"></a>
|
|
<div class="element clickable method public method_report" data-toggle="collapse" data-target=".method_report .collapse">
|
|
<h2>Save a Report to the ToDo Database</h2>
|
|
<pre>report(stringmessage, arraydata) : \SYSTEM\SAI\JSON</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>message</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>Message of the Report</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>data</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
|
|
array</code><p><p>Data for the Report</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
|
|
\SYSTEM\SAI\JSON</code><p><p>Returns json with status true</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_right_public"></a>
|
|
<div class="element clickable method public method_right_public" data-toggle="collapse" data-target=".method_right_public .collapse">
|
|
<h2>Returns if the Saimod is public(access for everyone)</h2>
|
|
<pre>right_public() : 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>
|
|
|
|
|
|
|
|
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 if the Saimod is public(true) or not(false)</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_right_right"></a>
|
|
<div class="element clickable method public method_right_right" data-toggle="collapse" data-target=".method_right_right .collapse">
|
|
<h2>Returns if the requesting user has the required rights to access the Saimod</h2>
|
|
<pre>right_right() : 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>
|
|
|
|
|
|
|
|
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 the user can access</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_sai_mod__SYSTEM_SAI_saimod_sys_todo"></a>
|
|
<div class="element clickable method public method_sai_mod__SYSTEM_SAI_saimod_sys_todo" data-toggle="collapse" data-target=".method_sai_mod__SYSTEM_SAI_saimod_sys_todo .collapse">
|
|
<h2>Generate the HTML for the Saimods startpage</h2>
|
|
<pre>sai_mod__SYSTEM_SAI_saimod_sys_todo() : 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>
|
|
|
|
|
|
|
|
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 HTML for the Saimods startpage</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_add"></a>
|
|
<div class="element clickable method public method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_add" data-toggle="collapse" data-target=".method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_add .collapse">
|
|
<h2>Add a new Todo</h2>
|
|
<pre>sai_mod__SYSTEM_SAI_saimod_sys_todo_action_add(stringtodo) : \SYSTEM\SAI\JSON</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>todo</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>text of the Todo</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
|
|
\SYSTEM\SAI\JSON</code><p><p>Returns Json with status ok</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_assign"></a>
|
|
<div class="element clickable method public method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_assign" data-toggle="collapse" data-target=".method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_assign .collapse">
|
|
<h2>Assign a Todo to the User</h2>
|
|
<pre>sai_mod__SYSTEM_SAI_saimod_sys_todo_action_assign(inttodo) : \SYSTEM\SAI\JSON</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>todo</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
|
|
int</code><p><p>Id of the Todo</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
|
|
\SYSTEM\SAI\JSON</code><p><p>Returns Json with status ok</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_close"></a>
|
|
<div class="element clickable method public method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_close" data-toggle="collapse" data-target=".method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_close .collapse">
|
|
<h2>Close a Todo</h2>
|
|
<pre>sai_mod__SYSTEM_SAI_saimod_sys_todo_action_close(inttodo) : \SYSTEM\SAI\JSON</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>todo</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
|
|
int</code><p><p>Id of the Todo</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
|
|
\SYSTEM\SAI\JSON</code><p><p>Returns Json with status ok</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_close_all"></a>
|
|
<div class="element clickable method public method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_close_all" data-toggle="collapse" data-target=".method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_close_all .collapse">
|
|
<h2>Close all Generated ToDos</h2>
|
|
<pre>sai_mod__SYSTEM_SAI_saimod_sys_todo_action_close_all() : \SYSTEM\SAI\JSON</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
|
|
\SYSTEM\SAI\JSON</code><p><p>Returns Json with status ok</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_deassign"></a>
|
|
<div class="element clickable method public method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_deassign" data-toggle="collapse" data-target=".method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_deassign .collapse">
|
|
<h2>Deassign a Todo from the User</h2>
|
|
<pre>sai_mod__SYSTEM_SAI_saimod_sys_todo_action_deassign(inttodo) : \SYSTEM\SAI\JSON</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>todo</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
|
|
int</code><p><p>Id of the Todo</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
|
|
\SYSTEM\SAI\JSON</code><p><p>Returns Json with status ok</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_dotolist"></a>
|
|
<div class="element clickable method public method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_dotolist" data-toggle="collapse" data-target=".method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_dotolist .collapse">
|
|
<h2>Generate the HTML for the list of closed Todos</h2>
|
|
<pre>sai_mod__SYSTEM_SAI_saimod_sys_todo_action_dotolist(stringfilter = 'all', stringsearch = '%', intpage = 0) : 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>filter</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>Category Filter</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>search</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>Search Parameter</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>page</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
|
|
int</code><p><p>Page Number (returns only 100)</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 HTML</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_edit"></a>
|
|
<div class="element clickable method public method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_edit" data-toggle="collapse" data-target=".method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_edit .collapse">
|
|
<h2>Edit the message of a Todo</h2>
|
|
<pre>sai_mod__SYSTEM_SAI_saimod_sys_todo_action_edit(inttodo, stringmessage) : \SYSTEM\SAI\JSON</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>todo</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
|
|
int</code><p><p>Id of the Todo</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>message</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>Message for the Todo</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
|
|
\SYSTEM\SAI\JSON</code><p><p>Returns Json with status ok</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_new"></a>
|
|
<div class="element clickable method public method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_new" data-toggle="collapse" data-target=".method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_new .collapse">
|
|
<h2>Generate the HTML for the form to add a new Todo</h2>
|
|
<pre>sai_mod__SYSTEM_SAI_saimod_sys_todo_action_new() : 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>
|
|
|
|
|
|
|
|
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 HTML</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_open"></a>
|
|
<div class="element clickable method public method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_open" data-toggle="collapse" data-target=".method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_open .collapse">
|
|
<h2>Open a Todo</h2>
|
|
<pre>sai_mod__SYSTEM_SAI_saimod_sys_todo_action_open(inttodo) : \SYSTEM\SAI\JSON</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>todo</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
|
|
int</code><p><p>Id of the Todo</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
|
|
\SYSTEM\SAI\JSON</code><p><p>Returns Json with status ok</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_priority_down"></a>
|
|
<div class="element clickable method public method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_priority_down" data-toggle="collapse" data-target=".method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_priority_down .collapse">
|
|
<h2>Decrease the Priority of a Todo</h2>
|
|
<pre>sai_mod__SYSTEM_SAI_saimod_sys_todo_action_priority_down(inttodo) : \SYSTEM\SAI\JSON</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>todo</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
|
|
int</code><p><p>Id of the Todo</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
|
|
\SYSTEM\SAI\JSON</code><p><p>Returns Json with status ok</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_priority_up"></a>
|
|
<div class="element clickable method public method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_priority_up" data-toggle="collapse" data-target=".method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_priority_up .collapse">
|
|
<h2>Increase the Priority of a Todo</h2>
|
|
<pre>sai_mod__SYSTEM_SAI_saimod_sys_todo_action_priority_up(inttodo) : \SYSTEM\SAI\JSON</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>todo</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
|
|
int</code><p><p>Id of the Todo</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
|
|
\SYSTEM\SAI\JSON</code><p><p>Returns Json with status ok</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_stats"></a>
|
|
<div class="element clickable method public method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_stats" data-toggle="collapse" data-target=".method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_stats .collapse">
|
|
<h2>Generate the HTML for the statistics of the ToDos</h2>
|
|
<pre>sai_mod__SYSTEM_SAI_saimod_sys_todo_action_stats() : 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>
|
|
|
|
|
|
|
|
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 HTML</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_stats_name_assigned"></a>
|
|
<div class="element clickable method public method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_stats_name_assigned" data-toggle="collapse" data-target=".method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_stats_name_assigned .collapse">
|
|
<h2>Calculate the Stats of assigned ToDos</h2>
|
|
<pre>sai_mod__SYSTEM_SAI_saimod_sys_todo_action_stats_name_assigned(stringfilter) : \SYSTEM\SAI\JSON</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>filter</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>Filter for the Calculation</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
|
|
\SYSTEM\SAI\JSON</code><p><p>Returns Json with stats data</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_stats_name_closed"></a>
|
|
<div class="element clickable method public method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_stats_name_closed" data-toggle="collapse" data-target=".method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_stats_name_closed .collapse">
|
|
<h2>Calculate the Stats of closed ToDos</h2>
|
|
<pre>sai_mod__SYSTEM_SAI_saimod_sys_todo_action_stats_name_closed(stringfilter) : \SYSTEM\SAI\JSON</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>filter</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>Filter for the Calculation</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
|
|
\SYSTEM\SAI\JSON</code><p><p>Returns Json with stats data</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_todo"></a>
|
|
<div class="element clickable method public method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_todo" data-toggle="collapse" data-target=".method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_todo .collapse">
|
|
<h2>Returns the HTML for a ToDo</h2>
|
|
<pre>sai_mod__SYSTEM_SAI_saimod_sys_todo_action_todo(inttodo) : 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>todo</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
|
|
int</code><p><p>Id of the Todo</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 HTML</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_todolist"></a>
|
|
<div class="element clickable method public method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_todolist" data-toggle="collapse" data-target=".method_sai_mod__SYSTEM_SAI_saimod_sys_todo_action_todolist .collapse">
|
|
<h2>Generate the HTML for the list of open Todos</h2>
|
|
<pre>sai_mod__SYSTEM_SAI_saimod_sys_todo_action_todolist(stringfilter = 'all', stringsearch = '%', intpage = 0) : 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>filter</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>Category Filter</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>search</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>Search Parameter</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>page</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
|
|
int</code><p><p>Page Number (returns only 100)</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 HTML</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_state"></a>
|
|
<div class="element clickable method private method_state" data-toggle="collapse" data-target=".method_state .collapse">
|
|
<h2>Internal Function to generate the text for Todo Status Open & Closed</h2>
|
|
<pre>state(intstate) : 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>state</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
|
|
int</code><p><p>State of the Todo</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 open or closed string</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_statebtn"></a>
|
|
<div class="element clickable method private method_statebtn" data-toggle="collapse" data-target=".method_statebtn .collapse">
|
|
<h2>Internal Function to generate the Buttons for Todo Status Open & Closed</h2>
|
|
<pre>statebtn(intstate) : 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>state</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
|
|
int</code><p><p>State of the Todo</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 the HTML of the open clase buttons</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_static__"></a>
|
|
<div class="element clickable method public method_static__ inherited" data-toggle="collapse" data-target=".method_static__ .collapse">
|
|
<h2>Static Time-Parameter _ Call to avoid caching and API Errors for JS requests</h2>
|
|
<pre>static__(mixed_) : null</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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>_</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
|
|
mixed</code><p><p>Anticaching Parameter of some Browsers</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 nothing</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_static__escaped_fragment_"></a>
|
|
<div class="element clickable method public method_static__escaped_fragment_ inherited" data-toggle="collapse" data-target=".method_static__escaped_fragment_ .collapse">
|
|
<h2>Static Call handler for Hashbang-Crawling Requests</h2>
|
|
<pre>static__escaped_fragment_(string_escaped_fragment_) : string</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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>_escaped_fragment_</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>Hashbang-Encoded State</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 your API-HTML result as HTML-Snapshot</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_static__lang"></a>
|
|
<div class="element clickable method public method_static__lang inherited" data-toggle="collapse" data-target=".method_static__lang .collapse">
|
|
<h2>Static Call to change Language for the current Session/User</h2>
|
|
<pre>static__lang(\SYSTEM\API\langlang) : null</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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>lang</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
|
|
\SYSTEM\API\lang</code><p><p>Language requested</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 nothing</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_static__result"></a>
|
|
<div class="element clickable method public method_static__result inherited" data-toggle="collapse" data-target=".method_static__result .collapse">
|
|
<h2>Static Call to change Result-Type for the current Session/User</h2>
|
|
<pre>static__result(\SYSTEM\API\resultresult) : null</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <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>result</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
|
|
\SYSTEM\API\result</code><p><p>Resulttype</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 nothing</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_statistics"></a>
|
|
<div class="element clickable method public method_statistics" data-toggle="collapse" data-target=".method_statistics .collapse">
|
|
<h2>Generates an array with values from all registered Todo Stats and Summary</h2>
|
|
<pre>statistics() : 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>
|
|
|
|
|
|
|
|
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 with todo stats</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_trclass"></a>
|
|
<div class="element clickable method private method_trclass" data-toggle="collapse" data-target=".method_trclass .collapse">
|
|
<h2>Internal Function to generate the Trclass(color) for the Todo</h2>
|
|
<pre>trclass(inttype, stringclass, intassignee, intuserid) : 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>type</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
|
|
int</code><p><p>Type of the Todo</p>
|
|
</p>
|
|
</div>
|
|
<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 of the Todo</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>assignee</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
|
|
int</code><p><p>Userid of the assigned for this Todo</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>userid</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
|
|
int</code><p><p>Userid of the Current logged in User</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 the HTML of the open clase buttons</p>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
<h3><i class="icon-custom icon-property"></i> Properties</h3>
|
|
<a id="property_stats"> </a>
|
|
<div class="element clickable property private property_stats" data-toggle="collapse" data-target=".property_stats .collapse">
|
|
<h2>array Variable to store all registred todo_stats</h2>
|
|
<pre>stats : </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\SAI\saimod_sys_todo"></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\SAI">SAI</a></li>
|
|
|
|
<li class="active"><span class="divider">\</span><a href="\SYSTEM\SAI\saimod_sys_todo">saimod_sys_todo</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>
|