library/Zend/Pdf/Image.php

   1 <?php
   2 /**
   3  * Zend Framework
   4  *
   5  * LICENSE
   6  *
   7  * This source file is subject to the new BSD license that is bundled
   8  * with this package in the file LICENSE.txt.
   9  * It is also available through the world-wide-web at this URL:
  10  * http://framework.zend.com/license/new-bsd
  11  * If you did not receive a copy of the license and are unable to
  12  * obtain it through the world-wide-web, please send an email
  13  * to license@zend.com so we can send you a copy immediately.
  14  *
  15  * @category   Zend
  16  * @package    Zend_Pdf
  17  * @subpackage Images
  18  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  19  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  20  * @version    $Id: Image.php 16971 2009-07-22 18:05:45Z mikaelkael $
  21  */
  22
  23 /** Zend_Pdf_FileParserDataSource */
  24 require_once 'Zend/Pdf/FileParserDataSource.php';
  25
  26 /** Zend_Pdf_FileParserDataSource_File */
  27 require_once 'Zend/Pdf/FileParserDataSource/File.php';
  28
  29 /** Zend_Pdf_FileParserDataSource_String */
  30 require_once 'Zend/Pdf/FileParserDataSource/String.php';
  31
  32 /**
  33  * Abstract factory class which vends {@link Zend_Pdf_Resource_Image} objects.
  34  *
  35  * This class is also the home for image-related constants because the name of
  36  * the true base class ({@link Zend_Pdf_Resource_Image}) is not intuitive for the
  37  * end user.
  38  *
  39  * @package    Zend_Pdf
  40  * @subpackage Images
  41  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  42  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  43  */
  44 abstract class Zend_Pdf_Image
  45 {
  46   /**** Class Constants ****/
  47
  48
  49   /* Image Types */
  50
  51     const TYPE_UNKNOWN = 0;
  52     const TYPE_JPEG = 1;
  53     const TYPE_PNG = 2;
  54     const TYPE_TIFF = 3;
  55
  56   /* TIFF Constants */
  57
  58     const TIFF_FIELD_TYPE_BYTE=1;
  59     const TIFF_FIELD_TYPE_ASCII=2;
  60     const TIFF_FIELD_TYPE_SHORT=3;
  61     const TIFF_FIELD_TYPE_LONG=4;
  62     const TIFF_FIELD_TYPE_RATIONAL=5;
  63
  64     const TIFF_TAG_IMAGE_WIDTH=256;
  65     const TIFF_TAG_IMAGE_LENGTH=257; //Height
  66     const TIFF_TAG_BITS_PER_SAMPLE=258;
  67     const TIFF_TAG_COMPRESSION=259;
  68     const TIFF_TAG_PHOTOMETRIC_INTERPRETATION=262;
  69     const TIFF_TAG_STRIP_OFFSETS=273;
  70     const TIFF_TAG_SAMPLES_PER_PIXEL=277;
  71     const TIFF_TAG_STRIP_BYTE_COUNTS=279;
  72
  73     const TIFF_COMPRESSION_UNCOMPRESSED = 1;
  74     const TIFF_COMPRESSION_CCITT1D = 2;
  75     const TIFF_COMPRESSION_GROUP_3_FAX = 3;
  76     const TIFF_COMPRESSION_GROUP_4_FAX  = 4;
  77     const TIFF_COMPRESSION_LZW = 5;
  78     const TIFF_COMPRESSION_JPEG = 6;
  79     const TIFF_COMPRESSION_FLATE = 8;
  80     const TIFF_COMPRESSION_FLATE_OBSOLETE_CODE = 32946;
  81     const TIFF_COMPRESSION_PACKBITS = 32773;
  82
  83     const TIFF_PHOTOMETRIC_INTERPRETATION_WHITE_IS_ZERO=0;
  84     const TIFF_PHOTOMETRIC_INTERPRETATION_BLACK_IS_ZERO=1;
  85     const TIFF_PHOTOMETRIC_INTERPRETATION_RGB=2;
  86     const TIFF_PHOTOMETRIC_INTERPRETATION_RGB_INDEXED=3;
  87     const TIFF_PHOTOMETRIC_INTERPRETATION_CMYK=5;
  88     const TIFF_PHOTOMETRIC_INTERPRETATION_YCBCR=6;
  89     const TIFF_PHOTOMETRIC_INTERPRETATION_CIELAB=8;
  90
  91   /* PNG Constants */
  92
  93     const PNG_COMPRESSION_DEFAULT_STRATEGY = 0;
  94     const PNG_COMPRESSION_FILTERED = 1;
  95     const PNG_COMPRESSION_HUFFMAN_ONLY = 2;
  96     const PNG_COMPRESSION_RLE = 3;
  97
  98     const PNG_FILTER_NONE = 0;
  99     const PNG_FILTER_SUB = 1;
 100     const PNG_FILTER_UP = 2;
 101     const PNG_FILTER_AVERAGE = 3;
 102     const PNG_FILTER_PAETH = 4;
 103
 104     const PNG_INTERLACING_DISABLED = 0;
 105     const PNG_INTERLACING_ENABLED = 1;
 106
 107     const PNG_CHANNEL_GRAY = 0;
 108     const PNG_CHANNEL_RGB = 2;
 109     const PNG_CHANNEL_INDEXED = 3;
 110     const PNG_CHANNEL_GRAY_ALPHA = 4;
 111     const PNG_CHANNEL_RGB_ALPHA = 6;
 112
 113   /**** Public Interface ****/
 114
 115
 116   /* Factory Methods */
 117
 118     /**
 119      * Returns a {@link Zend_Pdf_Resource_Image} object by file path.
 120      *
 121      * @param string $filePath Full path to the image file.
 122      * @return Zend_Pdf_Resource_Image
 123      * @throws Zend_Pdf_Exception
 124      */
 125     public static function imageWithPath($filePath)
 126     {
 127
 128         /**
 129          * use old implementation
 130          * @todo switch to new implementation
 131          */
 132         require_once 'Zend/Pdf/Resource/ImageFactory.php';
 133         return Zend_Pdf_Resource_ImageFactory::factory($filePath);
 134
 135
 136         /* Create a file parser data source object for this file. File path and
 137          * access permission checks are handled here.
 138          */
 139         $dataSource = new Zend_Pdf_FileParserDataSource_File($filePath);
 140
 141         /* Attempt to determine the type of image. We can't always trust file
 142          * extensions, but try that first since it's fastest.
 143          */
 144         $fileExtension = strtolower(pathinfo($filePath, PATHINFO_EXTENSION));
 145
 146         /* If it turns out that the file is named improperly and we guess the
 147          * wrong type, we'll get null instead of an image object.
 148          */
 149         switch ($fileExtension) {
 150             case 'tif':
 151                 //Fall through to next case;
 152             case 'tiff':
 153                 $image = Zend_Pdf_Image::_extractTiffImage($dataSource);
 154                 break;
 155             case 'png':
 156                 $image = Zend_Pdf_Image::_extractPngImage($dataSource);
 157                 break;
 158             case 'jpg':
 159                 //Fall through to next case;
 160             case 'jpe':
 161                 //Fall through to next case;
 162             case 'jpeg':
 163                 $image = Zend_Pdf_Image::_extractJpegImage($dataSource);
 164                 break;
 165             default:
 166                 throw new Zend_Pdf_Exception("Cannot create image resource. File extension not known or unsupported type.");
 167                 break;
 168         }
 169
 170         /* Done with the data source object.
 171          */
 172         $dataSource = null;
 173
 174         if ($image !== null) {
 175             return $image;
 176
 177         } else {
 178             /* The type of image could not be determined. Give up.
 179              */
 180             throw new Zend_Pdf_Exception("Cannot determine image type: $filePath",
 181  Zend_Pdf_Exception::CANT_DETERMINE_IMAGE_TYPE);
 182          }
 183     }
 184
 185
 186
 187   /**** Internal Methods ****/
 188
 189
 190   /* Image Extraction Methods */
 191
 192     /**
 193      * Attempts to extract a JPEG Image from the data source.
 194      *
 195      * @param Zend_Pdf_FileParserDataSource $dataSource
 196      * @return Zend_Pdf_Resource_Image_Jpeg May also return null if
 197      *   the data source does not appear to contain valid image data.
 198      * @throws Zend_Pdf_Exception
 199      */
 200     protected static function _extractJpegImage($dataSource)
 201     {
 202         $imageParser = new Zend_Pdf_FileParser_Image_Jpeg($dataSource);
 203         $image = new Zend_Pdf_Resource_Image_Jpeg($imageParser);
 204         unset($imageParser);
 205
 206         return $image;
 207     }
 208
 209     /**
 210      * Attempts to extract a PNG Image from the data source.
 211      *
 212      * @param Zend_Pdf_FileParserDataSource $dataSource
 213      * @return Zend_Pdf_Resource_Image_Png May also return null if
 214      *   the data source does not appear to contain valid image data.
 215      * @throws Zend_Pdf_Exception
 216      */
 217     protected static function _extractPngImage($dataSource)
 218     {
 219         $imageParser = new Zend_Pdf_FileParser_Image_PNG($dataSource);
 220         $image = new Zend_Pdf_Resource_Image_PNG($imageParser);
 221         unset($imageParser);
 222
 223         return $image;
 224     }
 225
 226     /**
 227      * Attempts to extract a TIFF Image from the data source.
 228      *
 229      * @param Zend_Pdf_FileParserDataSource $dataSource
 230      * @return Zend_Pdf_Resource_Image_Tiff May also return null if
 231      *   the data source does not appear to contain valid image data.
 232      * @throws Zend_Pdf_Exception
 233      */
 234     protected static function _extractTiffImage($dataSource)
 235     {
 236         $imageParser = new Zend_Pdf_FileParser_Image_Tiff($dataSource);
 237         $image = new Zend_Pdf_Resource_Image_Tiff($imageParser);
 238         unset($imageParser);
 239
 240         return $image;
 241     }
 242
 243 }
 244
 245
 246