CanteenHTML5/classes/HTML5Error.html

963 lines
19 KiB
HTML
Raw Normal View History

2013-10-14 23:38:35 +04:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<link rel="stylesheet" href="http://yui.yahooapis.com/3.8.0/build/cssgrids/cssgrids-min.css">
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
<link rel="shortcut icon" type="image/png" href="../assets/favicon.png">
<script src="http://yui.yahooapis.com/3.10.1/build/yui/yui-min.js"></script>
2014-02-13 23:03:41 +04:00
<title>Canteen HTML5 API v1.0.1 API Documentation : HTML5Error</title>
2013-10-14 23:38:35 +04:00
</head>
<body class="yui3-skin-sam">
<div id="doc">
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">
<h1><a href=""><img src="../assets/css/logo.png" title="Canteen HTML5 API"></a></h1>
</div>
<div class="yui3-u-1-4 version">
2014-02-13 23:03:41 +04:00
<em>API Documentation for: 1.0.1</em>
2013-10-14 23:38:35 +04:00
</div>
</div>
<div id="bd" class="yui3-g">
<div class="yui3-u-1-4">
<div id="docs-sidebar" class="sidebar apidocs">
<div id="api-list">
<h2 class="off-left">APIs</h2>
<div id="api-tabview" class="tabview">
<div id="api-tabview-filter">
<input type="search" id="api-filter" placeholder="Type to filter APIs">
</div>
<ul class="tabs">
<li><a href="#api-classes">Classes</a></li>
<li><a href="#api-modules">Namespaces</a></li>
</ul>
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="../classes/Attribute.html">Attribute</a></li>
<li><a href="../classes/Comment.html">Comment</a></li>
<li><a href="../classes/Document.html">Document</a></li>
<li><a href="../classes/html.html">html</a></li>
<li><a href="../classes/HTML5Error.html">HTML5Error</a></li>
<li><a href="../classes/Node.html">Node</a></li>
<li><a href="../classes/NodeContainer.html">NodeContainer</a></li>
<li><a href="../classes/SimpleList.html">SimpleList</a></li>
<li><a href="../classes/Table.html">Table</a></li>
<li><a href="../classes/Text.html">Text</a></li>
</ul>
<ul id="api-modules" class="apis modules">
<li><a href="../modules/Canteen_HTML5.html">Canteen\HTML5</a></li>
<li><a href="../modules/global.html">global</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="yui3-u-3-4">
<div id="api-options">
Show:
<label for="api-show-inherited">
<input type="checkbox" id="api-show-inherited" checked>
Inherited
</label>
<label for="api-show-protected">
<input type="checkbox" id="api-show-protected">
Protected
</label>
<label for="api-show-private">
<input type="checkbox" id="api-show-private">
Private
</label>
<label for="api-show-deprecated">
<input type="checkbox" id="api-show-deprecated">
Deprecated
</label>
</div>
<div class="apidocs">
<div id="docs-main">
<div class="content">
<h1>HTML5Error Class</h1>
<div class="box meta">
<div class="extends">
Extends Exception
</div>
Namespace: <a href="../modules/Canteen\HTML5.html">Canteen\HTML5</a>
</div>
<div class="box intro">
<p>Exceptions with using the HTML5 API.</p>
<pre class="code prettyprint"><code>try
{
html(&#39;invalid&#39;, &#39;something&#39;);
}
catch(Canteen\HTML5\HTML5Error $e)
{
$e-&gt;getMessage();
}</code></pre>
</div>
<div class="constructor">
<h2>Constructor</h2>
<div id="method_HTML5Error" class="method item">
<h3 class="name"><code>HTML5Error</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>code</code>
</li>
<li class="arg">
<code class="optional">[data=&#x27;&#x27;]</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">code</code>
<span class="type">Int</span>
<div class="param-description">
<p>The code of the error</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[data=&#x27;&#x27;]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Additional data to associate with this error</p>
</div>
</li>
</ul>
</div>
</div>
</div>
<div id="classdocs" class="tabview">
<ul class="api-class-tabs">
<li class="api-class-tab index"><a href="#index">Index</a></li>
<li class="api-class-tab properties"><a href="#properties">Properties</a></li>
</ul>
<div>
<div id="index" class="api-class-tabpanel index">
<h2 class="off-left">Item Index</h2>
<div class="index-section properties">
<h3>Properties</h3>
<ul class="index-list properties extends">
<li class="index-item property">
<a href="#property_EMPTY_ATTRIBUTE_NAME">EMPTY_ATTRIBUTE_NAME</a>
<span class="flag static">static</span>
</li>
<li class="index-item property">
<a href="#property_EMPTY_ATTRIBUTE_VALUE">EMPTY_ATTRIBUTE_VALUE</a>
<span class="flag static">static</span>
</li>
<li class="index-item property">
<a href="#property_EMPTY_CHILD">EMPTY_CHILD</a>
<span class="flag static">static</span>
</li>
<li class="index-item property">
<a href="#property_EMPTY_NODE_TAG">EMPTY_NODE_TAG</a>
<span class="flag static">static</span>
</li>
<li class="index-item property">
<a href="#property_EMPTY_PARENT">EMPTY_PARENT</a>
<span class="flag static">static</span>
</li>
<li class="index-item property">
<a href="#property_INVALID_GETTER">INVALID_GETTER</a>
<span class="flag static">static</span>
</li>
<li class="index-item property">
<a href="#property_INVALID_NODE">INVALID_NODE</a>
<span class="flag static">static</span>
</li>
<li class="index-item property">
<a href="#property_INVALID_SETTER">INVALID_SETTER</a>
<span class="flag static">static</span>
</li>
<li class="index-item property">
<a href="#property_INVALID_TAG">INVALID_TAG</a>
<span class="flag static">static</span>
</li>
<li class="index-item property private">
<a href="#property_messages">messages</a>
<span class="flag static">static</span>
</li>
<li class="index-item property">
<a href="#property_OUT_OF_BOUNDS">OUT_OF_BOUNDS</a>
<span class="flag static">static</span>
</li>
<li class="index-item property">
<a href="#property_UNKNOWN">UNKNOWN</a>
<span class="flag static">static</span>
</li>
</ul>
</div>
</div>
<div id="properties" class="api-class-tabpanel">
<h2 class="off-left">Properties</h2>
<div id="property_EMPTY_ATTRIBUTE_NAME" class="property item">
<h3 class="name"><code>EMPTY_ATTRIBUTE_NAME</code></h3>
<span class="type">Int</span>
<span class="flag final">final</span>
<span class="flag static">static</span>
<div class="meta">
<p>
</p>
</div>
<div class="description">
<p>The database connection failed</p>
</div>
</div>
<div id="property_EMPTY_ATTRIBUTE_VALUE" class="property item">
<h3 class="name"><code>EMPTY_ATTRIBUTE_VALUE</code></h3>
<span class="type">Int</span>
<span class="flag final">final</span>
<span class="flag static">static</span>
<div class="meta">
<p>
</p>
</div>
<div class="description">
<p>The alias for a database is invalid</p>
</div>
</div>
<div id="property_EMPTY_CHILD" class="property item">
<h3 class="name"><code>EMPTY_CHILD</code></h3>
<span class="type">Int</span>
<span class="flag final">final</span>
<span class="flag static">static</span>
<div class="meta">
<p>
</p>
</div>
<div class="description">
<p>The child node is empty</p>
</div>
</div>
<div id="property_EMPTY_NODE_TAG" class="property item">
<h3 class="name"><code>EMPTY_NODE_TAG</code></h3>
<span class="type">Int</span>
<span class="flag final">final</span>
<span class="flag static">static</span>
<div class="meta">
<p>
</p>
</div>
<div class="description">
<p>When trying to create a node, the name is empty</p>
</div>
</div>
<div id="property_EMPTY_PARENT" class="property item">
<h3 class="name"><code>EMPTY_PARENT</code></h3>
<span class="type">Int</span>
<span class="flag final">final</span>
<span class="flag static">static</span>
<div class="meta">
<p>
</p>
</div>
<div class="description">
<p>The parent cannot be empty</p>
</div>
</div>
<div id="property_INVALID_GETTER" class="property item">
<h3 class="name"><code>INVALID_GETTER</code></h3>
<span class="type">Int</span>
<span class="flag final">final</span>
<span class="flag static">static</span>
<div class="meta">
<p>
</p>
</div>
<div class="description">
<p>The mysql where trying to execute was a problem</p>
</div>
</div>
<div id="property_INVALID_NODE" class="property item">
<h3 class="name"><code>INVALID_NODE</code></h3>
<span class="type">Int</span>
<span class="flag final">final</span>
<span class="flag static">static</span>
<div class="meta">
<p>
</p>
</div>
<div class="description">
<p>The node is not of instance type Node</p>
</div>
</div>
<div id="property_INVALID_SETTER" class="property item">
<h3 class="name"><code>INVALID_SETTER</code></h3>
<span class="type">Int</span>
<span class="flag final">final</span>
<span class="flag static">static</span>
<div class="meta">
<p>
</p>
</div>
<div class="description">
<p>The database name we&#39;re trying to switch to is invalid</p>
</div>
</div>
<div id="property_INVALID_TAG" class="property item">
<h3 class="name"><code>INVALID_TAG</code></h3>
<span class="type">Int</span>
<span class="flag final">final</span>
<span class="flag static">static</span>
<div class="meta">
<p>
</p>
</div>
<div class="description">
<p>The html tag name is invalid</p>
</div>
</div>
<div id="property_messages" class="property item private">
<h3 class="name"><code>messages</code></h3>
<span class="type">Dictionary</span>
<span class="flag private">private</span>
<span class="flag static">static</span>
<div class="meta">
<p>
</p>
</div>
<div class="description">
<p>Look-up for error messages</p>
</div>
</div>
<div id="property_OUT_OF_BOUNDS" class="property item">
<h3 class="name"><code>OUT_OF_BOUNDS</code></h3>
<span class="type">Int</span>
<span class="flag final">final</span>
<span class="flag static">static</span>
<div class="meta">
<p>
</p>
</div>
<div class="description">
<p>THe addChildAt is out of bounds</p>
</div>
</div>
<div id="property_UNKNOWN" class="property item">
<h3 class="name"><code>UNKNOWN</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<span class="flag final">final</span>
<span class="flag static">static</span>
<div class="meta">
<p>
</p>
</div>
<div class="description">
<p>The label for an error that is unknown or unfound in messages</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/js/yui-prettify.js"></script>
<script src="../assets/../api.js"></script>
<script src="../assets/js/api-filter.js"></script>
<script src="../assets/js/api-list.js"></script>
<script src="../assets/js/api-search.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>