<!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>Set image artifact</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="imagick.setimagealphachannel.html">Imagick::setImageAlphaChannel</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.setimageattribute.html">Imagick::setImageAttribute</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.setimageartifact" class="refentry">
<div class="refnamediv">
<h1 class="refname">Imagick::setImageArtifact</h1>
<p class="verinfo">(No version information available, might only be in Git)</p><p class="refpurpose"><span class="refname">Imagick::setImageArtifact</span> — <span class="dc-title">Set image artifact</span></p>
</div>
<div class="refsect1 description" id="refsect1-imagick.setimageartifact-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>Imagick::setImageArtifact</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$artifact</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code></span>
)</div>
<p class="para rdfs-comment">
Associates an artifact with the image. The difference between image properties and
image artifacts is that properties are public and artifacts are private.
This method is available if Imagick has been compiled against ImageMagick version 6.5.7 or newer.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-imagick.setimageartifact-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">artifact</code></dt>
<dd>
<p class="para">
The name of the artifact
</p>
</dd>
<dt>
<code class="parameter">value</code></dt>
<dd>
<p class="para">
The value of the artifact
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-imagick.setimageartifact-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.setimageartifact-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Throws ImagickException on error.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-imagick.setimageartifact-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="imagick.getimageartifact.html" class="function" rel="rdfs-seeAlso">Imagick::getImageArtifact()</a> - Get image artifact</span></li>
<li class="member"><span class="function"><a href="imagick.deleteimageartifact.html" class="function" rel="rdfs-seeAlso">Imagick::deleteImageArtifact()</a> - Delete image artifact</span></li>
</ul>
</p>
</div>
<div class="refsect1 examples" id="refsect1-imagick.setimageartifact-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4006">
<p><strong>Example #1 <span class="function"><strong>Imagick::setImageArtifact()</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">setImageArtifact</span><span style="color: #007700">() {<br /><br /> </span><span style="color: #0000BB">$src1 </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: #DD0000">"./images/artifact/source1.png"</span><span style="color: #007700">));<br /> </span><span style="color: #0000BB">$src2 </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: #DD0000">"./images/artifact/source2.png"</span><span style="color: #007700">));<br /><br /> </span><span style="color: #0000BB">$src2</span><span style="color: #007700">-></span><span style="color: #0000BB">setImageVirtualPixelMethod</span><span style="color: #007700">(\</span><span style="color: #0000BB">Imagick</span><span style="color: #007700">::</span><span style="color: #0000BB">VIRTUALPIXELMETHOD_TRANSPARENT</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$src2</span><span style="color: #007700">-></span><span style="color: #0000BB">setImageArtifact</span><span style="color: #007700">(</span><span style="color: #DD0000">'compose:args'</span><span style="color: #007700">, </span><span style="color: #DD0000">"1,0,-0.5,0.5"</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$src1</span><span style="color: #007700">-></span><span style="color: #0000BB">compositeImage</span><span style="color: #007700">(</span><span style="color: #0000BB">$src2</span><span style="color: #007700">, </span><span style="color: #0000BB">Imagick</span><span style="color: #007700">::</span><span style="color: #0000BB">COMPOSITE_MATHEMATICS</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">);<br /> <br /> </span><span style="color: #0000BB">$src1</span><span style="color: #007700">-></span><span style="color: #0000BB">setImageFormat</span><span style="color: #007700">(</span><span style="color: #DD0000">'png'</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/png"</span><span style="color: #007700">);<br /> echo </span><span style="color: #0000BB">$src1</span><span style="color: #007700">-></span><span style="color: #0000BB">getImagesBlob</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.setimagealphachannel.html">Imagick::setImageAlphaChannel</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.setimageattribute.html">Imagick::setImageAttribute</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>
