phpdoc/MVCFundamental/Commons/Helper.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>MVCFundamental\Commons\Helper | MVC Fundamental</title>
<link rel="stylesheet" type="text/css" href="../../css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="../../css/bootstrap-theme.min.css">
<link rel="stylesheet" type="text/css" href="../../css/sami.css">
<script src="../../js/jquery-1.11.1.min.js"></script>
<script src="../../js/bootstrap.min.js"></script>
<script src="../../js/typeahead.min.js"></script>
<script src="../../sami.js"></script>
<meta name="MobileOptimized" content="width">
<meta name="HandheldFriendly" content="true">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
</head>
<body id="class" data-name="class:MVCFundamental_Commons_Helper" data-root-path="../../">
<div id="content">
<div id="left-column">
<div id="control-panel">
<form id="search-form" action="../../search.html" method="GET">
<span class="glyphicon glyphicon-search"></span>
<input name="search"
class="typeahead form-control"
type="search"
placeholder="Search">
</form>
</div>
<div id="api-tree"></div>
</div>
<div id="right-column">
<nav id="site-nav" class="navbar navbar-default" role="navigation">
<div class="container-fluid">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-elements">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../../index.html">MVC Fundamental</a>
</div>
<div class="collapse navbar-collapse" id="navbar-elements">
<ul class="nav navbar-nav">
<li><a href="../../classes.html">Classes</a></li>
<li><a href="../../namespaces.html">Namespaces</a></li>
<li><a href="../../interfaces.html">Interfaces</a></li>
<li><a href="../../traits.html">Traits</a></li>
<li><a href="../../doc-index.html">Index</a></li>
<li><a href="../../search.html">Search</a></li>
</ul>
</div>
</div>
</nav>
<div class="namespace-breadcrumbs">
<ol class="breadcrumb">
<li><span class="label label-default">class</span></li>
<li><a href="../../MVCFundamental.html">MVCFundamental</a></li>
<li><a href="../../MVCFundamental/Commons.html">Commons</a></li>
<li>Helper</li>
</ol>
</div>
<div id="page-content">
<div class="page-header">
<h1>Helper</h1>
</div>
<p> class
<strong>Helper</strong>
</p>
<div class="description">
<p>This is the global app Helper</p> </div>
<h2>Methods</h2>
<div class="container-fluid underlined">
<div class="row">
<div class="col-md-2 type">
static
array
</div>
<div class="col-md-8 type">
<a href="#method_getDefaultEnvParameters">getDefaultEnvParameters</a>()
<p>Get the default environment vars to load in views and calling controller's actions</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
static
bool
</div>
<div class="col-md-8 type">
<a href="#method_classImplements">classImplements</a>($class_name, $interface_name)
<p>Test if a class implements an interface</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
static
string
</div>
<div class="col-md-8 type">
<a href="#method_getPropertyName">getPropertyName</a>(
string $name = '',
string $replace = '_',
bool $capitalize_first_char = true)
<p>Get a safe class property name in camel case</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
static
string
</div>
<div class="col-md-8 type">
<a href="#method_getMethodName">getMethodName</a>($property_name)
<p>Get a safe class method name in camel case</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
static
mixed
</div>
<div class="col-md-8 type">
<a href="#method_fetchArguments">fetchArguments</a>(
null $method_name = null,
null $arguments = null,
null $class_name = null)
<p>Call a callback fetching organized arguments depending on its declaration</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
static
</div>
<div class="col-md-8 type">
<a href="#method_debug">debug</a>()
<p>Hard debug anything</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
static
</div>
<div class="col-md-8 type">
<a href="#method_exceptionHandler">exceptionHandler</a>(
<abbr title="MVCFundamental\Commons\Exception">Exception</abbr> $e,
bool $plain_text = false)
<p>Get a safe exception info</p> </div>
<div class="col-md-2"></div>
</div>
</div>
<h2>Details</h2>
<div id="method-details">
<div class="method-item">
<h3 id="method_getDefaultEnvParameters">
<div class="location">at line 39</div>
<code> static
array
<strong>getDefaultEnvParameters</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Get the default environment vars to load in views and calling controller's actions</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
array</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_classImplements">
<div class="location">at line 56</div>
<code> static
bool
<strong>classImplements</strong>($class_name, $interface_name)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Test if a class implements an interface</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td></td>
<td>$class_name</td>
<td>
</td>
</tr>
<tr>
<td></td>
<td>$interface_name</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
bool</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getPropertyName">
<div class="location">at line 71</div>
<code> static
string
<strong>getPropertyName</strong>(
string $name = '',
string $replace = '_',
bool $capitalize_first_char = true)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Get a safe class property name in camel case</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$name</td>
<td>
</td>
</tr>
<tr>
<td>
string</td>
<td>$replace</td>
<td>
</td>
</tr>
<tr>
<td>
bool</td>
<td>$capitalize_first_char</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getMethodName">
<div class="location">at line 81</div>
<code> static
string
<strong>getMethodName</strong>($property_name)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Get a safe class method name in camel case</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td></td>
<td>$property_name</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_fetchArguments">
<div class="location">at line 93</div>
<code> static
mixed
<strong>fetchArguments</strong>(
null $method_name = null,
null $arguments = null,
null $class_name = null)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Call a callback fetching organized arguments depending on its declaration</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
null</td>
<td>$method_name</td>
<td>
</td>
</tr>
<tr>
<td>
null</td>
<td>$arguments</td>
<td>
</td>
</tr>
<tr>
<td>
null</td>
<td>$class_name</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
mixed</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_debug">
<div class="location">at line 105</div>
<code> static
<strong>debug</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Hard debug anything</p> </div>
<div class="tags">
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_exceptionHandler">
<div class="location">at line 120</div>
<code> static
<strong>exceptionHandler</strong>(
<abbr title="MVCFundamental\Commons\Exception">Exception</abbr> $e,
bool $plain_text = false)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Get a safe exception info</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="MVCFundamental\Commons\Exception">Exception</abbr></td>
<td>$e</td>
<td>
</td>
</tr>
<tr>
<td>
bool</td>
<td>$plain_text</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
</div>
</div>
<div id="footer">
Generated by <a href="http://sami.sensiolabs.org/">Sami, the API Documentation Generator</a>.
</div>
</div>
</div>
</body>
</html>