yaffs.net Git - yaffs-website/blob - lsolesen/pel/src/PelEntryException.php

   1 <?php
   2
   3 /**
   4  * PEL: PHP Exif Library.
   5  * A library with support for reading and
   6  * writing all Exif headers in JPEG and TIFF images using PHP.
   7  *
   8  * Copyright (C) 2004, 2005, 2006 Martin Geisler.
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program in the file COPYING; if not, write to the
  22  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  23  * Boston, MA 02110-1301 USA
  24  */
  25 namespace lsolesen\pel;
  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  * @license http://www.gnu.org/licenses/gpl.html GNU General Public
  38  *          License (GPL)
  39  * @package PEL
  40  */
  41
  42 /**
  43  * Exception indicating a problem with an entry.
  44  *
  45  * @author Martin Geisler <mgeisler@users.sourceforge.net>
  46  * @package PEL
  47  * @subpackage Exception
  48  */
  49 class PelEntryException extends PelException
  50 {
  51
  52     /**
  53      * The IFD type (if known).
  54      *
  55      * @var int
  56      */
  57     protected $type;
  58
  59     /**
  60      * The tag of the entry (if known).
  61      *
  62      * @var PelTag
  63      */
  64     protected $tag;
  65
  66     /**
  67      * Get the IFD type associated with the exception.
  68      *
  69      * @return int one of {@link PelIfd::IFD0}, {@link PelIfd::IFD1},
  70      *         {@link PelIfd::EXIF}, {@link PelIfd::GPS}, or {@link
  71      *         PelIfd::INTEROPERABILITY}. If no type is set, null is returned.
  72      */
  73     public function getIfdType()
  74     {
  75         return $this->type;
  76     }
  77
  78     /**
  79      * Get the tag associated with the exception.
  80      *
  81      * @return PelTag the tag. If no tag is set, null is returned.
  82      */
  83     public function getTag()
  84     {
  85         return $this->tag;
  86     }
  87 }