<!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>Embeds binary IPTC data into a JPEG image</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imagexbm.html">imagexbm</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.iptcparse.html">iptcparse</a></div>
<div class="up"><a href="ref.image.html">GD and Image Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.iptcembed" class="refentry">
<div class="refnamediv">
<h1 class="refname">iptcembed</h1>
<p class="verinfo">(PHP 4, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">iptcembed</span> — <span class="dc-title">Embeds binary IPTC data into a JPEG image</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.iptcembed-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>iptcembed</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$iptcdata</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$jpeg_file_name</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$spool</code><span class="initializer"> = 0</span></span>
] )</div>
<p class="para rdfs-comment">
Embeds binary IPTC data into a JPEG image.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.iptcembed-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">iptcdata</code></dt>
<dd>
<p class="para">
The data to be written.
</p>
</dd>
<dt>
<code class="parameter">jpeg_file_name</code></dt>
<dd>
<p class="para">
Path to the JPEG image.
</p>
</dd>
<dt>
<code class="parameter">spool</code></dt>
<dd>
<p class="para">
Spool flag. If the spool flag is less than 2 then the JPEG will be
returned as a string. Otherwise the JPEG will be printed to STDOUT.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.iptcembed-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
If <code class="parameter">spool</code> is less than 2, the JPEG will be returned,
or <strong><code>FALSE</code></strong> on failure. Otherwise returns <strong><code>TRUE</code></strong> on success
or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.iptcembed-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-3863">
<p><strong>Example #1 Embedding IPTC data into a JPEG</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #FF8000">// iptc_make_tag() function by Thies C. Arntzen<br /></span><span style="color: #007700">function </span><span style="color: #0000BB">iptc_make_tag</span><span style="color: #007700">(</span><span style="color: #0000BB">$rec</span><span style="color: #007700">, </span><span style="color: #0000BB">$data</span><span style="color: #007700">, </span><span style="color: #0000BB">$value</span><span style="color: #007700">)<br />{<br /> </span><span style="color: #0000BB">$length </span><span style="color: #007700">= </span><span style="color: #0000BB">strlen</span><span style="color: #007700">(</span><span style="color: #0000BB">$value</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$retval </span><span style="color: #007700">= </span><span style="color: #0000BB">chr</span><span style="color: #007700">(</span><span style="color: #0000BB">0x1C</span><span style="color: #007700">) . </span><span style="color: #0000BB">chr</span><span style="color: #007700">(</span><span style="color: #0000BB">$rec</span><span style="color: #007700">) . </span><span style="color: #0000BB">chr</span><span style="color: #007700">(</span><span style="color: #0000BB">$data</span><span style="color: #007700">);<br /><br /> if(</span><span style="color: #0000BB">$length </span><span style="color: #007700">< </span><span style="color: #0000BB">0x8000</span><span style="color: #007700">)<br /> {<br /> </span><span style="color: #0000BB">$retval </span><span style="color: #007700">.= </span><span style="color: #0000BB">chr</span><span style="color: #007700">(</span><span style="color: #0000BB">$length </span><span style="color: #007700">>> </span><span style="color: #0000BB">8</span><span style="color: #007700">) . </span><span style="color: #0000BB">chr</span><span style="color: #007700">(</span><span style="color: #0000BB">$length </span><span style="color: #007700">& </span><span style="color: #0000BB">0xFF</span><span style="color: #007700">);<br /> }<br /> else<br /> {<br /> </span><span style="color: #0000BB">$retval </span><span style="color: #007700">.= </span><span style="color: #0000BB">chr</span><span style="color: #007700">(</span><span style="color: #0000BB">0x80</span><span style="color: #007700">) . <br /> </span><span style="color: #0000BB">chr</span><span style="color: #007700">(</span><span style="color: #0000BB">0x04</span><span style="color: #007700">) . <br /> </span><span style="color: #0000BB">chr</span><span style="color: #007700">((</span><span style="color: #0000BB">$length </span><span style="color: #007700">>> </span><span style="color: #0000BB">24</span><span style="color: #007700">) & </span><span style="color: #0000BB">0xFF</span><span style="color: #007700">) . <br /> </span><span style="color: #0000BB">chr</span><span style="color: #007700">((</span><span style="color: #0000BB">$length </span><span style="color: #007700">>> </span><span style="color: #0000BB">16</span><span style="color: #007700">) & </span><span style="color: #0000BB">0xFF</span><span style="color: #007700">) . <br /> </span><span style="color: #0000BB">chr</span><span style="color: #007700">((</span><span style="color: #0000BB">$length </span><span style="color: #007700">>> </span><span style="color: #0000BB">8</span><span style="color: #007700">) & </span><span style="color: #0000BB">0xFF</span><span style="color: #007700">) . <br /> </span><span style="color: #0000BB">chr</span><span style="color: #007700">(</span><span style="color: #0000BB">$length </span><span style="color: #007700">& </span><span style="color: #0000BB">0xFF</span><span style="color: #007700">);<br /> }<br /><br /> return </span><span style="color: #0000BB">$retval </span><span style="color: #007700">. </span><span style="color: #0000BB">$value</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #FF8000">// Path to jpeg file<br /></span><span style="color: #0000BB">$path </span><span style="color: #007700">= </span><span style="color: #DD0000">'./phplogo.jpg'</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// Set the IPTC tags<br /></span><span style="color: #0000BB">$iptc </span><span style="color: #007700">= array(<br /> </span><span style="color: #DD0000">'2#120' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'Test image'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'2#116' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'Copyright 2008-2009, The PHP Group'<br /></span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Convert the IPTC tags into binary code<br /></span><span style="color: #0000BB">$data </span><span style="color: #007700">= </span><span style="color: #DD0000">''</span><span style="color: #007700">;<br /><br />foreach(</span><span style="color: #0000BB">$iptc </span><span style="color: #007700">as </span><span style="color: #0000BB">$tag </span><span style="color: #007700">=> </span><span style="color: #0000BB">$string</span><span style="color: #007700">)<br />{<br /> </span><span style="color: #0000BB">$tag </span><span style="color: #007700">= </span><span style="color: #0000BB">substr</span><span style="color: #007700">(</span><span style="color: #0000BB">$tag</span><span style="color: #007700">, </span><span style="color: #0000BB">2</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$data </span><span style="color: #007700">.= </span><span style="color: #0000BB">iptc_make_tag</span><span style="color: #007700">(</span><span style="color: #0000BB">2</span><span style="color: #007700">, </span><span style="color: #0000BB">$tag</span><span style="color: #007700">, </span><span style="color: #0000BB">$string</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #FF8000">// Embed the IPTC data<br /></span><span style="color: #0000BB">$content </span><span style="color: #007700">= </span><span style="color: #0000BB">iptcembed</span><span style="color: #007700">(</span><span style="color: #0000BB">$data</span><span style="color: #007700">, </span><span style="color: #0000BB">$path</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Write the new image data out to the file.<br /></span><span style="color: #0000BB">$fp </span><span style="color: #007700">= </span><span style="color: #0000BB">fopen</span><span style="color: #007700">(</span><span style="color: #0000BB">$path</span><span style="color: #007700">, </span><span style="color: #DD0000">"wb"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">fwrite</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">, </span><span style="color: #0000BB">$content</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">fclose</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</div>
<div class="refsect1 notes" id="refsect1-function.iptcembed-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>: <p class="para">This function does not require the GD image library.</p></p></blockquote>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imagexbm.html">imagexbm</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.iptcparse.html">iptcparse</a></div>
<div class="up"><a href="ref.image.html">GD and Image Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
