docs/classes/Filestack_FilestackClient/collage.html
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html SYSTEM "about:legacy-compat">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<title>phpDox - Filestack\FilestackClient::collage</title>
<link rel="stylesheet" type="text/css" href="../../css/style.css" media="screen"/>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
</head>
<body>
<nav class="topnav">
<ul>
<li>
<div class="logo"><span>/**</span>phpDox</div>
</li>
<li class="separator">
<a href="../../index.html">Overview</a>
</li>
<li class="separator">
<a href="../../namespaces.html">Namespaces</a>
</li>
<li>
<a href="../../classes.html">Classes</a>
</li>
<li>
<a href="../../traits.html">Traits</a>
</li>
<li class="separator">
<a href="../../source/index.html">Source</a>
</li>
</ul>
</nav>
<div id="mainstage">
<div class="box">
<ul class="breadcrumb">
<li>
<a href="../../index.html">Overview</a>
</li>
<li class="separator">
<a href="../../classes.html">Classes</a>
</li>
<li class="separator">
<a href="../../classes.html#Filestack">Filestack</a>
</li>
<li class="separator">
<a title="Filestack\FilestackClient" href="../../classes/Filestack_FilestackClient.html">FilestackClient</a>
</li>
<li class="separator">collage</li>
</ul>
</div>
<nav class="box">
<ul>
<li>
<a href="#introduction">Introduction</a>
</li>
<li>
<a href="#synopsis">Synopsis</a>
</li>
<li>
<a href="#parameter">Parameter</a>
</li>
<li>
<a href="#return">Return</a>
</li>
<li>
<a href="#throws">Throws</a>
</li>
<li>
<a href="#tests">Tests</a>
</li>
<li>
<a href="../../source/FilestackClient.php.html#line184">Source</a>
</li>
</ul>
</nav>
<section>
<h1><small>Filestack\FilestackClient::</small>collage</h1>
<h4>Set this Filelink's transform_url to include the collage task</h4>
<p/>
<ul/>
<h2 id="signature">Signature</h2>
<div class="styled synopsis">
<code>public function collage(array
$sources,
int
$width,
int
$height,
[array
$store_options = ,
[string
$color = 'white',
[string
$fit = 'auto',
[integer
$margin = 10,
[boolean
$auto_rotate = false]]]]] )
</code>
</div>
<h2 id="parameterlist">Parameters</h2>
<dl class="styled">
<dt><code>$sources</code>
—
array</dt>
<dd>An array of Filestack file handles or external<br/>urls. These are the images that will comprise<br/>the other images in the collage. The order in<br/>which they appear in the array dictates how the<br/> images will be arranged.</dd>
<dt><code>$width</code>
—
int</dt>
<dd>width of result image (1 to 10000)</dd>
<dt><code>$height</code>
—
int</dt>
<dd>height of result image (1 to 10000)</dd>
<dt><code>$store_options</code>
—
array</dt>
<dd/>
<dt><code>$color</code>
—
string</dt>
<dd>Border color for the collage. This can be a<br/>word or hex value, e.g. ('red' or 'FF0000')</dd>
<dt><code>$fit</code>
—
string</dt>
<dd>auto or crop. Allows you to control how the<br/>images in the collage are manipulated so that<br/>the final collage image will match the height<br/>and width parameters you set more closely.<br/>Using crop will produce a result that is closest<br/> to the height and width parameters you set.</dd>
<dt><code>$margin</code>
—
integer</dt>
<dd>Sets the size of the border between and around<br/>the images. Range is 1 to 100.</dd>
<dt><code>$auto_rotate</code>
—
boolean</dt>
<dd>Setting this parameter to true automatically<br/>rotates all the images in the collage according<br/> to their exif orientation data.</dd>
</dl>
<h2 id="return">Returns</h2>
<dl class="styled">
<dt>Filestack/Filelink</dt>
<dd>or contents<br/>
</dd>
</dl>
<h2 id="throws">Errors/Exceptions</h2>
<dl class="styled">
<dt>
<code>
<a title="Filestack\FilestackException" href="../../classes/Filestack_FilestackException.html">FilestackException</a>
</code>
</dt>
<dd>if API call fails, e.g 404 file not found</dd>
</dl>
<h2 id="tests">Test Coverage</h2>
<div class="styled">
<h3>Information</h3>
<ul class="styled">
<li>Coverage: / Lines (%)</li>
<li>Tests: 0</li>
<li>Passed: 0 (0%)</li>
</ul>
</div>
</section>
</div>
<footer>
<span>Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2020 by Arne Blankerts and Contributors</span>
</footer>
</body>
</html>