mirror of
https://github.com/mosbth/cimage.git
synced 2025-07-30 21:20:11 +02:00
update docs/api with phpdoc
This commit is contained in:
Mikael Roos
@@ -106,12 +106,12 @@
|
||||
<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>
|
||||
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">40</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="../reports/markers.html">
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">164</span>
|
||||
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">2</span>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
@@ -136,15 +136,16 @@
|
||||
<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-811883102"></a>
|
||||
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1171772037"></a>
|
||||
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
|
||||
</div>
|
||||
<div id="namespace-811883102" class="accordion-body collapse in">
|
||||
<div id="namespace-1171772037" 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/CAsciiArt.html">CAsciiArt</a></li>
|
||||
<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>
|
||||
@@ -185,13 +186,11 @@
|
||||
</section>
|
||||
<section class="row-fluid public">
|
||||
<section class="span4">
|
||||
<a href="../classes/CRemoteImage.html#method___construct" class="">__construct()</a><br />
|
||||
<a href="../classes/CRemoteImage.html#method_getStatus" class="">getStatus()</a><br />
|
||||
<a href="../classes/CRemoteImage.html#method_getDetails" class="">getDetails()</a><br />
|
||||
<a href="../classes/CRemoteImage.html#method_setCache" class="">setCache()</a><br />
|
||||
<a href="../classes/CRemoteImage.html#method_isCacheWritable" class="">isCacheWritable()</a><br />
|
||||
<a href="../classes/CRemoteImage.html#method_useCache" class="">useCache()</a><br />
|
||||
<a href="../classes/CRemoteImage.html#method_contentTypeToFileExtension" class="">contentTypeToFileExtension()</a><br />
|
||||
<a href="../classes/CRemoteImage.html#method_setHeaderFields" class="">setHeaderFields()</a><br />
|
||||
<a href="../classes/CRemoteImage.html#method_save" class="">save()</a><br />
|
||||
<a href="../classes/CRemoteImage.html#method_updateCacheDetails" class="">updateCacheDetails()</a><br />
|
||||
@@ -230,7 +229,6 @@
|
||||
<a href="../classes/CRemoteImage.html#property_url" class="">$url</a><br />
|
||||
<a href="../classes/CRemoteImage.html#property_fileName" class="">$fileName</a><br />
|
||||
<a href="../classes/CRemoteImage.html#property_fileJson" class="">$fileJson</a><br />
|
||||
<a href="../classes/CRemoteImage.html#property_fileImage" class="">$fileImage</a><br />
|
||||
<a href="../classes/CRemoteImage.html#property_cache" class="">$cache</a><br />
|
||||
</section>
|
||||
<section class="span4">
|
||||
@@ -423,7 +421,7 @@
|
||||
<article class="property">
|
||||
<h3 class="private ">$fileName</h3>
|
||||
<pre class="signature">$fileName : </pre>
|
||||
<p><em>Base name of cache file for downloaded item.</em></p>
|
||||
<p><em>Base name of cache file for downloaded item and name of image.</em></p>
|
||||
|
||||
|
||||
<h4>Type</h4>
|
||||
@@ -450,30 +448,6 @@
|
||||
<p><em>Filename for json-file with details of cached item.</em></p>
|
||||
|
||||
|
||||
<h4>Type</h4>
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||||
</table>
|
||||
</aside>
|
||||
</div>
|
||||
|
||||
<div class="row-fluid">
|
||||
<div class="span8 content class">
|
||||
<a id="property_fileImage" name="property_fileImage" class="anchor"></a>
|
||||
<article class="property">
|
||||
<h3 class="private ">$fileImage</h3>
|
||||
<pre class="signature">$fileImage : </pre>
|
||||
<p><em>Filename for image-file.</em></p>
|
||||
|
||||
|
||||
<h4>Type</h4>
|
||||
|
||||
</article>
|
||||
@@ -522,32 +496,6 @@
|
||||
|
||||
<div class="row-fluid">
|
||||
<div class="span8 content class">
|
||||
<a id="method___construct" name="method___construct" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">__construct()</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;">__construct() </pre>
|
||||
<p><em>Constructor</em></p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||||
</table>
|
||||
</aside>
|
||||
</div>
|
||||
|
||||
<div class="row-fluid">
|
||||
<div class="span8 content class">
|
||||
<a id="method_getStatus" name="method_getStatus" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">getStatus()</h3>
|
||||
@@ -712,43 +660,6 @@ a remote file.</em></p>
|
||||
|
||||
<div class="row-fluid">
|
||||
<div class="span8 content class">
|
||||
<a id="method_contentTypeToFileExtension" name="method_contentTypeToFileExtension" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">contentTypeToFileExtension()</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;">contentTypeToFileExtension(string <span class="argument">$type</span>) : string</pre>
|
||||
<p><em>Translate a content type to a file extension.</em></p>
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<table class="table table-condensed table-hover">
|
||||
<tr>
|
||||
<td>string</td>
|
||||
<td>$type </td>
|
||||
<td><p>a valid content type.</p></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
<h4>Returns</h4>
|
||||
string
|
||||
— <p>as file extension or false if no match.</p>
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<aside class="span4 detailsbar">
|
||||
<h1><i class="icon-arrow-down"></i></h1>
|
||||
<dl>
|
||||
</dl>
|
||||
<h2>Tags</h2>
|
||||
<table class="table table-condensed">
|
||||
<tr><td colspan="2"><em>None found</em></td></tr>
|
||||
</table>
|
||||
</aside>
|
||||
</div>
|
||||
|
||||
<div class="row-fluid">
|
||||
<div class="span8 content class">
|
||||
<a id="method_setHeaderFields" name="method_setHeaderFields" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">setHeaderFields()</h3>
|
||||
@@ -852,6 +763,11 @@ a remote file.</em></p>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h4>Throws</h4>
|
||||
<dl>
|
||||
<dt>\Exception</dt>
|
||||
<dd><p>when status code does not match 200 or 304.</p></dd>
|
||||
</dl>
|
||||
|
||||
<h4>Returns</h4>
|
||||
string
|
||||
@@ -976,7 +892,7 @@ a remote file.</em></p>
|
||||
<section class="span10 offset1">
|
||||
<hr />
|
||||
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
|
||||
on March 6th, 2015 at 12:38.
|
||||
on December 2nd, 2015 at 11:04.
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
Reference in New Issue
Block a user