mirror of
https://github.com/mosbth/cimage.git
synced 2025-01-17 19:18:15 +01:00
455 lines
23 KiB
HTML
455 lines
23 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>CImage API Documentaion</title>
|
||
|
|
<meta name="author" content=""/>
|
||
|
|
<meta name="description" content=""/>
|
||
|
|
|
||
|
|
<link href="css/bootstrap-combined.no-icons.min.css" rel="stylesheet">
|
||
|
|
<link href="css/font-awesome.min.css" rel="stylesheet">
|
||
|
|
<link href="css/prism.css" rel="stylesheet" media="all"/>
|
||
|
|
<link href="css/template.css" rel="stylesheet" media="all"/>
|
||
|
|
|
||
|
|
<!--[if lt IE 9]>
|
||
|
|
<script src="js/html5.js"></script>
|
||
|
|
<![endif]-->
|
||
|
|
<script src="js/jquery-1.11.0.min.js"></script>
|
||
|
|
<script src="js/ui/1.10.4/jquery-ui.min.js"></script>
|
||
|
|
<script src="js/bootstrap.min.js"></script>
|
||
|
|
<script src="js/jquery.smooth-scroll.js"></script>
|
||
|
|
<script src="js/prism.min.js"></script>
|
||
|
|
<!-- TODO: Add http://jscrollpane.kelvinluck.com/ to style the scrollbars for browsers not using webkit-->
|
||
|
|
|
||
|
|
<link rel="shortcut icon" href="images/favicon.ico"/>
|
||
|
|
<link rel="apple-touch-icon" href="images/apple-touch-icon.png"/>
|
||
|
|
<link rel="apple-touch-icon" sizes="72x72" href="images/apple-touch-icon-72x72.png"/>
|
||
|
|
<link rel="apple-touch-icon" sizes="114x114" href="images/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">
|
||
|
|
<i class="icon-ellipsis-vertical"></i>
|
||
|
|
</a>
|
||
|
|
<a class="brand" href="index.html">CImage API Documentaion</a>
|
||
|
|
|
||
|
|
<div class="nav-collapse">
|
||
|
|
<ul class="nav pull-right">
|
||
|
|
<li class="dropdown" id="charts-menu">
|
||
|
|
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
|
||
|
|
Charts <b class="caret"></b>
|
||
|
|
</a>
|
||
|
|
<ul class="dropdown-menu">
|
||
|
|
<li>
|
||
|
|
<a href="graphs/class.html">
|
||
|
|
<i class="icon-list-alt"></i> Class hierarchy diagram
|
||
|
|
</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="dropdown" id="reports-menu">
|
||
|
|
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
|
||
|
|
Reports <b class="caret"></b>
|
||
|
|
</a>
|
||
|
|
<ul class="dropdown-menu">
|
||
|
|
<li>
|
||
|
|
<a href="reports/errors.html">
|
||
|
|
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">27</span>
|
||
|
|
</a>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<a href="reports/markers.html">
|
||
|
|
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">165</span>
|
||
|
|
</a>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<a href="reports/deprecated.html">
|
||
|
|
<i class="icon-list-alt"></i> Deprecated <span class="label label-info pull-right">0</span>
|
||
|
|
</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-fluid">
|
||
|
|
<section class="row-fluid">
|
||
|
|
<div class="span2 sidebar">
|
||
|
|
<div class="accordion" style="margin-bottom: 0">
|
||
|
|
<div class="accordion-group">
|
||
|
|
<div class="accordion-heading">
|
||
|
|
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-261519606"></a>
|
||
|
|
<a href="namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
|
||
|
|
</div>
|
||
|
|
<div id="namespace-261519606" class="accordion-body collapse in">
|
||
|
|
<div class="accordion-inner">
|
||
|
|
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li class="class"><a href="classes/CHttpGet.html">CHttpGet</a></li>
|
||
|
|
<li class="class"><a href="classes/CImage.html">CImage</a></li>
|
||
|
|
<li class="class"><a href="classes/CRemoteImage.html">CRemoteImage</a></li>
|
||
|
|
<li class="class"><a href="classes/CWhitelist.html">CWhitelist</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
<section class="row-fluid">
|
||
|
|
<div class="span10 offset2">
|
||
|
|
<div class="row-fluid">
|
||
|
|
<div class="span8 content namespace">
|
||
|
|
<nav>
|
||
|
|
|
||
|
|
</nav>
|
||
|
|
<h1><small></small>\</h1>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h2>Classes</h2>
|
||
|
|
<table class="table table-hover">
|
||
|
|
<tr>
|
||
|
|
<td><a href="classes/CHttpGet.html">CHttpGet</a></td>
|
||
|
|
<td><em>Get a image from a remote server using HTTP GET and If-Modified-Since.</em></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td><a href="classes/CImage.html">CImage</a></td>
|
||
|
|
<td><em>Resize and crop images on the fly, store generated images in a cache.</em></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td><a href="classes/CRemoteImage.html">CRemoteImage</a></td>
|
||
|
|
<td><em>Get a image from a remote server using HTTP GET and If-Modified-Since.</em></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td><a href="classes/CWhitelist.html">CWhitelist</a></td>
|
||
|
|
<td><em>Act as whitelist (or blacklist).</em></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<aside class="span4 detailsbar">
|
||
|
|
<dl>
|
||
|
|
<dt>Namespace hierarchy</dt>
|
||
|
|
<dd class="hierarchy">
|
||
|
|
<div class="namespace-wrapper">\</div>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</aside>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="row-fluid">
|
||
|
|
<section class="span8 content namespace">
|
||
|
|
<h2>Functions</h2>
|
||
|
|
</section>
|
||
|
|
<aside class="span4 detailsbar"></aside>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="row-fluid">
|
||
|
|
<div class="span8 content class">
|
||
|
|
<a id="method_errorPage" name="method_errorPage" class="anchor"></a>
|
||
|
|
<article class="method">
|
||
|
|
<h3 class=" ">errorPage()</h3>
|
||
|
|
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
||
|
|
<pre class="signature" style="margin-right: 54px;">errorPage(string <span class="argument">$msg</span>) : void</pre>
|
||
|
|
<p><em>Default configuration options, can be overridden in own config-file.</em></p>
|
||
|
|
|
||
|
|
|
||
|
|
<h4>Parameters</h4>
|
||
|
|
<table class="table table-condensed table-hover">
|
||
|
|
<tr>
|
||
|
|
<td>string</td>
|
||
|
|
<td>$msg </td>
|
||
|
|
<td><p>to display.</p></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</article>
|
||
|
|
</div>
|
||
|
|
<aside class="span4 detailsbar">
|
||
|
|
<h1><i class="icon-arrow-down"></i></h1>
|
||
|
|
<dl>
|
||
|
|
<dt>File</dt>
|
||
|
|
<dd><a href=""><div class="path-wrapper"></div></a></dd>
|
||
|
|
</dl>
|
||
|
|
<h2>Tags</h2>
|
||
|
|
<table class="table table-condensed">
|
||
|
|
<tr>
|
||
|
|
<th>
|
||
|
|
package
|
||
|
|
</th>
|
||
|
|
<td>
|
||
|
|
<p>Default</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</aside>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="row-fluid">
|
||
|
|
<div class="span8 content class">
|
||
|
|
<a id="method_get" name="method_get" class="anchor"></a>
|
||
|
|
<article class="method">
|
||
|
|
<h3 class=" ">get()</h3>
|
||
|
|
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
||
|
|
<pre class="signature" style="margin-right: 54px;">get(mixed <span class="argument">$key</span>, mixed <span class="argument">$default = null</span>) : mixed</pre>
|
||
|
|
<p><em>Get input from query string or return default value if not set.</em></p>
|
||
|
|
|
||
|
|
|
||
|
|
<h4>Parameters</h4>
|
||
|
|
<table class="table table-condensed table-hover">
|
||
|
|
<tr>
|
||
|
|
<td>mixed</td>
|
||
|
|
<td>$key </td>
|
||
|
|
<td><p>as string or array of string values to look for in $_GET.</p></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>mixed</td>
|
||
|
|
<td>$default </td>
|
||
|
|
<td><p>value to return when $key is not set in $_GET.</p></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
<h4>Returns</h4>
|
||
|
|
mixed
|
||
|
|
— <p>value from $_GET or default value.</p>
|
||
|
|
|
||
|
|
</article>
|
||
|
|
</div>
|
||
|
|
<aside class="span4 detailsbar">
|
||
|
|
<h1><i class="icon-arrow-down"></i></h1>
|
||
|
|
<dl>
|
||
|
|
<dt>File</dt>
|
||
|
|
<dd><a href=""><div class="path-wrapper"></div></a></dd>
|
||
|
|
</dl>
|
||
|
|
<h2>Tags</h2>
|
||
|
|
<table class="table table-condensed">
|
||
|
|
<tr>
|
||
|
|
<th>
|
||
|
|
package
|
||
|
|
</th>
|
||
|
|
<td>
|
||
|
|
<p>Default</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</aside>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="row-fluid">
|
||
|
|
<div class="span8 content class">
|
||
|
|
<a id="method_getConfig" name="method_getConfig" class="anchor"></a>
|
||
|
|
<article class="method">
|
||
|
|
<h3 class=" ">getConfig()</h3>
|
||
|
|
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
||
|
|
<pre class="signature" style="margin-right: 54px;">getConfig(string <span class="argument">$key</span>, mixed <span class="argument">$default</span>) : mixed</pre>
|
||
|
|
<p><em>Get value from config array or default if key is not set in config array.</em></p>
|
||
|
|
|
||
|
|
|
||
|
|
<h4>Parameters</h4>
|
||
|
|
<table class="table table-condensed table-hover">
|
||
|
|
<tr>
|
||
|
|
<td>string</td>
|
||
|
|
<td>$key </td>
|
||
|
|
<td><p>the key in the config array.</p></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>mixed</td>
|
||
|
|
<td>$default </td>
|
||
|
|
<td><p>value to be default if $key is not set in config.</p></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
<h4>Returns</h4>
|
||
|
|
mixed
|
||
|
|
— <p>value as $config[$key] or $default.</p>
|
||
|
|
|
||
|
|
</article>
|
||
|
|
</div>
|
||
|
|
<aside class="span4 detailsbar">
|
||
|
|
<h1><i class="icon-arrow-down"></i></h1>
|
||
|
|
<dl>
|
||
|
|
<dt>File</dt>
|
||
|
|
<dd><a href=""><div class="path-wrapper"></div></a></dd>
|
||
|
|
</dl>
|
||
|
|
<h2>Tags</h2>
|
||
|
|
<table class="table table-condensed">
|
||
|
|
<tr>
|
||
|
|
<th>
|
||
|
|
package
|
||
|
|
</th>
|
||
|
|
<td>
|
||
|
|
<p>Default</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</aside>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="row-fluid">
|
||
|
|
<div class="span8 content class">
|
||
|
|
<a id="method_getDefined" name="method_getDefined" class="anchor"></a>
|
||
|
|
<article class="method">
|
||
|
|
<h3 class=" ">getDefined()</h3>
|
||
|
|
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
||
|
|
<pre class="signature" style="margin-right: 54px;">getDefined(mixed <span class="argument">$key</span>, mixed <span class="argument">$defined</span>, mixed <span class="argument">$undefined</span>) : mixed</pre>
|
||
|
|
<p><em>Get input from query string and set to $defined if defined or else $undefined.</em></p>
|
||
|
|
|
||
|
|
|
||
|
|
<h4>Parameters</h4>
|
||
|
|
<table class="table table-condensed table-hover">
|
||
|
|
<tr>
|
||
|
|
<td>mixed</td>
|
||
|
|
<td>$key </td>
|
||
|
|
<td><p>as string or array of string values to look for in $_GET.</p></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>mixed</td>
|
||
|
|
<td>$defined </td>
|
||
|
|
<td><p>value to return when $key is set in $_GET.</p></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>mixed</td>
|
||
|
|
<td>$undefined </td>
|
||
|
|
<td><p>value to return when $key is not set in $_GET.</p></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
<h4>Returns</h4>
|
||
|
|
mixed
|
||
|
|
— <p>value as $defined or $undefined.</p>
|
||
|
|
|
||
|
|
</article>
|
||
|
|
</div>
|
||
|
|
<aside class="span4 detailsbar">
|
||
|
|
<h1><i class="icon-arrow-down"></i></h1>
|
||
|
|
<dl>
|
||
|
|
<dt>File</dt>
|
||
|
|
<dd><a href=""><div class="path-wrapper"></div></a></dd>
|
||
|
|
</dl>
|
||
|
|
<h2>Tags</h2>
|
||
|
|
<table class="table table-condensed">
|
||
|
|
<tr>
|
||
|
|
<th>
|
||
|
|
package
|
||
|
|
</th>
|
||
|
|
<td>
|
||
|
|
<p>Default</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</aside>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="row-fluid">
|
||
|
|
<div class="span8 content class">
|
||
|
|
<a id="method_verbose" name="method_verbose" class="anchor"></a>
|
||
|
|
<article class="method">
|
||
|
|
<h3 class=" ">verbose()</h3>
|
||
|
|
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
||
|
|
<pre class="signature" style="margin-right: 54px;">verbose(string <span class="argument">$msg = null</span>) : void</pre>
|
||
|
|
<p><em>Log when verbose mode, when used without argument it returns the result.</em></p>
|
||
|
|
|
||
|
|
|
||
|
|
<h4>Parameters</h4>
|
||
|
|
<table class="table table-condensed table-hover">
|
||
|
|
<tr>
|
||
|
|
<td>string</td>
|
||
|
|
<td>$msg </td>
|
||
|
|
<td><p>to log.</p></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</article>
|
||
|
|
</div>
|
||
|
|
<aside class="span4 detailsbar">
|
||
|
|
<h1><i class="icon-arrow-down"></i></h1>
|
||
|
|
<dl>
|
||
|
|
<dt>File</dt>
|
||
|
|
<dd><a href=""><div class="path-wrapper"></div></a></dd>
|
||
|
|
</dl>
|
||
|
|
<h2>Tags</h2>
|
||
|
|
<table class="table table-condensed">
|
||
|
|
<tr>
|
||
|
|
<th>
|
||
|
|
package
|
||
|
|
</th>
|
||
|
|
<td>
|
||
|
|
<p>Default</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</aside>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<footer class="row-fluid">
|
||
|
|
<section class="span10 offset2">
|
||
|
|
<section class="row-fluid">
|
||
|
|
<section class="span10 offset1">
|
||
|
|
<section class="row-fluid footer-sections">
|
||
|
|
<section class="span4">
|
||
|
|
<h1><i class="icon-code"></i></h1>
|
||
|
|
<div>
|
||
|
|
<ul>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
<section class="span4">
|
||
|
|
<h1><i class="icon-bar-chart"></i></h1>
|
||
|
|
<div>
|
||
|
|
<ul>
|
||
|
|
<li><a href="graphs/class.html">Class Hierarchy Diagram</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
<section class="span4">
|
||
|
|
<h1><i class="icon-pushpin"></i></h1>
|
||
|
|
<div>
|
||
|
|
<ul>
|
||
|
|
<li><a href="reports/errors.html">Errors</a></li>
|
||
|
|
<li><a href="reports/markers.html">Markers</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
<section class="row-fluid">
|
||
|
|
<section class="span10 offset1">
|
||
|
|
<hr />
|
||
|
|
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
|
||
|
|
on March 4th, 2015 at 10:52.
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
</footer>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|