mirror of
https://github.com/mosbth/cimage.git
synced 2025-08-01 14:00:08 +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-1983965054"></a>
|
||||
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-603682456"></a>
|
||||
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
|
||||
</div>
|
||||
<div id="namespace-1983965054" class="accordion-body collapse in">
|
||||
<div id="namespace-603682456" 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>
|
||||
@@ -186,6 +187,7 @@
|
||||
<section class="row-fluid public">
|
||||
<section class="span4">
|
||||
<a href="../classes/CHttpGet.html#method___construct" class="">__construct()</a><br />
|
||||
<a href="../classes/CHttpGet.html#method_buildUrl" class="">buildUrl()</a><br />
|
||||
<a href="../classes/CHttpGet.html#method_setUrl" class="">setUrl()</a><br />
|
||||
<a href="../classes/CHttpGet.html#method_setHeader" class="">setHeader()</a><br />
|
||||
<a href="../classes/CHttpGet.html#method_parseHeader" class="">parseHeader()</a><br />
|
||||
@@ -331,6 +333,49 @@
|
||||
|
||||
|
||||
|
||||
</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_buildUrl" name="method_buildUrl" class="anchor"></a>
|
||||
<article class="method">
|
||||
<h3 class="public ">buildUrl()</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;">buildUrl(string <span class="argument">$baseUrl</span>, string <span class="argument">$merge</span>) : string</pre>
|
||||
<p><em>Build an encoded url.</em></p>
|
||||
|
||||
|
||||
<h4>Parameters</h4>
|
||||
<table class="table table-condensed table-hover">
|
||||
<tr>
|
||||
<td>string</td>
|
||||
<td>$baseUrl </td>
|
||||
<td><p>This is the original url which will be merged.</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>string</td>
|
||||
<td>$merge </td>
|
||||
<td><p>Thse parts should be merged into the baseUrl,
|
||||
the format is as parse_url.</p></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
<h4>Returns</h4>
|
||||
string
|
||||
— <p>$url as the modified url.</p>
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<aside class="span4 detailsbar">
|
||||
@@ -468,6 +513,11 @@
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h4>Throws</h4>
|
||||
<dl>
|
||||
<dt>\Exception</dt>
|
||||
<dd><p>when curl fails to retrieve url.</p></dd>
|
||||
</dl>
|
||||
|
||||
<h4>Returns</h4>
|
||||
boolean
|
||||
@@ -587,16 +637,16 @@
|
||||
<tr>
|
||||
<td>mixed</td>
|
||||
<td>$default </td>
|
||||
<td><p>as default value (int seconds) if date is</p>
|
||||
<pre><code> missing in response header.</code></pre></td>
|
||||
<td><p>as default value (int seconds) if date is
|
||||
missing in response header.</p></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
<h4>Returns</h4>
|
||||
integer
|
||||
— <p>as timestamp or $default if Date is missing in</p>
|
||||
<pre><code> response header.</code></pre>
|
||||
— <p>as timestamp or $default if Date is missing in
|
||||
response header.</p>
|
||||
|
||||
</article>
|
||||
</div>
|
||||
@@ -626,8 +676,8 @@
|
||||
<tr>
|
||||
<td>mixed</td>
|
||||
<td>$default </td>
|
||||
<td><p>as default value if date is missing in response</p>
|
||||
<pre><code> header.</code></pre></td>
|
||||
<td><p>as default value if date is missing in response
|
||||
header.</p></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
@@ -727,7 +777,7 @@
|
||||
<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