<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Adds a simulated three-dimensional border</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="imagick.forwardfouriertransformimage.html">Imagick::forwardFourierTransformImage</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.functionimage.html">Imagick::functionImage</a></div>
<div class="up"><a href="class.imagick.html">Imagick</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="imagick.frameimage" class="refentry">
<div class="refnamediv">
<h1 class="refname">Imagick::frameImage</h1>
<p class="verinfo">(PECL imagick 2.0.0)</p><p class="refpurpose"><span class="refname">Imagick::frameImage</span> — <span class="dc-title">Adds a simulated three-dimensional border</span></p>
</div>
<div class="refsect1 description" id="refsect1-imagick.frameimage-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>Imagick::frameImage</strong></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$matte_color</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$width</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$height</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$inner_bevel</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$outer_bevel</code></span>
)</div>
<p class="para rdfs-comment">
Adds a simulated three-dimensional border around the image.
The width and height specify the border width of the vertical
and horizontal sides of the frame. The inner and outer
bevels indicate the width of the inner and outer shadows of
the frame.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-imagick.frameimage-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">matte_color</code></dt>
<dd>
<p class="para">
ImagickPixel object or a string representing the matte color
</p>
</dd>
<dt>
<code class="parameter">width</code></dt>
<dd>
<p class="para">
The width of the border
</p>
</dd>
<dt>
<code class="parameter">height</code></dt>
<dd>
<p class="para">
The height of the border
</p>
</dd>
<dt>
<code class="parameter">inner_bevel</code></dt>
<dd>
<p class="para">
The inner bevel width
</p>
</dd>
<dt>
<code class="parameter">outer_bevel</code></dt>
<dd>
<p class="para">
The outer bevel width
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-imagick.frameimage-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success.
</p>
</div>
<div class="refsect1 errors" id="refsect1-imagick.frameimage-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Throws ImagickException on error.
</p>
</div>
<div class="refsect1 changelog" id="refsect1-imagick.frameimage-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>2.1.0</td>
<td>
Now allows a string representing the color as the first parameter.
Previous versions allow only an ImagickPixel object.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-imagick.frameimage-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3917">
<p><strong>Example #1 <span class="function"><strong>Imagick::frameImage()</strong></span></strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #007700">function </span><span style="color: #0000BB">frameImage</span><span style="color: #007700">(</span><span style="color: #0000BB">$imagePath</span><span style="color: #007700">, </span><span style="color: #0000BB">$color</span><span style="color: #007700">, </span><span style="color: #0000BB">$width</span><span style="color: #007700">, </span><span style="color: #0000BB">$height</span><span style="color: #007700">, </span><span style="color: #0000BB">$innerBevel</span><span style="color: #007700">, </span><span style="color: #0000BB">$outerBevel</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$imagick </span><span style="color: #007700">= new \</span><span style="color: #0000BB">Imagick</span><span style="color: #007700">(</span><span style="color: #0000BB">realpath</span><span style="color: #007700">(</span><span style="color: #0000BB">$imagePath</span><span style="color: #007700">));<br /><br /> </span><span style="color: #0000BB">$width </span><span style="color: #007700">= </span><span style="color: #0000BB">$width </span><span style="color: #007700">+ </span><span style="color: #0000BB">$innerBevel </span><span style="color: #007700">+ </span><span style="color: #0000BB">$outerBevel</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$height </span><span style="color: #007700">= </span><span style="color: #0000BB">$height </span><span style="color: #007700">+ </span><span style="color: #0000BB">$innerBevel </span><span style="color: #007700">+ </span><span style="color: #0000BB">$outerBevel</span><span style="color: #007700">;<br /><br /> </span><span style="color: #0000BB">$imagick</span><span style="color: #007700">-></span><span style="color: #0000BB">frameimage</span><span style="color: #007700">(<br /> </span><span style="color: #0000BB">$color</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">$width</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">$height</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">$innerBevel</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">$outerBevel<br /> </span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">header</span><span style="color: #007700">(</span><span style="color: #DD0000">"Content-Type: image/jpg"</span><span style="color: #007700">);<br /> echo </span><span style="color: #0000BB">$imagick</span><span style="color: #007700">-></span><span style="color: #0000BB">getImageBlob</span><span style="color: #007700">();<br />}<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="imagick.forwardfouriertransformimage.html">Imagick::forwardFourierTransformImage</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.functionimage.html">Imagick::functionImage</a></div>
<div class="up"><a href="class.imagick.html">Imagick</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
