Source for file PelEntry.php

Documentation is available at PelEntry.php

  1. <?php
  2.  
  3. /*  PEL: PHP Exif Library.  A library with support for reading and
  4.  *  writing all Exif headers in JPEG and TIFF images using PHP.
  5.  *
  6.  *  Copyright (C) 2004, 2005, 2006  Martin Geisler.
  7.  *
  8.  *  This program is free software; you can redistribute it and/or modify
  9.  *  it under the terms of the GNU General Public License as published by
  10.  *  the Free Software Foundation; either version 2 of the License, or
  11.  *  (at your option) any later version.
  12.  *
  13.  *  This program is distributed in the hope that it will be useful,
  14.  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15.  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16.  *  GNU General Public License for more details.
  17.  *
  18.  *  You should have received a copy of the GNU General Public License
  19.  *  along with this program in the file COPYING; if not, write to the
  20.  *  Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  21.  *  Boston, MA 02110-1301 USA
  22.  */
  23.  
  24. /* $Id$ */
  25.  
  26.  
  27. /**
  28.  * Classes for dealing with Exif entries.
  29.  *
  30.  * This file defines two exception classes and the abstract class
  31.  * {@link PelEntry} which provides the basic methods that all Exif
  32.  * entries will have.  All Exif entries will be represented by
  33.  * descendants of the {@link PelEntry} class --- the class itself is
  34.  * abstract and so it cannot be instantiated.
  35.  *
  36.  * @author Martin Geisler <mgeisler@users.sourceforge.net>
  37.  * @version $Revision$
  38.  * @date $Date$
  39.  * @license http://www.gnu.org/licenses/gpl.html GNU General Public
  40.  *  License (GPL)
  41.  * @package PEL
  42.  */
  43.  
  44. /**#@+ Required class definitions. */
  45. require_once('PelException.php');
  46. require_once('PelFormat.php');
  47. require_once('PelTag.php');
  48. require_once('Pel.php');
  49. /**#@-*/
  50.  
  51.  
  52. /**
  53.  * Exception indicating a problem with an entry.
  54.  *
  55.  * @author Martin Geisler <mgeisler@users.sourceforge.net>
  56.  * @package PEL
  57.  * @subpackage Exception
  58.  */
  59. class PelEntryException extends PelException {
  60.  
  61.   /**
  62.    * The IFD type (if known).
  63.    *
  64.    * @var int 
  65.    */
  66.   protected $type;
  67.  
  68.   /**
  69.    * The tag of the entry (if known).
  70.    *
  71.    * @var PelTag 
  72.    */
  73.   protected $tag;
  74.  
  75.   /**
  76.    * Get the IFD type associated with the exception.
  77.    *
  78.    * @return int one of {@link PelIfd::IFD0}, {@link PelIfd::IFD1},
  79.    *  {@link PelIfd::EXIF}, {@link PelIfd::GPS}, or {@link }
  80.    *  PelIfd::INTEROPERABILITY}.  If no type is set, null is returned.
  81.    */
  82.   function getIfdType() {
  83.     return $this->type;
  84.   }
  85.  
  86.  
  87.   /**
  88.    * Get the tag associated with the exception.
  89.    *
  90.    * @return PelTag the tag.  If no tag is set, null is returned.
  91.    */
  92.   function getTag() {
  93.     return $this->tag;
  94.   }
  95.  
  96. }
  97.  
  98.  
  99. /**
  100.  * Exception indicating that an unexpected format was found.
  101.  *
  102.  * The documentation for each tag in {@link PelTag} will detail any
  103.  * constrains.
  104.  *
  105.  * @author Martin Geisler <mgeisler@users.sourceforge.net>
  106.  * @package PEL
  107.  * @subpackage Exception
  108.  */
  109. class PelUnexpectedFormatException extends PelEntryException {
  110.  
  111.   /**
  112.    * Construct a new exception indicating an invalid format.
  113.    *
  114.    * @param int the type of IFD.
  115.    *
  116.    * @param PelTag the tag for which the violation was found.
  117.    *
  118.    * @param PelFormat the format found.
  119.    *
  120.    * @param PelFormat the expected format.
  121.    */
  122.   function __construct($type, $tag, $found, $expected) {
  123.     parent::__construct('Unexpected format found for %s tag: PelFormat::%s. ' .
  124.                         'Expected PelFormat::%s instead.',
  125.                         PelTag::getName($type, $tag),
  126.                         strtoupper(PelFormat::getName($found)),
  127.                         strtoupper(PelFormat::getName($expected)));
  128.     $this->tag  = $tag;
  129.     $this->type = $type;
  130.   }
  131. }
  132.  
  133.  
  134. /**
  135.  * Exception indicating that an unexpected number of components was
  136.  * found.
  137.  *
  138.  * Some tags have strict limits as to the allowed number of
  139.  * components, and this exception is thrown if the data violates such
  140.  * a constraint.  The documentation for each tag in {@link PelTag}
  141.  * explains the expected number of components.
  142.  *
  143.  * @author Martin Geisler <mgeisler@users.sourceforge.net>
  144.  * @package PEL
  145.  * @subpackage Exception
  146.  */
  147. class PelWrongComponentCountException extends PelEntryException {
  148.  
  149.   /**
  150.    * Construct a new exception indicating a wrong number of
  151.    * components.
  152.    *
  153.    * @param int the type of IFD.
  154.    *
  155.    * @param PelTag the tag for which the violation was found.
  156.    *
  157.    * @param int the number of components found.
  158.    *
  159.    * @param int the expected number of components.
  160.    */
  161.   function __construct($type, $tag, $found, $expected) {
  162.     parent::__construct('Wrong number of components found for %s tag: %d. ' .
  163.                         'Expected %d.',
  164.                         PelTag::getName($type, $tag), $found, $expected);
  165.     $this->tag  = $tag;
  166.     $this->type = $type;
  167.   }
  168. }
  169.  
  170.  
  171. /**
  172.  * Common ancestor class of all {@link PelIfd} entries.
  173.  *
  174.  * As this class is abstract you cannot instantiate objects from it.
  175.  * It only serves as a common ancestor to define the methods common to
  176.  * all entries.  The most important methods are {@link getValue()} and
  177.  * {@link setValue()}, both of which is abstract in this class.  The
  178.  * descendants will give concrete implementations for them.
  179.  *
  180.  * If you have some data coming from an image (some raw bytes), then
  181.  * the static method {@link newFromData()} is helpful --- it will look
  182.  * at the data and give you a proper decendent of {@link PelEntry}
  183.  * back.
  184.  *
  185.  * If you instead want to have an entry for some data which take the
  186.  * form of an integer, a string, a byte, or some other PHP type, then
  187.  * don't use this class.  You should instead create an object of the
  188.  * right subclass ({@link PelEntryShort} for short integers, {@link }
  189.  * PelEntryAscii} for strings, and so on) directly.
  190.  *
  191.  * @author Martin Geisler <mgeisler@users.sourceforge.net>
  192.  * @package PEL
  193.  */
  194. abstract class PelEntry {
  195.  
  196.   /**
  197.    * Type of IFD containing this tag.
  198.    *
  199.    * This must be one of the constants defined in {@link PelIfd}:
  200.    * {@link PelIfd::IFD0} for the main image IFD, {@link PelIfd::IFD1}
  201.    * for the thumbnail image IFD, {@link PelIfd::EXIF} for the Exif
  202.    * sub-IFD, {@link PelIfd::GPS} for the GPS sub-IFD, or {@link }
  203.    * PelIfd::INTEROPERABILITY} for the interoperability sub-IFD.
  204.    *
  205.    * @var int 
  206.    */
  207.   protected $ifd_type;
  208.  
  209.   /**
  210.    * The bytes representing this entry.
  211.    *
  212.    * Subclasses must either override {@link getBytes()} or, if
  213.    * possible, maintain this property so that it always contains a
  214.    * true representation of the entry.
  215.    *
  216.    * @var string 
  217.    */
  218.   protected $bytes = '';
  219.  
  220.   /**
  221.    * The {@link PelTag} of this entry.
  222.    *
  223.    * @var PelTag 
  224.    */
  225.   protected $tag;
  226.  
  227.   /**
  228.    * The {@link PelFormat} of this entry.
  229.    *
  230.    * @var PelFormat 
  231.    */
  232.   protected $format;
  233.  
  234.   /**
  235.    * The number of components of this entry.
  236.    *
  237.    * @var int 
  238.    */
  239.   protected $components;
  240.  
  241.  
  242.   /**
  243.    * Return the tag of this entry.
  244.    *
  245.    * @return PelTag the tag of this entry.
  246.    */
  247.   function getTag() {
  248.     return $this->tag;
  249.   }
  250.  
  251.  
  252.   /**
  253.    * Return the type of IFD which holds this entry.
  254.    *
  255.    * @return int one of the constants defined in {@link PelIfd}:
  256.    *  {@link PelIfd::IFD0} for the main image IFD, {@link PelIfd::IFD1}
  257.    *  for the thumbnail image IFD, {@link PelIfd::EXIF} for the Exif
  258.    *  sub-IFD, {@link PelIfd::GPS} for the GPS sub-IFD, or {@link }
  259.    *  PelIfd::INTEROPERABILITY} for the interoperability sub-IFD.
  260.    */
  261.   function getIfdType() {
  262.     return $this->ifd_type;
  263.   }
  264.  
  265.  
  266.   /**
  267.    * Update the IFD type.
  268.    *
  269.    * @param int must be one of the constants defined in {@link }
  270.    *  PelIfd}: {@link PelIfd::IFD0} for the main image IFD, {@link }
  271.    *  PelIfd::IFD1} for the thumbnail image IFD, {@link PelIfd::EXIF}
  272.    *  for the Exif sub-IFD, {@link PelIfd::GPS} for the GPS sub-IFD, or
  273.    *  {@link PelIfd::INTEROPERABILITY} for the interoperability
  274.    *  sub-IFD.
  275.    */
  276.   function setIfdType($type) {
  277.     $this->ifd_type = $type;
  278.   }
  279.  
  280.  
  281.   /**
  282.    * Return the format of this entry.
  283.    *
  284.    * @return PelFormat the format of this entry.
  285.    */
  286.   function getFormat() {
  287.     return $this->format;
  288.   }
  289.  
  290.  
  291.   /**
  292.    * Return the number of components of this entry.
  293.    *
  294.    * @return int the number of components of this entry.
  295.    */
  296.   function getComponents() {
  297.     return $this->components;
  298.   }
  299.  
  300.  
  301.   /**
  302.    * Turn this entry into bytes.
  303.    *
  304.    * @param PelByteOrder the desired byte order, which must be either
  305.    *  {@link Convert::LITTLE_ENDIAN} or {@link Convert::BIG_ENDIAN}.
  306.    *
  307.    * @return string bytes representing this entry.
  308.    */
  309.   function getBytes($o) {
  310.     return $this->bytes;
  311.   }
  312.  
  313.  
  314.   /**
  315.    * Get the value of this entry as text.
  316.    *
  317.    * The value will be returned in a format suitable for presentation,
  318.    * e.g., rationals will be returned as 'x/y', ASCII strings will be
  319.    * returned as themselves etc.
  320.    *
  321.    * @param boolean some values can be returned in a long or more
  322.    *  brief form, and this parameter controls that.
  323.    *
  324.    * @return string the value as text.
  325.    */
  326.   abstract function getText($brief = false);
  327.  
  328.  
  329.   /**
  330.    * Get the value of this entry.
  331.    *
  332.    * The value returned will generally be the same as the one supplied
  333.    * to the constructor or with {@link setValue()}.  For a formatted
  334.    * version of the value, one should use {@link getText()} instead.
  335.    *
  336.    * @return mixed the unformatted value.
  337.    */
  338.   abstract function getValue();
  339.  
  340.  
  341.   /**
  342.    * Set the value of this entry.
  343.    *
  344.    * The value should be in the same format as for the constructor.
  345.    *
  346.    * @param mixed the new value.
  347.    *
  348.    * @abstract
  349.    */
  350.   function setValue($value) {
  351.     /* This (fake) abstract method is here to make it possible for the
  352.      * documentation to refer to PelEntry::setValue().
  353.      *
  354.      * It cannot declared abstract in the proper PHP way, for then PHP
  355.      * wont allow subclasses to define it with two arguments (which is
  356.      * what PelEntryCopyright does).
  357.      */
  358.     throw new PelException('setValue() is abstract.');
  359.   }
  360.  
  361.  
  362.   /**
  363.    * Turn this entry into a string.
  364.    *
  365.    * @return string a string representation of this entry.  This is
  366.    *  mostly for debugging.
  367.    */
  368.   function __toString() {
  369.     $str = Pel::fmt("  Tag: 0x%04X (%s)\n",
  370.                     $this->tag, PelTag::getName($this->ifd_type, $this->tag));
  371.     $str .= Pel::fmt("    Format    : %d (%s)\n",
  372.                      $this->format, PelFormat::getName($this->format));
  373.     $str .= Pel::fmt("    Components: %d\n", $this->components);
  374.     if ($this->getTag() != PelTag::MAKER_NOTE &&
  375.         $this->getTag() != PelTag::PRINT_IM)
  376.       $str .= Pel::fmt("    Value     : %s\n", print_r($this->getValue(), true));
  377.     $str .= Pel::fmt("    Text      : %s\n", $this->getText());
  378.     return $str;
  379.   }
  380. }
  381.  
  382. ?>

Documentation generated on Thu, 05 May 2011 07:19:00 +0200 by phpDocumentor 1.4.3