<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>File Source for PelEntryByte.php</title>
<link rel="stylesheet" href="../media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<h1>Source for file PelEntryByte.php</h1>
<p>Documentation is available at <a href="../PEL/_PelEntryByte.php.html">PelEntryByte.php</a></p>
<div class="src-code">
<div class="src-code"><ol><li><div class="src-line"><a name="a1"></a><span class="src-php"><?php</span></div></li>
<li><div class="src-line"><a name="a2"></a> </div></li>
<li><div class="src-line"><a name="a3"></a><span class="src-comm">/* PEL: PHP Exif Library. A library with support for reading and</span></div></li>
<li><div class="src-line"><a name="a4"></a><span class="src-comm"> * writing all Exif headers in JPEG and TIFF images using PHP.</span></div></li>
<li><div class="src-line"><a name="a5"></a><span class="src-comm"> *</span></div></li>
<li><div class="src-line"><a name="a6"></a><span class="src-comm"> * Copyright (C) 2004, 2005, 2006 Martin Geisler.</span></div></li>
<li><div class="src-line"><a name="a7"></a><span class="src-comm"> *</span></div></li>
<li><div class="src-line"><a name="a8"></a><span class="src-comm"> * This program is free software; you can redistribute it and/or modify</span></div></li>
<li><div class="src-line"><a name="a9"></a><span class="src-comm"> * it under the terms of the GNU General Public License as published by</span></div></li>
<li><div class="src-line"><a name="a10"></a><span class="src-comm"> * the Free Software Foundation; either version 2 of the License, or</span></div></li>
<li><div class="src-line"><a name="a11"></a><span class="src-comm"> * (at your option) any later version.</span></div></li>
<li><div class="src-line"><a name="a12"></a><span class="src-comm"> *</span></div></li>
<li><div class="src-line"><a name="a13"></a><span class="src-comm"> * This program is distributed in the hope that it will be useful,</span></div></li>
<li><div class="src-line"><a name="a14"></a><span class="src-comm"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div></li>
<li><div class="src-line"><a name="a15"></a><span class="src-comm"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div></li>
<li><div class="src-line"><a name="a16"></a><span class="src-comm"> * GNU General Public License for more details.</span></div></li>
<li><div class="src-line"><a name="a17"></a><span class="src-comm"> *</span></div></li>
<li><div class="src-line"><a name="a18"></a><span class="src-comm"> * You should have received a copy of the GNU General Public License</span></div></li>
<li><div class="src-line"><a name="a19"></a><span class="src-comm"> * along with this program in the file COPYING; if not, write to the</span></div></li>
<li><div class="src-line"><a name="a20"></a><span class="src-comm"> * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,</span></div></li>
<li><div class="src-line"><a name="a21"></a><span class="src-comm"> * Boston, MA 02110-1301 USA</span></div></li>
<li><div class="src-line"><a name="a22"></a><span class="src-comm"> */</span></div></li>
<li><div class="src-line"><a name="a23"></a> </div></li>
<li><div class="src-line"><a name="a24"></a><span class="src-doc">/* $Id: PelEntryByte.php 419 2006-02-20 16:22:36Z mgeisler $ */</span></div></li>
<li><div class="src-line"><a name="a25"></a> </div></li>
<li><div class="src-line"><a name="a26"></a> </div></li>
<li><div class="src-line"><a name="a27"></a><span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a28"></a><span class="src-doc"> * Classes used to hold bytes, both signed and unsigned. The </span><span class="src-doc-inlinetag">{@link }</span></div></li>
<li><div class="src-line"><a name="a29"></a><span class="src-doc"> * PelEntryWindowsString} class is used to manipulate strings in the</span></div></li>
<li><div class="src-line"><a name="a30"></a><span class="src-doc"> * format Windows XP needs.</span></div></li>
<li><div class="src-line"><a name="a31"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a32"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@author</span><span class="src-doc"> Martin Geisler <hide@address.com></span></div></li>
<li><div class="src-line"><a name="a33"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@version</span><span class="src-doc"> $Revision: 419 $</span></div></li>
<li><div class="src-line"><a name="a34"></a><span class="src-doc"> * </span><span class="src-doc-tag">@date</span><span class="src-doc"> $Date: 2006-02-20 17:22:36 +0100 (Mon, 20 Feb 2006) $</span></div></li>
<li><div class="src-line"><a name="a35"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@license</span><span class="src-doc"> http://www.gnu.org/licenses/gpl.html GNU General Public</span></div></li>
<li><div class="src-line"><a name="a36"></a><span class="src-doc"> * License (GPL)</span></div></li>
<li><div class="src-line"><a name="a37"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@package</span><span class="src-doc"> PEL</span></div></li>
<li><div class="src-line"><a name="a38"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a39"></a> </div></li>
<li><div class="src-line"><a name="a40"></a><span class="src-doc">/**#@+ Required class definitions. */</span></div></li>
<li><div class="src-line"><a name="a41"></a><span class="src-inc">require_once</span><span class="src-sym">(</span><span class="src-str">'PelEntryNumber.php'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a42"></a><span class="src-doc-close-template">/**#@-*/</span></div></li>
<li><div class="src-line"><a name="a43"></a> </div></li>
<li><div class="src-line"><a name="a44"></a> </div></li>
<li><div class="src-line"><a name="a45"></a><span class="src-doc-template"> * Class for holding unsigned bytes.</span></div></li>
<li><div class="src-line"><a name="a46"></a><span class="src-doc-template"> *</span></div></li>
<li><div class="src-line"><a name="a47"></a><span class="src-doc-template"> * This class can hold bytes, either just a single byte or an array of</span></div></li>
<li><div class="src-line"><a name="a48"></a><span class="src-doc-template"> * bytes. The class will be used to manipulate any of the Exif tags</span></div></li>
<li><div class="src-line"><a name="a49"></a><span class="src-doc-template"> * which has format </span><span class="src-doc-inlinetag">{@link PelFormat::BYTE}</span><span class="src-doc-template">.</span></div></li>
<li><div class="src-line"><a name="a50"></a><span class="src-doc-template"> *</span></div></li>
<li><div class="src-line"><a name="a51"></a><span class="src-doc-template"> * </span><span class="src-doc-coretag">@author</span><span class="src-doc-template"> Martin Geisler <hide@address.com></span></div></li>
<li><div class="src-line"><a name="a52"></a><span class="src-doc-template"> * </span><span class="src-doc-coretag">@package</span><span class="src-doc-template"> PEL</span></div></li>
<li><div class="src-line"><a name="a54"></a><span class="src-doc-template"> */</span></div></li>
<li><div class="src-line"><a name="a55"></a><span class="src-key">class </span><a href="../PEL/PelEntryByte.html">PelEntryByte</a> <span class="src-key">extends </span><a href="../PEL/PelEntryNumber.html">PelEntryNumber</a> <span class="src-sym">{</span></div></li>
<li><div class="src-line"><a name="a56"></a> </div></li>
<li><div class="src-line"><a name="a57"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a58"></a><span class="src-doc"> * Make a new entry that can hold an unsigned byte.</span></div></li>
<li><div class="src-line"><a name="a59"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a60"></a><span class="src-doc"> * The method accept several integer arguments. The </span><span class="src-doc-inlinetag">{@link }</span></div></li>
<li><div class="src-line"><a name="a61"></a><span class="src-doc"> * getValue} method will always return an array except for when a</span></div></li>
<li><div class="src-line"><a name="a62"></a><span class="src-doc"> * single integer argument is given here.</span></div></li>
<li><div class="src-line"><a name="a63"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a64"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">PelTag </span><span class="src-doc">the tag which this entry represents. This</span></div></li>
<li><div class="src-line"><a name="a65"></a><span class="src-doc"> * should be one of the constants defined in </span><span class="src-doc-inlinetag">{@link PelTag}</span></div></li>
<li><div class="src-line"><a name="a66"></a><span class="src-doc"> * which has format </span><span class="src-doc-inlinetag">{@link PelFormat::BYTE}</span><span class="src-doc">.</span></div></li>
<li><div class="src-line"><a name="a67"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a68"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">int </span><span class="src-doc-var">$value... </span><span class="src-doc">the byte(s) that this entry will represent.</span></div></li>
<li><div class="src-line"><a name="a69"></a><span class="src-doc"> * The argument passed must obey the same rules as the argument to</span></div></li>
<li><div class="src-line"><a name="a70"></a><span class="src-doc"> * </span><span class="src-doc-inlinetag">{@link setValue}</span><span class="src-doc">, namely that it should be within range of an</span></div></li>
<li><div class="src-line"><a name="a71"></a><span class="src-doc"> * unsigned byte, that is between 0 and 255 (inclusive). If not,</span></div></li>
<li><div class="src-line"><a name="a72"></a><span class="src-doc"> * then a </span><span class="src-doc-inlinetag">{@link PelOverflowException}</span><span class="src-doc"> will be thrown.</span></div></li>
<li><div class="src-line"><a name="a73"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a74"></a> <span class="src-key">function </span><a href="../PEL/PelEntryByte.html#method__construct">__construct</a><span class="src-sym">(</span><span class="src-var">$tag </span><span class="src-comm">/* $value... */</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
<li><div class="src-line"><a name="a75"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../PEL/PelEntry.html#var$tag">tag</a> = <span class="src-var">$tag</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a76"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../PEL/PelEntryNumber.html#var$min">min</a> = <span class="src-num">0</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a77"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../PEL/PelEntryNumber.html#var$max">max</a> = <span class="src-num">255</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a78"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../PEL/PelEntry.html#var$format">format</a> = <span class="src-id"><a href="../PEL/PelFormat.html">PelFormat</a></span><span class="src-sym">::</span><span class="src-id">BYTE</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a79"></a> </div></li>
<li><div class="src-line"><a name="a80"></a> <span class="src-var">$value </span>= <a href="http://www.php.net/func_get_args">func_get_args</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a81"></a> <a href="http://www.php.net/array_shift">array_shift</a><span class="src-sym">(</span><span class="src-var">$value</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a82"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../PEL/PelEntryNumber.html#methodsetValueArray">setValueArray</a><span class="src-sym">(</span><span class="src-var">$value</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a83"></a> <span class="src-sym">}</span></div></li>
<li><div class="src-line"><a name="a84"></a> </div></li>
<li><div class="src-line"><a name="a85"></a> </div></li>
<li><div class="src-line"><a name="a86"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a87"></a><span class="src-doc"> * Convert a number into bytes.</span></div></li>
<li><div class="src-line"><a name="a88"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a89"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">int </span><span class="src-doc">the number that should be converted.</span></div></li>
<li><div class="src-line"><a name="a90"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a91"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">PelByteOrder </span><span class="src-doc">one of </span><span class="src-doc-inlinetag">{@link PelConvert::LITTLE_ENDIAN}</span><span class="src-doc"> and</span></div></li>
<li><div class="src-line"><a name="a92"></a><span class="src-doc"> * </span><span class="src-doc-inlinetag">{@link PelConvert::BIG_ENDIAN}</span><span class="src-doc">, specifying the target byte order.</span></div></li>
<li><div class="src-line"><a name="a93"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a94"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string </span><span class="src-doc">bytes representing the number given.</span></div></li>
<li><div class="src-line"><a name="a95"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a96"></a> <span class="src-key">function </span><a href="../PEL/PelEntryByte.html#methodnumberToBytes">numberToBytes</a><span class="src-sym">(</span><span class="src-var">$number</span><span class="src-sym">, </span><span class="src-var">$order</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
<li><div class="src-line"><a name="a97"></a> <span class="src-key">return </span><a href="http://www.php.net/chr">chr</a><span class="src-sym">(</span><span class="src-var">$number</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a98"></a> <span class="src-sym">}</span></div></li>
<li><div class="src-line"><a name="a99"></a> </div></li>
<li><div class="src-line"><a name="a100"></a><span class="src-sym">}</span></div></li>
<li><div class="src-line"><a name="a101"></a> </div></li>
<li><div class="src-line"><a name="a102"></a> </div></li>
<li><div class="src-line"><a name="a103"></a><span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a104"></a><span class="src-doc"> * Class for holding signed bytes.</span></div></li>
<li><div class="src-line"><a name="a105"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a106"></a><span class="src-doc"> * This class can hold bytes, either just a single byte or an array of</span></div></li>
<li><div class="src-line"><a name="a107"></a><span class="src-doc"> * bytes. The class will be used to manipulate any of the Exif tags</span></div></li>
<li><div class="src-line"><a name="a108"></a><span class="src-doc"> * which has format </span><span class="src-doc-inlinetag">{@link PelFormat::BYTE}</span><span class="src-doc">.</span></div></li>
<li><div class="src-line"><a name="a109"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a110"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@author</span><span class="src-doc"> Martin Geisler <hide@address.com></span></div></li>
<li><div class="src-line"><a name="a111"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@package</span><span class="src-doc"> PEL</span></div></li>
<li><div class="src-line"><a name="a112"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a113"></a><span class="src-key">class </span><a href="../PEL/PelEntrySByte.html">PelEntrySByte</a> <span class="src-key">extends </span><a href="../PEL/PelEntryNumber.html">PelEntryNumber</a> <span class="src-sym">{</span></div></li>
<li><div class="src-line"><a name="a114"></a> </div></li>
<li><div class="src-line"><a name="a115"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a116"></a><span class="src-doc"> * Make a new entry that can hold a signed byte.</span></div></li>
<li><div class="src-line"><a name="a117"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a118"></a><span class="src-doc"> * The method accept several integer arguments. The </span><span class="src-doc-inlinetag">{@link getValue}</span></div></li>
<li><div class="src-line"><a name="a119"></a><span class="src-doc"> * method will always return an array except for when a single</span></div></li>
<li><div class="src-line"><a name="a120"></a><span class="src-doc"> * integer argument is given here.</span></div></li>
<li><div class="src-line"><a name="a121"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a122"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">PelTag </span><span class="src-doc">the tag which this entry represents. This</span></div></li>
<li><div class="src-line"><a name="a123"></a><span class="src-doc"> * should be one of the constants defined in </span><span class="src-doc-inlinetag">{@link PelTag}</span></div></li>
<li><div class="src-line"><a name="a124"></a><span class="src-doc"> * which has format </span><span class="src-doc-inlinetag">{@link PelFormat::BYTE}</span><span class="src-doc">.</span></div></li>
<li><div class="src-line"><a name="a125"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a126"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">int </span><span class="src-doc-var">$value... </span><span class="src-doc">the byte(s) that this entry will represent.</span></div></li>
<li><div class="src-line"><a name="a127"></a><span class="src-doc"> * The argument passed must obey the same rules as the argument to</span></div></li>
<li><div class="src-line"><a name="a128"></a><span class="src-doc"> * </span><span class="src-doc-inlinetag">{@link setValue}</span><span class="src-doc">, namely that it should be within range of a</span></div></li>
<li><div class="src-line"><a name="a129"></a><span class="src-doc"> * signed byte, that is between -128 and 127 (inclusive). If not,</span></div></li>
<li><div class="src-line"><a name="a130"></a><span class="src-doc"> * then a </span><span class="src-doc-inlinetag">{@link PelOverflowException}</span><span class="src-doc"> will be thrown.</span></div></li>
<li><div class="src-line"><a name="a131"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a132"></a> <span class="src-key">function </span><a href="../PEL/PelEntrySByte.html#method__construct">__construct</a><span class="src-sym">(</span><span class="src-var">$tag </span><span class="src-comm">/* $value... */</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
<li><div class="src-line"><a name="a133"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../PEL/PelEntry.html#var$tag">tag</a> = <span class="src-var">$tag</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a134"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../PEL/PelEntryNumber.html#var$min">min</a> = -<span class="src-num">128</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a135"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../PEL/PelEntryNumber.html#var$max">max</a> = <span class="src-num">127</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a136"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../PEL/PelEntry.html#var$format">format</a> = <span class="src-id"><a href="../PEL/PelFormat.html">PelFormat</a></span><span class="src-sym">::</span><span class="src-id">SBYTE</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a137"></a> </div></li>
<li><div class="src-line"><a name="a138"></a> <span class="src-var">$value </span>= <a href="http://www.php.net/func_get_args">func_get_args</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a139"></a> <a href="http://www.php.net/array_shift">array_shift</a><span class="src-sym">(</span><span class="src-var">$value</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a140"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../PEL/PelEntryNumber.html#methodsetValueArray">setValueArray</a><span class="src-sym">(</span><span class="src-var">$value</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a141"></a> <span class="src-sym">}</span></div></li>
<li><div class="src-line"><a name="a142"></a> </div></li>
<li><div class="src-line"><a name="a143"></a> </div></li>
<li><div class="src-line"><a name="a144"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a145"></a><span class="src-doc"> * Convert a number into bytes.</span></div></li>
<li><div class="src-line"><a name="a146"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a147"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">int </span><span class="src-doc">the number that should be converted.</span></div></li>
<li><div class="src-line"><a name="a148"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a149"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">PelByteOrder </span><span class="src-doc">one of </span><span class="src-doc-inlinetag">{@link PelConvert::LITTLE_ENDIAN}</span><span class="src-doc"> and</span></div></li>
<li><div class="src-line"><a name="a150"></a><span class="src-doc"> * </span><span class="src-doc-inlinetag">{@link PelConvert::BIG_ENDIAN}</span><span class="src-doc">, specifying the target byte order.</span></div></li>
<li><div class="src-line"><a name="a151"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a152"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string </span><span class="src-doc">bytes representing the number given.</span></div></li>
<li><div class="src-line"><a name="a153"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a154"></a> <span class="src-key">function </span><a href="../PEL/PelEntrySByte.html#methodnumberToBytes">numberToBytes</a><span class="src-sym">(</span><span class="src-var">$number</span><span class="src-sym">, </span><span class="src-var">$order</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
<li><div class="src-line"><a name="a155"></a> <span class="src-key">return </span><a href="http://www.php.net/chr">chr</a><span class="src-sym">(</span><span class="src-var">$number</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a156"></a> <span class="src-sym">}</span></div></li>
<li><div class="src-line"><a name="a157"></a> </div></li>
<li><div class="src-line"><a name="a158"></a><span class="src-sym">}</span></div></li>
<li><div class="src-line"><a name="a159"></a> </div></li>
<li><div class="src-line"><a name="a160"></a> </div></li>
<li><div class="src-line"><a name="a161"></a><span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a162"></a><span class="src-doc"> * Class used to manipulate strings in the format Windows XP uses.</span></div></li>
<li><div class="src-line"><a name="a163"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a164"></a><span class="src-doc"> * When examining the file properties of an image in Windows XP one</span></div></li>
<li><div class="src-line"><a name="a165"></a><span class="src-doc"> * can fill in title, comment, author, keyword, and subject fields.</span></div></li>
<li><div class="src-line"><a name="a166"></a><span class="src-doc"> * Filling those fields and pressing OK will result in the data being</span></div></li>
<li><div class="src-line"><a name="a167"></a><span class="src-doc"> * written into the Exif data in the image.</span></div></li>
<li><div class="src-line"><a name="a168"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a169"></a><span class="src-doc"> * The data is written in a non-standard format and can thus not be</span></div></li>
<li><div class="src-line"><a name="a170"></a><span class="src-doc"> * loaded directly --- this class is needed to translate it into</span></div></li>
<li><div class="src-line"><a name="a171"></a><span class="src-doc"> * normal strings.</span></div></li>
<li><div class="src-line"><a name="a172"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a173"></a><span class="src-doc"> * It is important that entries from this class are only created with</span></div></li>
<li><div class="src-line"><a name="a174"></a><span class="src-doc"> * the </span><span class="src-doc-inlinetag">{@link PelTag::XP_TITLE}</span><span class="src-doc">, </span><span class="src-doc-inlinetag">{@link PelTag::XP_COMMENT}</span><span class="src-doc">, </span><span class="src-doc-inlinetag">{@link }</span></div></li>
<li><div class="src-line"><a name="a175"></a><span class="src-doc"> * PelTag::XP_AUTHOR}, </span><span class="src-doc-inlinetag">{@link PelTag::XP_KEYWORD}</span><span class="src-doc">, and </span><span class="src-doc-inlinetag">{@link }</span></div></li>
<li><div class="src-line"><a name="a176"></a><span class="src-doc"> * PelTag::XP_SUBJECT} tags. If another tag is used the data will no</span></div></li>
<li><div class="src-line"><a name="a177"></a><span class="src-doc"> * longer be correctly decoded when reloaded with PEL. (The data will</span></div></li>
<li><div class="src-line"><a name="a178"></a><span class="src-doc"> * be loaded as an </span><span class="src-doc-inlinetag">{@link PelEntryByte}</span><span class="src-doc"> entry, which isn't as useful.)</span></div></li>
<li><div class="src-line"><a name="a179"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a180"></a><span class="src-doc"> * This class is to be used as in</span></div></li>
<li><div class="src-line"><a name="a181"></a><span class="src-doc"> * <code></span></div></li>
<li><div class="src-line"><a name="a182"></a><span class="src-doc"> * $entry = $ifd->getEntry(PelTag::XP_TITLE);</span></div></li>
<li><div class="src-line"><a name="a183"></a><span class="src-doc"> * print($entry->getValue());</span></div></li>
<li><div class="src-line"><a name="a184"></a><span class="src-doc"> * $entry->setValue('My favorite cat');</span></div></li>
<li><div class="src-line"><a name="a185"></a><span class="src-doc"> * </code></span></div></li>
<li><div class="src-line"><a name="a186"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a187"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@author</span><span class="src-doc"> Martin Geisler <hide@address.com></span></div></li>
<li><div class="src-line"><a name="a188"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@package</span><span class="src-doc"> PEL</span></div></li>
<li><div class="src-line"><a name="a189"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a190"></a><span class="src-key">class </span><a href="../PEL/PelEntryWindowsString.html">PelEntryWindowsString</a> <span class="src-key">extends </span><a href="../PEL/PelEntry.html">PelEntry</a> <span class="src-sym">{</span></div></li>
<li><div class="src-line"><a name="a191"></a> </div></li>
<li><div class="src-line"><a name="a192"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a193"></a><span class="src-doc"> * The string hold by this entry.</span></div></li>
<li><div class="src-line"><a name="a194"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a195"></a><span class="src-doc"> * This is the string that was given to the </span><span class="src-doc-inlinetag">{@link __construct}</span></div></li>
<li><div class="src-line"><a name="a196"></a><span class="src-doc"> * constructor} or later to </span><span class="src-doc-inlinetag">{@link setValue}</span><span class="src-doc">, without any extra NULL</span></div></li>
<li><div class="src-line"><a name="a197"></a><span class="src-doc"> * characters or any such nonsense.</span></div></li>
<li><div class="src-line"><a name="a198"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a199"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@var </span><span class="src-doc-type">string </span></div></li>
<li><div class="src-line"><a name="a200"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a201"></a> <span class="src-key">private </span><span class="src-var">$str</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a202"></a> </div></li>
<li><div class="src-line"><a name="a203"></a> </div></li>
<li><div class="src-line"><a name="a204"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a205"></a><span class="src-doc"> * Make a new PelEntry that can hold a Windows XP specific string.</span></div></li>
<li><div class="src-line"><a name="a206"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a207"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">int </span><span class="src-doc">the tag which this entry represents. This should be</span></div></li>
<li><div class="src-line"><a name="a208"></a><span class="src-doc"> * one of </span><span class="src-doc-inlinetag">{@link PelTag::XP_TITLE}</span><span class="src-doc">, </span><span class="src-doc-inlinetag">{@link PelTag::XP_COMMENT}</span><span class="src-doc">,</span></div></li>
<li><div class="src-line"><a name="a209"></a><span class="src-doc"> * </span><span class="src-doc-inlinetag">{@link PelTag::XP_AUTHOR}</span><span class="src-doc">, </span><span class="src-doc-inlinetag">{@link PelTag::XP_KEYWORD}</span><span class="src-doc">, and </span><span class="src-doc-inlinetag">{@link }</span></div></li>
<li><div class="src-line"><a name="a210"></a><span class="src-doc"> * PelTag::XP_SUBJECT} tags. If another tag is used, then this</span></div></li>
<li><div class="src-line"><a name="a211"></a><span class="src-doc"> * entry will be incorrectly reloaded as a </span><span class="src-doc-inlinetag">{@link PelEntryByte}</span><span class="src-doc">.</span></div></li>
<li><div class="src-line"><a name="a212"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a213"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc">the string that this entry will represent. It will</span></div></li>
<li><div class="src-line"><a name="a214"></a><span class="src-doc"> * be passed to </span><span class="src-doc-inlinetag">{@link setValue}</span><span class="src-doc"> and thus has to obey its</span></div></li>
<li><div class="src-line"><a name="a215"></a><span class="src-doc"> * requirements.</span></div></li>
<li><div class="src-line"><a name="a216"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a217"></a> <span class="src-key">function </span><a href="../PEL/PelEntryWindowsString.html#method__construct">__construct</a><span class="src-sym">(</span><span class="src-var">$tag</span><span class="src-sym">, </span><span class="src-var">$str </span>= <span class="src-str">''</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
<li><div class="src-line"><a name="a218"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../PEL/PelEntry.html#var$tag">tag</a> = <span class="src-var">$tag</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a219"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../PEL/PelEntry.html#var$format">format</a> = <span class="src-id"><a href="../PEL/PelFormat.html">PelFormat</a></span><span class="src-sym">::</span><span class="src-id">BYTE</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a220"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../PEL/PelEntryWindowsString.html#methodsetValue">setValue</a><span class="src-sym">(</span><span class="src-var">$str</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a221"></a> <span class="src-sym">}</span></div></li>
<li><div class="src-line"><a name="a222"></a> </div></li>
<li><div class="src-line"><a name="a223"></a> </div></li>
<li><div class="src-line"><a name="a224"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a225"></a><span class="src-doc"> * Give the entry a new value.</span></div></li>
<li><div class="src-line"><a name="a226"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a227"></a><span class="src-doc"> * This will overwrite the previous value. The value can be</span></div></li>
<li><div class="src-line"><a name="a228"></a><span class="src-doc"> * retrieved later with the </span><span class="src-doc-inlinetag">{@link getValue}</span><span class="src-doc"> method.</span></div></li>
<li><div class="src-line"><a name="a229"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a230"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc">the new value of the entry. This should be use the</span></div></li>
<li><div class="src-line"><a name="a231"></a><span class="src-doc"> * Latin-1 encoding and be given without any extra NULL characters.</span></div></li>
<li><div class="src-line"><a name="a232"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a233"></a> <span class="src-key">function </span><a href="../PEL/PelEntryWindowsString.html#methodsetValue">setValue</a><span class="src-sym">(</span><span class="src-var">$str</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
<li><div class="src-line"><a name="a234"></a> <span class="src-var">$l </span>= <a href="http://www.php.net/strlen">strlen</a><span class="src-sym">(</span><span class="src-var">$str</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a235"></a> </div></li>
<li><div class="src-line"><a name="a236"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../PEL/PelEntry.html#var$components">components</a> = <span class="src-num">2 </span>* <span class="src-sym">(</span><span class="src-var">$l </span>+ <span class="src-num">1</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a237"></a> <span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">str </span>= <span class="src-var">$str</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a238"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../PEL/PelEntry.html#var$bytes">bytes</a> = <span class="src-str">''</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a239"></a> <span class="src-key">for </span><span class="src-sym">(</span><span class="src-var">$i </span>= <span class="src-num">0</span><span class="src-sym">; </span><span class="src-var">$i </span>< <span class="src-var">$l</span><span class="src-sym">; </span><span class="src-var">$i</span>++<span class="src-sym">)</span></div></li>
<li><div class="src-line"><a name="a240"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../PEL/PelEntry.html#var$bytes">bytes</a> .= <span class="src-var">$str</span><span class="src-sym">{</span><span class="src-var">$i</span><span class="src-sym">} </span>. <a href="http://www.php.net/chr">chr</a><span class="src-sym">(</span><span class="src-num">0x00</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a241"></a> </div></li>
<li><div class="src-line"><a name="a242"></a> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../PEL/PelEntry.html#var$bytes">bytes</a> .= <a href="http://www.php.net/chr">chr</a><span class="src-sym">(</span><span class="src-num">0x00</span><span class="src-sym">) </span>. <a href="http://www.php.net/chr">chr</a><span class="src-sym">(</span><span class="src-num">0x00</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a243"></a> <span class="src-sym">}</span></div></li>
<li><div class="src-line"><a name="a244"></a> </div></li>
<li><div class="src-line"><a name="a245"></a> </div></li>
<li><div class="src-line"><a name="a246"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a247"></a><span class="src-doc"> * Return the string of the entry.</span></div></li>
<li><div class="src-line"><a name="a248"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a249"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string </span><span class="src-doc">the string held, without any extra NULL</span></div></li>
<li><div class="src-line"><a name="a250"></a><span class="src-doc"> * characters. The string will be the same as the one given to</span></div></li>
<li><div class="src-line"><a name="a251"></a><span class="src-doc"> * </span><span class="src-doc-inlinetag">{@link setValue}</span><span class="src-doc"> or to the </span><span class="src-doc-inlinetag">{@link __construct constructor}</span><span class="src-doc">.</span></div></li>
<li><div class="src-line"><a name="a252"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a253"></a> <span class="src-key">function </span><a href="../PEL/PelEntryWindowsString.html#methodgetValue">getValue</a><span class="src-sym">(</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
<li><div class="src-line"><a name="a254"></a> <span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">str</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><a name="a255"></a> <span class="src-sym">}</span></div></li>
<li><div class="src-line"><a name="a256"></a> </div></li>
<li><div class="src-line"><a name="a257"></a> </div></li>
<li><div class="src-line"><a name="a258"></a> <span class="src-doc">/**</span></div></li>
<li><div class="src-line"><a name="a259"></a><span class="src-doc"> * Return the string of the entry.</span></div></li>
<li><div class="src-line"><a name="a260"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a261"></a><span class="src-doc"> * This methods returns the same as </span><span class="src-doc-inlinetag">{@link getValue}</span><span class="src-doc">.</span></div></li>
<li><div class="src-line"><a name="a262"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a263"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">boolean </span><span class="src-doc">not used.</span></div></li>
<li><div class="src-line"><a name="a264"></a><span class="src-doc"> *</span></div></li>
<li><div class="src-line"><a name="a265"></a><span class="src-doc"> * </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">string </span><span class="src-doc">the string held, without any extra NULL</span></div></li>
<li><div class="src-line"><a name="a266"></a><span class="src-doc"> * characters. The string will be the same as the one given to</span></div></li>
<li><div class="src-line"><a name="a267"></a><span class="src-doc"> * </span><span class="src-doc-inlinetag">{@link setValue}</span><span class="src-doc"> or to the </span><span class="src-doc-inlinetag">{@link __construct constructor}</span><span class="src-doc">.</span></div></li>
<li><div class="src-line"><a name="a268"></a><span class="src-doc"> */</span></div></li>
<li><div class="src-line"><a name="a269"></a> <span class="src-key">function </span><a href="../PEL/PelEntryWindowsString.html#methodgetText">getText</a><span class="src-sym">(</span><span class="src-var">$brief </span>= <span class="src-id">false</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
<li><div class="src-line"><a name="a270"></a> <span class="src-key">return </span><span class="src-var">$this</span><span class="src-sym">-></span><span class="src-var">str</span><span class="src-sym">; </span></div></li>
<li><div class="src-line"><a name="a271"></a> <span class="src-sym">}</span></div></li>
<li><div class="src-line"><a name="a272"></a> </div></li>
<li><div class="src-line"><a name="a273"></a><span class="src-sym">}</span></div></li>
<li><div class="src-line"><a name="a274"></a> </div></li>
<li><div class="src-line"><a name="a275"></a><span class="src-php">?></span></div></li>
</ol></div>
</div>
<p class="notes" id="credit">
Documentation generated on Tue, 19 Dec 2006 01:08:19 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0</a>
<a target="_top" href="http://sourceforge.net/"><img src="http://sourceforge.net/sflogo.php?group_id=108380&type=1" width="88" height="31" border="0" align="right" alt="SourceForge.net Logo" /></a>
</p>
</body>
</html>