<!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-->
<script type="text/javascript">
function loadExternalCodeSnippets() {
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach(function (pre) {
var src = pre.getAttribute('data-src');
var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
var language = 'php';
var code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState == 4) {
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
}
else if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
}
else {
code.textContent = '✖ Error: File does not exist or is empty';
}
}
};
xhr.send(null);
});
}
$(document).ready(function(){
loadExternalCodeSnippets();
});
$('#source-view').on('shown', function () {
loadExternalCodeSnippets();
})
</script>
<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">40</span>
</a>
</li>
<li>
<a href="../reports/markers.html">
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">2</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-972863959"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-972863959" class="accordion-body collapse in">
<div class="accordion-inner">
<ul>
<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>
</ul>
</div>
</div>
</div>
</div>
</div>
</section>
<section class="row-fluid">
<div class="span10 offset2">
<div class="row-fluid">
<div class="span8 content class">
<nav>
<a href="../namespaces/default.html">\</a> <i class="icon-level-up"></i>
</nav>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal"><i class="icon-code"></i></a>
<h1><small>\</small>CImage</h1>
<p><em>Resize and crop images on the fly, store generated images in a cache.</em></p>
<h3>Examples</h3>
<h4></h4>
<pre class="pre-scrollable">** File not found : http://dbwebb.se/opensource/cimage **</pre>
<section id="summary">
<h2>Summary</h2>
<section class="row-fluid heading">
<section class="span4">
<a href="#methods">Methods</a>
</section>
<section class="span4">
<a href="#properties">Properties</a>
</section>
<section class="span4">
<a href="#constants">Constants</a>
</section>
</section>
<section class="row-fluid public">
<section class="span4">
<a href="../classes/CImage.html#method___construct" class="">__construct()</a><br />
<a href="../classes/CImage.html#method_setVerbose" class="">setVerbose()</a><br />
<a href="../classes/CImage.html#method_setSaveFolder" class="">setSaveFolder()</a><br />
<a href="../classes/CImage.html#method_useCache" class="">useCache()</a><br />
<a href="../classes/CImage.html#method_createDummyImage" class="">createDummyImage()</a><br />
<a href="../classes/CImage.html#method_setRemoteDownload" class="">setRemoteDownload()</a><br />
<a href="../classes/CImage.html#method_isRemoteSource" class="">isRemoteSource()</a><br />
<a href="../classes/CImage.html#method_setRemoteHostWhitelist" class="">setRemoteHostWhitelist()</a><br />
<a href="../classes/CImage.html#method_isRemoteSourceOnWhitelist" class="">isRemoteSourceOnWhitelist()</a><br />
<a href="../classes/CImage.html#method_downloadRemoteSource" class="">downloadRemoteSource()</a><br />
<a href="../classes/CImage.html#method_setSource" class="">setSource()</a><br />
<a href="../classes/CImage.html#method_setTarget" class="">setTarget()</a><br />
<a href="../classes/CImage.html#method_getTarget" class="">getTarget()</a><br />
<a href="../classes/CImage.html#method_setOptions" class="">setOptions()</a><br />
<a href="../classes/CImage.html#method_loadImageDetails" class="">loadImageDetails()</a><br />
<a href="../classes/CImage.html#method_initDimensions" class="">initDimensions()</a><br />
<a href="../classes/CImage.html#method_calculateNewWidthAndHeight" class="">calculateNewWidthAndHeight()</a><br />
<a href="../classes/CImage.html#method_reCalculateDimensions" class="">reCalculateDimensions()</a><br />
<a href="../classes/CImage.html#method_setSaveAsExtension" class="">setSaveAsExtension()</a><br />
<a href="../classes/CImage.html#method_setJpegQuality" class="">setJpegQuality()</a><br />
<a href="../classes/CImage.html#method_setPngCompression" class="">setPngCompression()</a><br />
<a href="../classes/CImage.html#method_useOriginalIfPossible" class="">useOriginalIfPossible()</a><br />
<a href="../classes/CImage.html#method_generateFilename" class="">generateFilename()</a><br />
<a href="../classes/CImage.html#method_useCacheIfPossible" class="">useCacheIfPossible()</a><br />
<a href="../classes/CImage.html#method_load" class="">load()</a><br />
<a href="../classes/CImage.html#method_getPngType" class="">getPngType()</a><br />
<a href="../classes/CImage.html#method_preResize" class="">preResize()</a><br />
<a href="../classes/CImage.html#method_setCopyResizeStrategy" class="">setCopyResizeStrategy()</a><br />
<a href="../classes/CImage.html#method_imageCopyResampled" class="">imageCopyResampled()</a><br />
<a href="../classes/CImage.html#method_resize" class="">resize()</a><br />
<a href="../classes/CImage.html#method_postResize" class="">postResize()</a><br />
<a href="../classes/CImage.html#method_rotate" class="">rotate()</a><br />
<a href="../classes/CImage.html#method_rotateExif" class="">rotateExif()</a><br />
<a href="../classes/CImage.html#method_trueColorToPalette" class="">trueColorToPalette()</a><br />
<a href="../classes/CImage.html#method_sharpenImage" class="">sharpenImage()</a><br />
<a href="../classes/CImage.html#method_embossImage" class="">embossImage()</a><br />
<a href="../classes/CImage.html#method_blurImage" class="">blurImage()</a><br />
<a href="../classes/CImage.html#method_createConvolveArguments" class="">createConvolveArguments()</a><br />
<a href="../classes/CImage.html#method_addConvolveExpressions" class="">addConvolveExpressions()</a><br />
<a href="../classes/CImage.html#method_imageConvolution" class="">imageConvolution()</a><br />
<a href="../classes/CImage.html#method_setDefaultBackgroundColor" class="">setDefaultBackgroundColor()</a><br />
<a href="../classes/CImage.html#method_setPostProcessingOptions" class="">setPostProcessingOptions()</a><br />
<a href="../classes/CImage.html#method_save" class="">save()</a><br />
<a href="../classes/CImage.html#method_linkToCacheFile" class="">linkToCacheFile()</a><br />
<a href="../classes/CImage.html#method_addHTTPHeader" class="">addHTTPHeader()</a><br />
<a href="../classes/CImage.html#method_output" class="">output()</a><br />
<a href="../classes/CImage.html#method_json" class="">json()</a><br />
<a href="../classes/CImage.html#method_setAsciiOptions" class="">setAsciiOptions()</a><br />
<a href="../classes/CImage.html#method_ascii" class="">ascii()</a><br />
<a href="../classes/CImage.html#method_log" class="">log()</a><br />
<a href="../classes/CImage.html#method_setVerboseToFile" class="">setVerboseToFile()</a><br />
</section>
<section class="span4">
<a href="../classes/CImage.html#property_crop" class="">$crop</a><br />
<a href="../classes/CImage.html#property_cropOrig" class="">$cropOrig</a><br />
<a href="../classes/CImage.html#property_keepRatio" class="">$keepRatio</a><br />
<a href="../classes/CImage.html#property_cropToFit" class="">$cropToFit</a><br />
<a href="../classes/CImage.html#property_crop_x" class="">$crop_x</a><br />
<a href="../classes/CImage.html#property_crop_y" class="">$crop_y</a><br />
<a href="../classes/CImage.html#property_filters" class="">$filters</a><br />
</section>
<section class="span4">
<a href="../classes/CImage.html#constant_PNG_GREYSCALE" class="">PNG_GREYSCALE</a><br />
<a href="../classes/CImage.html#constant_PNG_RGB" class="">PNG_RGB</a><br />
<a href="../classes/CImage.html#constant_PNG_RGB_PALETTE" class="">PNG_RGB_PALETTE</a><br />
<a href="../classes/CImage.html#constant_PNG_GREYSCALE_ALPHA" class="">PNG_GREYSCALE_ALPHA</a><br />
<a href="../classes/CImage.html#constant_PNG_RGB_ALPHA" class="">PNG_RGB_ALPHA</a><br />
<a href="../classes/CImage.html#constant_JPEG_QUALITY_DEFAULT" class="">JPEG_QUALITY_DEFAULT</a><br />
<a href="../classes/CImage.html#constant_PNG_COMPRESSION_DEFAULT" class="">PNG_COMPRESSION_DEFAULT</a><br />
<a href="../classes/CImage.html#constant_UPSCALE_DEFAULT" class="">UPSCALE_DEFAULT</a><br />
<a href="../classes/CImage.html#constant_RESIZE" class="">RESIZE</a><br />
<a href="../classes/CImage.html#constant_RESAMPLE" class="">RESAMPLE</a><br />
</section>
</section>
<section class="row-fluid protected">
<section class="span4">
<a href="../classes/CImage.html#method_getTargetImageExtension" class="">getTargetImageExtension()</a><br />
</section>
<section class="span4">
<em>No protected properties found</em>
</section>
<section class="span4">
<em>N/A</em>
</section>
</section>
<section class="row-fluid private">
<section class="span4">
<a href="../classes/CImage.html#method_checkFileExtension" class="">checkFileExtension()</a><br />
<a href="../classes/CImage.html#method_normalizeFileExtension" class="">normalizeFileExtension()</a><br />
<a href="../classes/CImage.html#method_mapFilter" class="">mapFilter()</a><br />
<a href="../classes/CImage.html#method_getPngTypeAsString" class="">getPngTypeAsString()</a><br />
<a href="../classes/CImage.html#method_colorsTotal" class="">colorsTotal()</a><br />
<a href="../classes/CImage.html#method_getBackgroundColor" class="">getBackgroundColor()</a><br />
<a href="../classes/CImage.html#method_createImageKeepTransparency" class="">createImageKeepTransparency()</a><br />
<a href="../classes/CImage.html#method_verboseOutput" class="">verboseOutput()</a><br />
<a href="../classes/CImage.html#method_raiseError" class="">raiseError()</a><br />
</section>
<section class="span4">
<a href="../classes/CImage.html#property_quality" class="">$quality</a><br />
<a href="../classes/CImage.html#property_useQuality" class="">$useQuality</a><br />
<a href="../classes/CImage.html#property_compress" class="">$compress</a><br />
<a href="../classes/CImage.html#property_useCompress" class="">$useCompress</a><br />
<a href="../classes/CImage.html#property_HTTPHeader" class="">$HTTPHeader</a><br />
<a href="../classes/CImage.html#property_bgColorDefault" class="">$bgColorDefault</a><br />
<a href="../classes/CImage.html#property_bgColor" class="">$bgColor</a><br />
<a href="../classes/CImage.html#property_saveFolder" class="">$saveFolder</a><br />
<a href="../classes/CImage.html#property_image" class="">$image</a><br />
<a href="../classes/CImage.html#property_imageSrc" class="">$imageSrc</a><br />
<a href="../classes/CImage.html#property_pathToImage" class="">$pathToImage</a><br />
<a href="../classes/CImage.html#property_fileType" class="">$fileType</a><br />
<a href="../classes/CImage.html#property_extension" class="">$extension</a><br />
<a href="../classes/CImage.html#property_outputFormat" class="">$outputFormat</a><br />
<a href="../classes/CImage.html#property_verbose" class="">$verbose</a><br />
<a href="../classes/CImage.html#property_log" class="">$log</a><br />
<a href="../classes/CImage.html#property_palette" class="">$palette</a><br />
<a href="../classes/CImage.html#property_cacheFileName" class="">$cacheFileName</a><br />
<a href="../classes/CImage.html#property_saveAs" class="">$saveAs</a><br />
<a href="../classes/CImage.html#property_pngFilter" class="">$pngFilter</a><br />
<a href="../classes/CImage.html#property_pngFilterCmd" class="">$pngFilterCmd</a><br />
<a href="../classes/CImage.html#property_pngDeflate" class="">$pngDeflate</a><br />
<a href="../classes/CImage.html#property_pngDeflateCmd" class="">$pngDeflateCmd</a><br />
<a href="../classes/CImage.html#property_jpegOptimize" class="">$jpegOptimize</a><br />
<a href="../classes/CImage.html#property_jpegOptimizeCmd" class="">$jpegOptimizeCmd</a><br />
<a href="../classes/CImage.html#property_width" class="">$width</a><br />
<a href="../classes/CImage.html#property_height" class="">$height</a><br />
<a href="../classes/CImage.html#property_newWidth" class="">$newWidth</a><br />
<a href="../classes/CImage.html#property_newWidthOrig" class="">$newWidthOrig</a><br />
<a href="../classes/CImage.html#property_newHeight" class="">$newHeight</a><br />
<a href="../classes/CImage.html#property_newHeightOrig" class="">$newHeightOrig</a><br />
<a href="../classes/CImage.html#property_dpr" class="">$dpr</a><br />
<a href="../classes/CImage.html#property_upscale" class="">$upscale</a><br />
<a href="../classes/CImage.html#property_convolve" class="">$convolve</a><br />
<a href="../classes/CImage.html#property_convolves" class="">$convolves</a><br />
<a href="../classes/CImage.html#property_fillToFit" class="">$fillToFit</a><br />
<a href="../classes/CImage.html#property_scale" class="">$scale</a><br />
<a href="../classes/CImage.html#property_rotateBefore" class="">$rotateBefore</a><br />
<a href="../classes/CImage.html#property_rotateAfter" class="">$rotateAfter</a><br />
<a href="../classes/CImage.html#property_autoRotate" class="">$autoRotate</a><br />
<a href="../classes/CImage.html#property_sharpen" class="">$sharpen</a><br />
<a href="../classes/CImage.html#property_emboss" class="">$emboss</a><br />
<a href="../classes/CImage.html#property_blur" class="">$blur</a><br />
<a href="../classes/CImage.html#property_offset" class="">$offset</a><br />
<a href="../classes/CImage.html#property_fillWidth" class="">$fillWidth</a><br />
<a href="../classes/CImage.html#property_fillHeight" class="">$fillHeight</a><br />
<a href="../classes/CImage.html#property_allowRemote" class="">$allowRemote</a><br />
<a href="../classes/CImage.html#property_remotePattern" class="">$remotePattern</a><br />
<a href="../classes/CImage.html#property_useCache" class="">$useCache</a><br />
<a href="../classes/CImage.html#property_remoteHostWhitelist" class="">$remoteHostWhitelist</a><br />
<a href="../classes/CImage.html#property_verboseFileName" class="">$verboseFileName</a><br />
<a href="../classes/CImage.html#property_asciiOptions" class="">$asciiOptions</a><br />
<a href="../classes/CImage.html#property_copyStrategy" class="">$copyStrategy</a><br />
<a href="../classes/CImage.html#property_cropWidth" class="">$cropWidth</a><br />
<a href="../classes/CImage.html#property_cropHeight" class="">$cropHeight</a><br />
<a href="../classes/CImage.html#property_attr" class="">$attr</a><br />
</section>
<section class="span4">
<em>N/A</em>
</section>
</section>
</section>
</div>
<aside class="span4 detailsbar">
<dl>
<dt>File</dt>
<dd><a href="../files/CImage.html"><div class="path-wrapper">CImage.php</div></a></dd>
<dt>Package</dt>
<dd><div class="namespace-wrapper">Default</div></dd>
<dt>Class hierarchy</dt>
<dd class="hierarchy">
<div class="namespace-wrapper">\CImage</div>
</dd>
<dt>See also</dt>
<dd><a href="https://github.com/mosbth/cimage"><div class="namespace-wrapper">https://github.com/mosbth/cimage</div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
author
</th>
<td>
<p>Mikael Roos mos@dbwebb.se</p>
</td>
</tr>
</table>
</aside>
</div>
<a id="constants" name="constants"></a>
<div class="row-fluid">
<div class="span8 content class">
<h2>Constants</h2>
</div>
<aside class="span4 detailsbar"></aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="constant_PNG_GREYSCALE" name="constant_PNG_GREYSCALE" class="anchor"></a>
<article id="constant_PNG_GREYSCALE" class="constant">
<h3 class="">PNG_GREYSCALE</h3>
<pre class="signature">PNG_GREYSCALE</pre>
<p><em>Constants type of PNG image</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="constant_PNG_RGB" name="constant_PNG_RGB" class="anchor"></a>
<article id="constant_PNG_RGB" class="constant">
<h3 class="">PNG_RGB</h3>
<pre class="signature">PNG_RGB</pre>
<p><em></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="constant_PNG_RGB_PALETTE" name="constant_PNG_RGB_PALETTE" class="anchor"></a>
<article id="constant_PNG_RGB_PALETTE" class="constant">
<h3 class="">PNG_RGB_PALETTE</h3>
<pre class="signature">PNG_RGB_PALETTE</pre>
<p><em></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="constant_PNG_GREYSCALE_ALPHA" name="constant_PNG_GREYSCALE_ALPHA" class="anchor"></a>
<article id="constant_PNG_GREYSCALE_ALPHA" class="constant">
<h3 class="">PNG_GREYSCALE_ALPHA</h3>
<pre class="signature">PNG_GREYSCALE_ALPHA</pre>
<p><em></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="constant_PNG_RGB_ALPHA" name="constant_PNG_RGB_ALPHA" class="anchor"></a>
<article id="constant_PNG_RGB_ALPHA" class="constant">
<h3 class="">PNG_RGB_ALPHA</h3>
<pre class="signature">PNG_RGB_ALPHA</pre>
<p><em></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="constant_JPEG_QUALITY_DEFAULT" name="constant_JPEG_QUALITY_DEFAULT" class="anchor"></a>
<article id="constant_JPEG_QUALITY_DEFAULT" class="constant">
<h3 class="">JPEG_QUALITY_DEFAULT</h3>
<pre class="signature">JPEG_QUALITY_DEFAULT</pre>
<p><em>Constant for default image quality when not set</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="constant_PNG_COMPRESSION_DEFAULT" name="constant_PNG_COMPRESSION_DEFAULT" class="anchor"></a>
<article id="constant_PNG_COMPRESSION_DEFAULT" class="constant">
<h3 class="">PNG_COMPRESSION_DEFAULT</h3>
<pre class="signature">PNG_COMPRESSION_DEFAULT</pre>
<p><em>Constant for default image quality when not set</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="constant_UPSCALE_DEFAULT" name="constant_UPSCALE_DEFAULT" class="anchor"></a>
<article id="constant_UPSCALE_DEFAULT" class="constant">
<h3 class="">UPSCALE_DEFAULT</h3>
<pre class="signature">UPSCALE_DEFAULT</pre>
<p><em>Always upscale images, even if they are smaller than target image.</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="constant_RESIZE" name="constant_RESIZE" class="anchor"></a>
<article id="constant_RESIZE" class="constant">
<h3 class="">RESIZE</h3>
<pre class="signature">RESIZE</pre>
<p><em></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="constant_RESAMPLE" name="constant_RESAMPLE" class="anchor"></a>
<article id="constant_RESAMPLE" class="constant">
<h3 class="">RESAMPLE</h3>
<pre class="signature">RESAMPLE</pre>
<p><em></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>
<a id="properties" name="properties"></a>
<div class="row-fluid">
<div class="span8 content class">
<h2>Properties</h2>
</div>
<aside class="span4 detailsbar"></aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_crop" name="property_crop" class="anchor"></a>
<article class="property">
<h3 class="public ">$crop</h3>
<pre class="signature">$crop : </pre>
<p><em>Array with details on how to crop, incoming as argument and calculated.</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_cropOrig" name="property_cropOrig" class="anchor"></a>
<article class="property">
<h3 class="public ">$cropOrig</h3>
<pre class="signature">$cropOrig : </pre>
<p><em></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_keepRatio" name="property_keepRatio" class="anchor"></a>
<article class="property">
<h3 class="public ">$keepRatio</h3>
<pre class="signature">$keepRatio : </pre>
<p><em>Properties, the class is mutable and the method setOptions()
decides (partly) what properties are created.</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>
<th>
todo
</th>
<td>
<p>Clean up these and check if and how they are used</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_cropToFit" name="property_cropToFit" class="anchor"></a>
<article class="property">
<h3 class="public ">$cropToFit</h3>
<pre class="signature">$cropToFit : </pre>
<p><em></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_crop_x" name="property_crop_x" class="anchor"></a>
<article class="property">
<h3 class="public ">$crop_x</h3>
<pre class="signature">$crop_x : </pre>
<p><em></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_crop_y" name="property_crop_y" class="anchor"></a>
<article class="property">
<h3 class="public ">$crop_y</h3>
<pre class="signature">$crop_y : </pre>
<p><em></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_filters" name="property_filters" class="anchor"></a>
<article class="property">
<h3 class="public ">$filters</h3>
<pre class="signature">$filters : </pre>
<p><em></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_quality" name="property_quality" class="anchor"></a>
<article class="property">
<h3 class="private ">$quality</h3>
<pre class="signature">$quality : </pre>
<p><em>Quality level for JPEG images.</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_useQuality" name="property_useQuality" class="anchor"></a>
<article class="property">
<h3 class="private ">$useQuality</h3>
<pre class="signature">$useQuality : </pre>
<p><em>Is the quality level set from external use (true) or is it default (false)?</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_compress" name="property_compress" class="anchor"></a>
<article class="property">
<h3 class="private ">$compress</h3>
<pre class="signature">$compress : </pre>
<p><em>Compression level for PNG images.</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_useCompress" name="property_useCompress" class="anchor"></a>
<article class="property">
<h3 class="private ">$useCompress</h3>
<pre class="signature">$useCompress : </pre>
<p><em>Is the compress level set from external use (true) or is it default (false)?</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_HTTPHeader" name="property_HTTPHeader" class="anchor"></a>
<article class="property">
<h3 class="private ">$HTTPHeader</h3>
<pre class="signature">$HTTPHeader : </pre>
<p><em>Add HTTP headers for outputing image.</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_bgColorDefault" name="property_bgColorDefault" class="anchor"></a>
<article class="property">
<h3 class="private ">$bgColorDefault</h3>
<pre class="signature">$bgColorDefault : </pre>
<p><em></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_bgColor" name="property_bgColor" class="anchor"></a>
<article class="property">
<h3 class="private ">$bgColor</h3>
<pre class="signature">$bgColor : </pre>
<p><em>Background color to use, specified as part of options.</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_saveFolder" name="property_saveFolder" class="anchor"></a>
<article class="property">
<h3 class="private ">$saveFolder</h3>
<pre class="signature">$saveFolder : </pre>
<p><em>Where to save the target file.</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_image" name="property_image" class="anchor"></a>
<article class="property">
<h3 class="private ">$image</h3>
<pre class="signature">$image : </pre>
<p><em>The working image object.</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_imageSrc" name="property_imageSrc" class="anchor"></a>
<article class="property">
<h3 class="private ">$imageSrc</h3>
<pre class="signature">$imageSrc : </pre>
<p><em>Image filename, may include subdirectory, relative from $imageFolder</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_pathToImage" name="property_pathToImage" class="anchor"></a>
<article class="property">
<h3 class="private ">$pathToImage</h3>
<pre class="signature">$pathToImage : </pre>
<p><em>Actual path to the image, $imageFolder . '/' . $imageSrc</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_fileType" name="property_fileType" class="anchor"></a>
<article class="property">
<h3 class="private ">$fileType</h3>
<pre class="signature">$fileType : </pre>
<p><em>File type for source image, as provided by getimagesize()</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_extension" name="property_extension" class="anchor"></a>
<article class="property">
<h3 class="private ">$extension</h3>
<pre class="signature">$extension : </pre>
<p><em>File extension to use when saving image.</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_outputFormat" name="property_outputFormat" class="anchor"></a>
<article class="property">
<h3 class="private ">$outputFormat</h3>
<pre class="signature">$outputFormat : </pre>
<p><em>Output format, supports null (image) or json.</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_verbose" name="property_verbose" class="anchor"></a>
<article class="property">
<h3 class="private ">$verbose</h3>
<pre class="signature">$verbose : </pre>
<p><em>Verbose mode to print out a trace and display the created image</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_log" name="property_log" class="anchor"></a>
<article class="property">
<h3 class="private ">$log</h3>
<pre class="signature">$log : </pre>
<p><em>Keep a log/trace on what happens</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_palette" name="property_palette" class="anchor"></a>
<article class="property">
<h3 class="private ">$palette</h3>
<pre class="signature">$palette : </pre>
<p><em>Handle image as palette image</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_cacheFileName" name="property_cacheFileName" class="anchor"></a>
<article class="property">
<h3 class="private ">$cacheFileName</h3>
<pre class="signature">$cacheFileName : </pre>
<p><em>Target filename, with path, to save resulting image in.</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_saveAs" name="property_saveAs" class="anchor"></a>
<article class="property">
<h3 class="private ">$saveAs</h3>
<pre class="signature">$saveAs : </pre>
<p><em>Set a format to save image as, or null to use original format.</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_pngFilter" name="property_pngFilter" class="anchor"></a>
<article class="property">
<h3 class="private ">$pngFilter</h3>
<pre class="signature">$pngFilter : </pre>
<p><em>Path to command for filter optimize, for example optipng or null.</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_pngFilterCmd" name="property_pngFilterCmd" class="anchor"></a>
<article class="property">
<h3 class="private ">$pngFilterCmd</h3>
<pre class="signature">$pngFilterCmd : </pre>
<p><em></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_pngDeflate" name="property_pngDeflate" class="anchor"></a>
<article class="property">
<h3 class="private ">$pngDeflate</h3>
<pre class="signature">$pngDeflate : </pre>
<p><em>Path to command for deflate optimize, for example pngout or null.</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_pngDeflateCmd" name="property_pngDeflateCmd" class="anchor"></a>
<article class="property">
<h3 class="private ">$pngDeflateCmd</h3>
<pre class="signature">$pngDeflateCmd : </pre>
<p><em></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_jpegOptimize" name="property_jpegOptimize" class="anchor"></a>
<article class="property">
<h3 class="private ">$jpegOptimize</h3>
<pre class="signature">$jpegOptimize : </pre>
<p><em>Path to command to optimize jpeg images, for example jpegtran or null.</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_jpegOptimizeCmd" name="property_jpegOptimizeCmd" class="anchor"></a>
<article class="property">
<h3 class="private ">$jpegOptimizeCmd</h3>
<pre class="signature">$jpegOptimizeCmd : </pre>
<p><em></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_width" name="property_width" class="anchor"></a>
<article class="property">
<h3 class="private ">$width</h3>
<pre class="signature">$width : </pre>
<p><em>Image dimensions, calculated from loaded image.</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_height" name="property_height" class="anchor"></a>
<article class="property">
<h3 class="private ">$height</h3>
<pre class="signature">$height : </pre>
<p><em></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_newWidth" name="property_newWidth" class="anchor"></a>
<article class="property">
<h3 class="private ">$newWidth</h3>
<pre class="signature">$newWidth : </pre>
<p><em>New image dimensions, incoming as argument or calculated.</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_newWidthOrig" name="property_newWidthOrig" class="anchor"></a>
<article class="property">
<h3 class="private ">$newWidthOrig</h3>
<pre class="signature">$newWidthOrig : </pre>
<p><em></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_newHeight" name="property_newHeight" class="anchor"></a>
<article class="property">
<h3 class="private ">$newHeight</h3>
<pre class="signature">$newHeight : </pre>
<p><em></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_newHeightOrig" name="property_newHeightOrig" class="anchor"></a>
<article class="property">
<h3 class="private ">$newHeightOrig</h3>
<pre class="signature">$newHeightOrig : </pre>
<p><em></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_dpr" name="property_dpr" class="anchor"></a>
<article class="property">
<h3 class="private ">$dpr</h3>
<pre class="signature">$dpr : </pre>
<p><em>Change target height & width when different dpr, dpr 2 means double image dimensions.</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_upscale" name="property_upscale" class="anchor"></a>
<article class="property">
<h3 class="private ">$upscale</h3>
<pre class="signature">$upscale : </pre>
<p><em></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_convolve" name="property_convolve" class="anchor"></a>
<article class="property">
<h3 class="private ">$convolve</h3>
<pre class="signature">$convolve : </pre>
<p><em>String with details on how to do image convolution. String
should map a key in the $convolvs array or be a string of
11 float values separated by comma. The first nine builds
up the matrix, then divisor and last offset.</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_convolves" name="property_convolves" class="anchor"></a>
<article class="property">
<h3 class="private ">$convolves</h3>
<pre class="signature">$convolves : </pre>
<p><em>Custom convolution expressions, matrix 3x3, divisor and offset.</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_fillToFit" name="property_fillToFit" class="anchor"></a>
<article class="property">
<h3 class="private ">$fillToFit</h3>
<pre class="signature">$fillToFit : </pre>
<p><em>Resize strategy to fill extra area with background color.</em></p>
<p>True or false.</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_scale" name="property_scale" class="anchor"></a>
<article class="property">
<h3 class="private ">$scale</h3>
<pre class="signature">$scale : </pre>
<p><em>To store value for option scale.</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_rotateBefore" name="property_rotateBefore" class="anchor"></a>
<article class="property">
<h3 class="private ">$rotateBefore</h3>
<pre class="signature">$rotateBefore : </pre>
<p><em>To store value for option.</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_rotateAfter" name="property_rotateAfter" class="anchor"></a>
<article class="property">
<h3 class="private ">$rotateAfter</h3>
<pre class="signature">$rotateAfter : </pre>
<p><em>To store value for option.</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_autoRotate" name="property_autoRotate" class="anchor"></a>
<article class="property">
<h3 class="private ">$autoRotate</h3>
<pre class="signature">$autoRotate : </pre>
<p><em>To store value for option.</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_sharpen" name="property_sharpen" class="anchor"></a>
<article class="property">
<h3 class="private ">$sharpen</h3>
<pre class="signature">$sharpen : </pre>
<p><em>To store value for option.</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_emboss" name="property_emboss" class="anchor"></a>
<article class="property">
<h3 class="private ">$emboss</h3>
<pre class="signature">$emboss : </pre>
<p><em>To store value for option.</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_blur" name="property_blur" class="anchor"></a>
<article class="property">
<h3 class="private ">$blur</h3>
<pre class="signature">$blur : </pre>
<p><em>To store value for option.</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_offset" name="property_offset" class="anchor"></a>
<article class="property">
<h3 class="private ">$offset</h3>
<pre class="signature">$offset : </pre>
<p><em>Used with option area to set which parts of the image to use.</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_fillWidth" name="property_fillWidth" class="anchor"></a>
<article class="property">
<h3 class="private ">$fillWidth</h3>
<pre class="signature">$fillWidth : </pre>
<p><em>Calculate target dimension for image when using fill-to-fit resize strategy.</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_fillHeight" name="property_fillHeight" class="anchor"></a>
<article class="property">
<h3 class="private ">$fillHeight</h3>
<pre class="signature">$fillHeight : </pre>
<p><em></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_allowRemote" name="property_allowRemote" class="anchor"></a>
<article class="property">
<h3 class="private ">$allowRemote</h3>
<pre class="signature">$allowRemote : </pre>
<p><em>Allow remote file download, default is to disallow remote file download.</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_remotePattern" name="property_remotePattern" class="anchor"></a>
<article class="property">
<h3 class="private ">$remotePattern</h3>
<pre class="signature">$remotePattern : </pre>
<p><em></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_useCache" name="property_useCache" class="anchor"></a>
<article class="property">
<h3 class="private ">$useCache</h3>
<pre class="signature">$useCache : </pre>
<p><em>Use the cache if true, set to false to ignore the cached file.</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_remoteHostWhitelist" name="property_remoteHostWhitelist" class="anchor"></a>
<article class="property">
<h3 class="private ">$remoteHostWhitelist</h3>
<pre class="signature">$remoteHostWhitelist : </pre>
<p><em></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_verboseFileName" name="property_verboseFileName" class="anchor"></a>
<article class="property">
<h3 class="private ">$verboseFileName</h3>
<pre class="signature">$verboseFileName : </pre>
<p><em></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_asciiOptions" name="property_asciiOptions" class="anchor"></a>
<article class="property">
<h3 class="private ">$asciiOptions</h3>
<pre class="signature">$asciiOptions : </pre>
<p><em></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_copyStrategy" name="property_copyStrategy" class="anchor"></a>
<article class="property">
<h3 class="private ">$copyStrategy</h3>
<pre class="signature">$copyStrategy : </pre>
<p><em></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_cropWidth" name="property_cropWidth" class="anchor"></a>
<article class="property">
<h3 class="private ">$cropWidth</h3>
<pre class="signature">$cropWidth : </pre>
<p><em></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_cropHeight" name="property_cropHeight" class="anchor"></a>
<article class="property">
<h3 class="private ">$cropHeight</h3>
<pre class="signature">$cropHeight : </pre>
<p><em></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_attr" name="property_attr" class="anchor"></a>
<article class="property">
<h3 class="private ">$attr</h3>
<pre class="signature">$attr : </pre>
<p><em></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>
<a id="methods" name="methods"></a>
<div class="row-fluid">
<div class="span8 content class"><h2>Methods</h2></div>
<aside class="span4 detailsbar"></aside>
</div>
<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(string <span class="argument">$imageSrc = null</span>, string <span class="argument">$imageFolder = null</span>, string <span class="argument">$saveFolder = null</span>, string <span class="argument">$saveName = null</span>) </pre>
<p><em>Constructor, can take arguments to init the object.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$imageSrc </td>
<td><p>filename which may contain subdirectory.</p></td>
</tr>
<tr>
<td>string</td>
<td>$imageFolder </td>
<td><p>path to root folder for images.</p></td>
</tr>
<tr>
<td>string</td>
<td>$saveFolder </td>
<td><p>path to folder where to save the new file or null to skip saving.</p></td>
</tr>
<tr>
<td>string</td>
<td>$saveName </td>
<td><p>name of target file when saveing.</p></td>
</tr>
</table>
</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_setVerbose" name="method_setVerbose" class="anchor"></a>
<article class="method">
<h3 class="public ">setVerbose()</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;">setVerbose(boolean <span class="argument">$mode = true</span>) : $this</pre>
<p><em>Set verbose mode.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>boolean</td>
<td>$mode </td>
<td><p>true or false to enable and disable verbose mode,
default is true.</p></td>
</tr>
</table>
<h4>Returns</h4>
$this
</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_setSaveFolder" name="method_setSaveFolder" class="anchor"></a>
<article class="method">
<h3 class="public ">setSaveFolder()</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;">setSaveFolder(string <span class="argument">$path</span>) : $this</pre>
<p><em>Set save folder, base folder for saving cache files.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$path </td>
<td><p>where to store cached files.</p></td>
</tr>
</table>
<h4>Returns</h4>
$this
</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>
<th>
todo
</th>
<td>
<p>clean up how $this->saveFolder is used in other methods.</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_useCache" name="method_useCache" class="anchor"></a>
<article class="method">
<h3 class="public ">useCache()</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;">useCache(boolean <span class="argument">$use = true</span>) : $this</pre>
<p><em>Use cache or not.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>boolean</td>
<td>$use </td>
<td><p>true or false to use cache.</p></td>
</tr>
</table>
<h4>Returns</h4>
$this
</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_createDummyImage" name="method_createDummyImage" class="anchor"></a>
<article class="method">
<h3 class="public ">createDummyImage()</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;">createDummyImage(integer <span class="argument">$width = null</span>, integer <span class="argument">$height = null</span>) : $this</pre>
<p><em>Create and save a dummy image. Use dimensions as stated in
$this->newWidth, or $width or default to 100 (same for height.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>integer</td>
<td>$width </td>
<td><p>use specified width for image dimension.</p></td>
</tr>
<tr>
<td>integer</td>
<td>$height </td>
<td><p>use specified width for image dimension.</p></td>
</tr>
</table>
<h4>Returns</h4>
$this
</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_setRemoteDownload" name="method_setRemoteDownload" class="anchor"></a>
<article class="method">
<h3 class="public ">setRemoteDownload()</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;">setRemoteDownload(boolean <span class="argument">$allow</span>, string <span class="argument">$pattern = null</span>) : $this</pre>
<p><em>Allow or disallow remote image download.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>boolean</td>
<td>$allow </td>
<td><p>true or false to enable and disable.</p></td>
</tr>
<tr>
<td>string</td>
<td>$pattern </td>
<td><p>to use to detect if its a remote file.</p></td>
</tr>
</table>
<h4>Returns</h4>
$this
</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_isRemoteSource" name="method_isRemoteSource" class="anchor"></a>
<article class="method">
<h3 class="public ">isRemoteSource()</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;">isRemoteSource(string <span class="argument">$src</span>) : boolean</pre>
<p><em>Check if the image resource is a remote file or not.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$src </td>
<td><p>check if src is remote.</p></td>
</tr>
</table>
<h4>Returns</h4>
boolean
— <p>true if $src is a remote file, else false.</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_setRemoteHostWhitelist" name="method_setRemoteHostWhitelist" class="anchor"></a>
<article class="method">
<h3 class="public ">setRemoteHostWhitelist()</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;">setRemoteHostWhitelist(array <span class="argument">$whitelist = null</span>) : $this</pre>
<p><em>Set whitelist for valid hostnames from where remote source can be
downloaded.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>array</td>
<td>$whitelist </td>
<td><p>with regexp hostnames to allow download from.</p></td>
</tr>
</table>
<h4>Returns</h4>
$this
</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_isRemoteSourceOnWhitelist" name="method_isRemoteSourceOnWhitelist" class="anchor"></a>
<article class="method">
<h3 class="public ">isRemoteSourceOnWhitelist()</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;">isRemoteSourceOnWhitelist(string <span class="argument">$src</span>) : boolean</pre>
<p><em>Check if the hostname for the remote image, is on a whitelist,
if the whitelist is defined.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$src </td>
<td><p>the remote source.</p></td>
</tr>
</table>
<h4>Returns</h4>
boolean
— <p>true if hostname on $src is in the whitelist, else false.</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_downloadRemoteSource" name="method_downloadRemoteSource" class="anchor"></a>
<article class="method">
<h3 class="public ">downloadRemoteSource()</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;">downloadRemoteSource(string <span class="argument">$src</span>) : string</pre>
<p><em>Download a remote image and return path to its local copy.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$src </td>
<td><p>remote path to image.</p></td>
</tr>
</table>
<h4>Returns</h4>
string
— <p>as path to downloaded remote source.</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_setSource" name="method_setSource" class="anchor"></a>
<article class="method">
<h3 class="public ">setSource()</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;">setSource(string <span class="argument">$src</span>, string <span class="argument">$dir = null</span>) : $this</pre>
<p><em>Set source file to use as image source.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$src </td>
<td><p>of image.</p></td>
</tr>
<tr>
<td>string</td>
<td>$dir </td>
<td><p>as optional base directory where images are.</p></td>
</tr>
</table>
<h4>Returns</h4>
$this
</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_setTarget" name="method_setTarget" class="anchor"></a>
<article class="method">
<h3 class="public ">setTarget()</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;">setTarget(string <span class="argument">$src = null</span>, string <span class="argument">$dir = null</span>) : $this</pre>
<p><em>Set target file.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$src </td>
<td><p>of target image.</p></td>
</tr>
<tr>
<td>string</td>
<td>$dir </td>
<td><p>as optional base directory where images are stored.
Uses $this->saveFolder if null.</p></td>
</tr>
</table>
<h4>Returns</h4>
$this
</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_getTarget" name="method_getTarget" class="anchor"></a>
<article class="method">
<h3 class="public ">getTarget()</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;">getTarget() : Boolean|String</pre>
<p><em>Get filename of target file.</em></p>
<h4>Returns</h4>
Boolean|String
— <p>as filename of target or false if not set.</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_setOptions" name="method_setOptions" class="anchor"></a>
<article class="method">
<h3 class="public ">setOptions()</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;">setOptions(array <span class="argument">$args</span>) : $this</pre>
<p><em>Set options to use when processing image.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>array</td>
<td>$args </td>
<td><p>used when processing image.</p></td>
</tr>
</table>
<h4>Returns</h4>
$this
</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_loadImageDetails" name="method_loadImageDetails" class="anchor"></a>
<article class="method">
<h3 class="public ">loadImageDetails()</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;">loadImageDetails(string <span class="argument">$file = null</span>) : $this</pre>
<p><em>Load image details from original image file.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$file </td>
<td><p>the file to load or null to use $this->pathToImage.</p></td>
</tr>
</table>
<h4>Throws</h4>
<dl>
<dt>\Exception</dt>
<dd></dd>
</dl>
<h4>Returns</h4>
$this
</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_initDimensions" name="method_initDimensions" class="anchor"></a>
<article class="method">
<h3 class="public ">initDimensions()</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;">initDimensions() : $this</pre>
<p><em>Init new width and height and do some sanity checks on constraints, before any
processing can be done.</em></p>
<h4>Throws</h4>
<dl>
<dt>\Exception</dt>
<dd></dd>
</dl>
<h4>Returns</h4>
$this
</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_calculateNewWidthAndHeight" name="method_calculateNewWidthAndHeight" class="anchor"></a>
<article class="method">
<h3 class="public ">calculateNewWidthAndHeight()</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;">calculateNewWidthAndHeight() : $this</pre>
<p><em>Calculate new width and height of image, based on settings.</em></p>
<h4>Returns</h4>
$this
</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_reCalculateDimensions" name="method_reCalculateDimensions" class="anchor"></a>
<article class="method">
<h3 class="public ">reCalculateDimensions()</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;">reCalculateDimensions() : $this</pre>
<p><em>Re-calculate image dimensions when original image dimension has changed.</em></p>
<h4>Returns</h4>
$this
</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_setSaveAsExtension" name="method_setSaveAsExtension" class="anchor"></a>
<article class="method">
<h3 class="public ">setSaveAsExtension()</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;">setSaveAsExtension( <span class="argument">$saveAs = null</span>) : $this</pre>
<p><em>Set extension for filename to save as.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td></td>
<td>$saveAs </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
$this
</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_setJpegQuality" name="method_setJpegQuality" class="anchor"></a>
<article class="method">
<h3 class="public ">setJpegQuality()</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;">setJpegQuality(integer <span class="argument">$quality = null</span>) : $this</pre>
<p><em>Set JPEG quality to use when saving image</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>integer</td>
<td>$quality </td>
<td><p>as the quality to set.</p></td>
</tr>
</table>
<h4>Returns</h4>
$this
</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_setPngCompression" name="method_setPngCompression" class="anchor"></a>
<article class="method">
<h3 class="public ">setPngCompression()</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;">setPngCompression(integer <span class="argument">$compress = null</span>) : $this</pre>
<p><em>Set PNG compressen algorithm to use when saving image</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>integer</td>
<td>$compress </td>
<td><p>as the algorithm to use.</p></td>
</tr>
</table>
<h4>Returns</h4>
$this
</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_useOriginalIfPossible" name="method_useOriginalIfPossible" class="anchor"></a>
<article class="method">
<h3 class="public ">useOriginalIfPossible()</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;">useOriginalIfPossible(boolean <span class="argument">$useOrig = true</span>) : $this</pre>
<p><em>Use original image if possible, check options which affects image processing.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>boolean</td>
<td>$useOrig </td>
<td><p>default is to use original if possible, else set to false.</p></td>
</tr>
</table>
<h4>Returns</h4>
$this
</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_generateFilename" name="method_generateFilename" class="anchor"></a>
<article class="method">
<h3 class="public ">generateFilename()</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;">generateFilename(string <span class="argument">$base = null</span>, boolean <span class="argument">$useSubdir = true</span>) : $this</pre>
<p><em>Generate filename to save file in cache.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$base </td>
<td><p>as optional basepath for storing file.</p></td>
</tr>
<tr>
<td>boolean</td>
<td>$useSubdir </td>
<td><p>use or skip the subdir part when creating the
filename.</p></td>
</tr>
</table>
<h4>Returns</h4>
$this
</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_useCacheIfPossible" name="method_useCacheIfPossible" class="anchor"></a>
<article class="method">
<h3 class="public ">useCacheIfPossible()</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;">useCacheIfPossible(boolean <span class="argument">$useCache = true</span>) : $this</pre>
<p><em>Use cached version of image, if possible.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>boolean</td>
<td>$useCache </td>
<td><p>is default true, set to false to avoid using cached object.</p></td>
</tr>
</table>
<h4>Returns</h4>
$this
</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_load" name="method_load" class="anchor"></a>
<article class="method">
<h3 class="public ">load()</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;">load(string <span class="argument">$src = null</span>, string <span class="argument">$dir = null</span>) : $this</pre>
<p><em>Load image from disk. Try to load image without verbose error message,
if fail, load again and display error messages.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$src </td>
<td><p>of image.</p></td>
</tr>
<tr>
<td>string</td>
<td>$dir </td>
<td><p>as base directory where images are.</p></td>
</tr>
</table>
<h4>Returns</h4>
$this
</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_getPngType" name="method_getPngType" class="anchor"></a>
<article class="method">
<h3 class="public ">getPngType()</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;">getPngType(string <span class="argument">$filename = null</span>) : integer</pre>
<p><em>Get the type of PNG image.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$filename </td>
<td><p>to use instead of default.</p></td>
</tr>
</table>
<h4>Returns</h4>
integer
— <p>as the type of the png-image</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_preResize" name="method_preResize" class="anchor"></a>
<article class="method">
<h3 class="public ">preResize()</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;">preResize() : $this</pre>
<p><em>Preprocess image before rezising it.</em></p>
<h4>Returns</h4>
$this
</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_setCopyResizeStrategy" name="method_setCopyResizeStrategy" class="anchor"></a>
<article class="method">
<h3 class="public ">setCopyResizeStrategy()</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;">setCopyResizeStrategy(integer <span class="argument">$strategy</span>) : $this</pre>
<p><em>Resize or resample the image while resizing.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>integer</td>
<td>$strategy </td>
<td><p>as CImage::RESIZE or CImage::RESAMPLE</p></td>
</tr>
</table>
<h4>Returns</h4>
$this
</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_imageCopyResampled" name="method_imageCopyResampled" class="anchor"></a>
<article class="method">
<h3 class="public ">imageCopyResampled()</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;">imageCopyResampled( <span class="argument">$dst_image</span>, <span class="argument">$src_image</span>, <span class="argument">$dst_x</span>, <span class="argument">$dst_y</span>, <span class="argument">$src_x</span>, <span class="argument">$src_y</span>, <span class="argument">$dst_w</span>, <span class="argument">$dst_h</span>, <span class="argument">$src_w</span>, <span class="argument">$src_h</span>) : void</pre>
<p><em>Resize and or crop the image.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td></td>
<td>$dst_image </td>
<td></td>
</tr>
<tr>
<td></td>
<td>$src_image </td>
<td></td>
</tr>
<tr>
<td></td>
<td>$dst_x </td>
<td></td>
</tr>
<tr>
<td></td>
<td>$dst_y </td>
<td></td>
</tr>
<tr>
<td></td>
<td>$src_x </td>
<td></td>
</tr>
<tr>
<td></td>
<td>$src_y </td>
<td></td>
</tr>
<tr>
<td></td>
<td>$dst_w </td>
<td></td>
</tr>
<tr>
<td></td>
<td>$dst_h </td>
<td></td>
</tr>
<tr>
<td></td>
<td>$src_w </td>
<td></td>
</tr>
<tr>
<td></td>
<td>$src_h </td>
<td></td>
</tr>
</table>
</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_resize" name="method_resize" class="anchor"></a>
<article class="method">
<h3 class="public ">resize()</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;">resize() : $this</pre>
<p><em>Resize and or crop the image.</em></p>
<h4>Returns</h4>
$this
</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_postResize" name="method_postResize" class="anchor"></a>
<article class="method">
<h3 class="public ">postResize()</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;">postResize() : $this</pre>
<p><em>Postprocess image after rezising image.</em></p>
<h4>Returns</h4>
$this
</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_rotate" name="method_rotate" class="anchor"></a>
<article class="method">
<h3 class="public ">rotate()</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;">rotate(float <span class="argument">$angle</span>, <span class="argument">$bgColor</span>) : $this</pre>
<p><em>Rotate image using angle.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>float</td>
<td>$angle </td>
<td><p>to rotate image.</p></td>
</tr>
<tr>
<td></td>
<td>$bgColor </td>
<td></td>
</tr>
</table>
<h4>Returns</h4>
$this
</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_rotateExif" name="method_rotateExif" class="anchor"></a>
<article class="method">
<h3 class="public ">rotateExif()</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;">rotateExif() : $this</pre>
<p><em>Rotate image using information in EXIF.</em></p>
<h4>Returns</h4>
$this
</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_trueColorToPalette" name="method_trueColorToPalette" class="anchor"></a>
<article class="method">
<h3 class="public ">trueColorToPalette()</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;">trueColorToPalette() : void</pre>
<p><em>Convert true color image to palette image, keeping alpha.</em></p>
<p><a href="http://stackoverflow.com/questions/5752514/how-to-convert-png-to-8-bit-png-using-php-gd-library">http://stackoverflow.com/questions/5752514/how-to-convert-png-to-8-bit-png-using-php-gd-library</a></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_sharpenImage" name="method_sharpenImage" class="anchor"></a>
<article class="method">
<h3 class="public ">sharpenImage()</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;">sharpenImage() : $this</pre>
<p><em>Sharpen image using image convolution.</em></p>
<h4>Returns</h4>
$this
</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_embossImage" name="method_embossImage" class="anchor"></a>
<article class="method">
<h3 class="public ">embossImage()</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;">embossImage() : $this</pre>
<p><em>Emboss image using image convolution.</em></p>
<h4>Returns</h4>
$this
</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_blurImage" name="method_blurImage" class="anchor"></a>
<article class="method">
<h3 class="public ">blurImage()</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;">blurImage() : $this</pre>
<p><em>Blur image using image convolution.</em></p>
<h4>Returns</h4>
$this
</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_createConvolveArguments" name="method_createConvolveArguments" class="anchor"></a>
<article class="method">
<h3 class="public ">createConvolveArguments()</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;">createConvolveArguments(string <span class="argument">$expression</span>) : array</pre>
<p><em>Create convolve expression and return arguments for image convolution.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$expression </td>
<td><p>constant string which evaluates to a list of
11 numbers separated by komma or such a list.</p></td>
</tr>
</table>
<h4>Returns</h4>
array
— <p>as $matrix (3x3), $divisor and $offset</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_addConvolveExpressions" name="method_addConvolveExpressions" class="anchor"></a>
<article class="method">
<h3 class="public ">addConvolveExpressions()</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;">addConvolveExpressions(array <span class="argument">$options</span>) : $this</pre>
<p><em>Add custom expressions (or overwrite existing) for image convolution.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>array</td>
<td>$options </td>
<td><p>Key value array with strings to be converted
to convolution expressions.</p></td>
</tr>
</table>
<h4>Returns</h4>
$this
</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_imageConvolution" name="method_imageConvolution" class="anchor"></a>
<article class="method">
<h3 class="public ">imageConvolution()</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;">imageConvolution(string <span class="argument">$options = null</span>) : $this</pre>
<p><em>Image convolution.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$options </td>
<td><p>A string with 11 float separated by comma.</p></td>
</tr>
</table>
<h4>Returns</h4>
$this
</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_setDefaultBackgroundColor" name="method_setDefaultBackgroundColor" class="anchor"></a>
<article class="method">
<h3 class="public ">setDefaultBackgroundColor()</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;">setDefaultBackgroundColor(string <span class="argument">$color</span>) : $this</pre>
<p><em>Set default background color between 000000-FFFFFF or if using
alpha 00000000-FFFFFF7F.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$color </td>
<td><p>as hex value.</p></td>
</tr>
</table>
<h4>Returns</h4>
$this
</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_setPostProcessingOptions" name="method_setPostProcessingOptions" class="anchor"></a>
<article class="method">
<h3 class="public ">setPostProcessingOptions()</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;">setPostProcessingOptions(array <span class="argument">$options</span>) : $this</pre>
<p><em>Set optimizing and post-processing options.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>array</td>
<td>$options </td>
<td><p>with config for postprocessing with external tools.</p></td>
</tr>
</table>
<h4>Returns</h4>
$this
</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_save" name="method_save" class="anchor"></a>
<article class="method">
<h3 class="public ">save()</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;">save(string <span class="argument">$src = null</span>, string <span class="argument">$base = null</span>, boolean <span class="argument">$overwrite = true</span>) : $this</pre>
<p><em>Save image.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$src </td>
<td><p>as target filename.</p></td>
</tr>
<tr>
<td>string</td>
<td>$base </td>
<td><p>as base directory where to store images.</p></td>
</tr>
<tr>
<td>boolean</td>
<td>$overwrite </td>
<td><p>or not, default to always overwrite file.</p></td>
</tr>
</table>
<h4>Returns</h4>
$this
— <p>or false if no folder is set.</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_linkToCacheFile" name="method_linkToCacheFile" class="anchor"></a>
<article class="method">
<h3 class="public ">linkToCacheFile()</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;">linkToCacheFile(string <span class="argument">$alias</span>) : $this</pre>
<p><em>Create a hard link, as an alias, to the cached file.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$alias </td>
<td><p>where to store the link,
filename without extension.</p></td>
</tr>
</table>
<h4>Returns</h4>
$this
</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_addHTTPHeader" name="method_addHTTPHeader" class="anchor"></a>
<article class="method">
<h3 class="public ">addHTTPHeader()</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;">addHTTPHeader(string <span class="argument">$type</span>, string <span class="argument">$value</span>) : void</pre>
<p><em>Add HTTP header for putputting together with image.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$type </td>
<td><p>the header type such as "Cache-Control"</p></td>
</tr>
<tr>
<td>string</td>
<td>$value </td>
<td><p>the value to use</p></td>
</tr>
</table>
</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_output" name="method_output" class="anchor"></a>
<article class="method">
<h3 class="public ">output()</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;">output(string <span class="argument">$file = null</span>, string <span class="argument">$format = null</span>) : void</pre>
<p><em>Output image to browser using caching.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$file </td>
<td><p>to read and output, default is to
use $this->cacheFileName</p></td>
</tr>
<tr>
<td>string</td>
<td>$format </td>
<td><p>set to json to output file as json
object with details</p></td>
</tr>
</table>
</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_json" name="method_json" class="anchor"></a>
<article class="method">
<h3 class="public ">json()</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;">json(string <span class="argument">$file = null</span>) : string</pre>
<p><em>Create a JSON object from the image details.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$file </td>
<td><p>the file to output.</p></td>
</tr>
</table>
<h4>Returns</h4>
string
— <p>json-encoded representation of the image.</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_setAsciiOptions" name="method_setAsciiOptions" class="anchor"></a>
<article class="method">
<h3 class="public ">setAsciiOptions()</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;">setAsciiOptions(array <span class="argument">$options = array()</span>) : \void.</pre>
<p><em>Set options for creating ascii version of image.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>array</td>
<td>$options </td>
<td><p>empty to use default or set options to change.</p></td>
</tr>
</table>
<h4>Returns</h4>
\void.
</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_ascii" name="method_ascii" class="anchor"></a>
<article class="method">
<h3 class="public ">ascii()</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;">ascii(string <span class="argument">$file = null</span>) : string</pre>
<p><em>Create an ASCII version from the image details.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$file </td>
<td><p>the file to output.</p></td>
</tr>
</table>
<h4>Returns</h4>
string
— <p>ASCII representation of the image.</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_log" name="method_log" class="anchor"></a>
<article class="method">
<h3 class="public ">log()</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;">log(string <span class="argument">$message</span>) : \this</pre>
<p><em>Log an event if verbose mode.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$message </td>
<td><p>to log.</p></td>
</tr>
</table>
<h4>Returns</h4>
\this
</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_setVerboseToFile" name="method_setVerboseToFile" class="anchor"></a>
<article class="method">
<h3 class="public ">setVerboseToFile()</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;">setVerboseToFile(string <span class="argument">$fileName</span>) : void</pre>
<p><em>Do verbose output to a file.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$fileName </td>
<td><p>where to write the verbose output.</p></td>
</tr>
</table>
</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_getTargetImageExtension" name="method_getTargetImageExtension" class="anchor"></a>
<article class="method">
<h3 class="protected ">getTargetImageExtension()</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;">getTargetImageExtension() : string</pre>
<p><em>Find out the type (file extension) for the image to be saved.</em></p>
<h4>Returns</h4>
string
— <p>as image extension.</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_checkFileExtension" name="method_checkFileExtension" class="anchor"></a>
<article class="method">
<h3 class="private ">checkFileExtension()</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;">checkFileExtension(string <span class="argument">$extension</span>) : $this</pre>
<p><em>Check if file extension is valid as a file extension.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$extension </td>
<td><p>of image file.</p></td>
</tr>
</table>
<h4>Returns</h4>
$this
</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_normalizeFileExtension" name="method_normalizeFileExtension" class="anchor"></a>
<article class="method">
<h3 class="private ">normalizeFileExtension()</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;">normalizeFileExtension(string <span class="argument">$extension = null</span>) : string</pre>
<p><em>Normalize the file extension.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$extension </td>
<td><p>of image file or skip to use internal.</p></td>
</tr>
</table>
<h4>Returns</h4>
string
— <p>$extension as a normalized file extension.</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_mapFilter" name="method_mapFilter" class="anchor"></a>
<article class="method">
<h3 class="private ">mapFilter()</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;">mapFilter(string <span class="argument">$name</span>) : array</pre>
<p><em>Map filter name to PHP filter and id.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$name </td>
<td><p>the name of the filter.</p></td>
</tr>
</table>
<h4>Throws</h4>
<dl>
<dt>\Exception</dt>
<dd></dd>
</dl>
<h4>Returns</h4>
array
— <p>with filter settings</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_getPngTypeAsString" name="method_getPngTypeAsString" class="anchor"></a>
<article class="method">
<h3 class="private ">getPngTypeAsString()</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;">getPngTypeAsString( <span class="argument">$pngType = null</span>, string <span class="argument">$filename = null</span>) : integer</pre>
<p><em>Get the type of PNG image as a verbose string.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td></td>
<td>$pngType </td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$filename </td>
<td><p>to use instead of default.</p></td>
</tr>
</table>
<h4>Returns</h4>
integer
— <p>as the type of the png-image</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_colorsTotal" name="method_colorsTotal" class="anchor"></a>
<article class="method">
<h3 class="private ">colorsTotal()</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;">colorsTotal(resource <span class="argument">$im</span>) : integer</pre>
<p><em>Calculate number of colors in an image.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>resource</td>
<td>$im </td>
<td><p>the image.</p></td>
</tr>
</table>
<h4>Returns</h4>
integer
</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_getBackgroundColor" name="method_getBackgroundColor" class="anchor"></a>
<article class="method">
<h3 class="private ">getBackgroundColor()</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;">getBackgroundColor(resource <span class="argument">$img = null</span>) : \color</pre>
<p><em>Get the background color.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>resource</td>
<td>$img </td>
<td><p>the image to work with or null if using $this->image.</p></td>
</tr>
</table>
<h4>Returns</h4>
\color
— <p>value or null if no background color is set.</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_createImageKeepTransparency" name="method_createImageKeepTransparency" class="anchor"></a>
<article class="method">
<h3 class="private ">createImageKeepTransparency()</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;">createImageKeepTransparency(integer <span class="argument">$width</span>, integer <span class="argument">$height</span>) : \image</pre>
<p><em>Create a image and keep transparency for png and gifs.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>integer</td>
<td>$width </td>
<td><p>of the new image.</p></td>
</tr>
<tr>
<td>integer</td>
<td>$height </td>
<td><p>of the new image.</p></td>
</tr>
</table>
<h4>Returns</h4>
\image
— <p>resource.</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_verboseOutput" name="method_verboseOutput" class="anchor"></a>
<article class="method">
<h3 class="private ">verboseOutput()</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;">verboseOutput() : void</pre>
<p><em>Do verbose output and print out the log and the actual images.</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_raiseError" name="method_raiseError" class="anchor"></a>
<article class="method">
<h3 class="private ">raiseError()</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;">raiseError(string <span class="argument">$message</span>) : void</pre>
<p><em>Raise error, enables to implement a selection of error methods.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$message </td>
<td><p>the error message to display.</p></td>
</tr>
</table>
<h4>Throws</h4>
<dl>
<dt>\Exception</dt>
<dd></dd>
</dl>
</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>
</section>
<div id="source-view" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="source-view-label" aria-hidden="true">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
<h3 id="source-view-label">CImage.php</h3>
</div>
<div class="modal-body">
<pre data-src="../files/CImage.php.txt" class="language-php line-numbers"></pre>
</div>
</div>
<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 December 2nd, 2015 at 11:04.
</section>
</section>
</section>
</footer>
</div>
</body>
</html>