/public/docs/classes/Error.html
HTML | 303 lines | 269 code | 31 blank | 3 comment | 0 complexity | 3f4ed2dbdedec7e46ffb06db213f91f7 MD5 | raw file
- <!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> » \Error
- </title>
- <meta name="author" content=""/>
- <meta name="description" content=""/>
- <!--[if lt IE 9]>
- <script src="http://html5shim.googlecode.com/svn/trunk/html5.js" type="text/javascript"></script>
- <![endif]-->
- <link href="../css/template.css" rel="stylesheet" media="all"/>
- <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">API Documentation</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">
- </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>
-
- <div class="row">
- <div class="span4">
- <span 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></span><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>
- <ul class="side-nav nav nav-list">
- <li class="nav-header">
- <i class="icon-custom icon-method"></i> Methods
- <ul>
- <li class="method public">
- <a href="#method_check" title="check :: Function check, checks if an error has been set.">
- <span class="description">Function check, checks if an error has been set.</span><pre>check</pre>
- </a>
- </li>
- <li class="method public">
- <a href="#method_get" title="get :: Function get, will get the requested error message.">
- <span class="description">Function get, will get the requested error message.</span><pre>get</pre>
- </a>
- </li>
- <li class="method public">
- <a href="#method_set" title="set :: Function to set a cookie or session as an error. Returns true if successful, false if not.">
- <span class="description">Function to set a cookie or session as an error. Returns true if successful, false if not.</span><pre>set</pre>
- </a>
- </li>
- </ul>
- </li>
- <li class="nav-header protected">Âť Protected
- <ul>
- </ul>
- </li>
- <li class="nav-header private">Âť Private
- <ul>
- </ul>
- </li>
- <li class="nav-header">
- <i class="icon-custom icon-constant"></i> Constants
- <ul>
- </ul>
- </li>
- </ul>
- </div>
- <div class="span8">
- <div class="element class">
- <h1>Error</h1>
- <small style="display: block; text-align: right">
- </small>
- <p class="short_description">The errors class is used to check if any errors have been activated and display them.</p>
- <div class="details">
- <div class="long_description">
- <p>It also has a specific function to set an error to be displayed when the user next
- loads the page.</p>
- </div>
- <table class="table table-bordered">
- <tr>
- <th>
- author
- </th>
- <td>Joseph Ralph <jralph@arrowvaleacademy.co.uk></td>
- </tr>
- </table>
- <h3><i class="icon-custom icon-method"></i> Methods</h3>
- <a id="method_check"></a>
- <div class="element clickable method public method_check" data-toggle="collapse" data-target=".method_check .collapse">
- <h2>Function check, checks if an error has been set.</h2>
- <pre>check(string $name, string $location = 'session') </pre>
- <div class="labels">
- <span class="label">static</span> </div>
- <div class="row collapse">
- <div class="detail-description">
- <div class="long_description"><p>Using this class, errors are stored using <em>error</em> as the prefix.
- This function will automatically use <em>error</em> as a prefix for any
- requested names.
- eg. _error_login or _error_register or _error_general</p>
- </div>
- <table class="table">
- <tr>
- <th>
-
- </th>
- <td>
- </td>
- </tr>
- </table>
- <h3>Arguments</h3>
- <div class="subelement argument">
- <h4>$name</h4>
- <code>string</code><p><p>The name of the error to be checked</p>
- </p>
- </div>
- <div class="subelement argument">
- <h4>$location</h4>
- <code>string</code><p><p>The location (eg, in session or cookie). Default as session.</p>
- </p>
- </div>
-
- </div>
- </div>
- </div>
- <a id="method_get"></a>
- <div class="element clickable method public method_get" data-toggle="collapse" data-target=".method_get .collapse">
- <h2>Function get, will get the requested error message.</h2>
- <pre>get(string $name, string $location = 'session') </pre>
- <div class="labels">
- <span class="label">static</span> </div>
- <div class="row collapse">
- <div class="detail-description">
- <div class="long_description"><p>Best used after Error::check();
- Example:
- <code>
- if( Error::check('general') ){
- echo Error::get('general');
- }
- </code></p>
- <p>Will return the value if available or false if not. If a value is returned
- the value will then be unset from the session or cookie so that it is only
- used once.</p>
- </div>
- <table class="table">
- <tr>
- <th>
-
- </th>
- <td>
- </td>
- </tr>
- </table>
- <h3>Arguments</h3>
- <div class="subelement argument">
- <h4>$name</h4>
- <code>string</code><p><p>The name of the error to be returned</p>
- </p>
- </div>
- <div class="subelement argument">
- <h4>$location</h4>
- <code>string</code><p><p>The location (eg, in session or cookie). Default as session.</p>
- </p>
- </div>
-
- </div>
- </div>
- </div>
- <a id="method_set"></a>
- <div class="element clickable method public method_set" data-toggle="collapse" data-target=".method_set .collapse">
- <h2>Function to set a cookie or session as an error. Returns true if successful, false if not.</h2>
- <pre>set(string $name, string $value, string $location = 'session') </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>$name</h4>
- <code>string</code><p><p>The name of the error (excluding <em>error</em>).</p>
- </p>
- </div>
- <div class="subelement argument">
- <h4>$value</h4>
- <code>string</code><p><p>The error message or value.</p>
- </p>
- </div>
- <div class="subelement argument">
- <h4>$location</h4>
- <code>string</code><p><p>The location to store the error (session or cookie).</p>
- </p>
- </div>
-
- </div>
- </div>
- </div>
-
-
- </div>
- </div>
- <a id="\Error"></a>
- <ul class="breadcrumb">
- <li><a href="../index.html"><i class="icon-custom icon-class"></i></a></li>
-
-
- <li>
- <span class="divider">\</span><a href="../namespaces/default.html">\</a>
- </li>
- <li class="active"><span class="divider">\</span><a href="../classes/Error.html">Error</a></li>
- </ul>
- </div>
- </div>
- </div>
- <footer class="span12">
- Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by
- <a href="http://glyphicons.com/">Glyphicons</a>.<br/>
- Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and<br/>
- generated on Fri, 14 Jun 2013 19:02:00 +0200.<br/>
- </footer>
- </body>
- </html>