API Documentation

Zend/Pdf/Image.php

Show: inherited
Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Pdf  
Subpackage
Images  
Version
$Id: Image.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Pdf_Image

Package: Zend\Pdf\Images

Abstract factory class which vends {@link Zend_Pdf_Resource_Image} objects.

This class is also the home for image-related constants because the name of the true base class ({@link Zend_Pdf_Resource_Image}) is not intuitive for the end user.

Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

Constant  TYPE_UNKNOWN = 0
Constant  TYPE_JPEG = 1
Constant  TYPE_PNG = 2
Constant  TYPE_TIFF = 3
Constant  TIFF_FIELD_TYPE_BYTE = 1
Constant  TIFF_FIELD_TYPE_ASCII = 2
Constant  TIFF_FIELD_TYPE_SHORT = 3
Constant  TIFF_FIELD_TYPE_LONG = 4
Constant  TIFF_FIELD_TYPE_RATIONAL = 5
Constant  TIFF_TAG_IMAGE_WIDTH = 256
Constant  TIFF_TAG_IMAGE_LENGTH = 257
Constant  TIFF_TAG_BITS_PER_SAMPLE = 258
Constant  TIFF_TAG_COMPRESSION = 259
Constant  TIFF_TAG_PHOTOMETRIC_INTERPRETATION = 262
Constant  TIFF_TAG_STRIP_OFFSETS = 273
Constant  TIFF_TAG_SAMPLES_PER_PIXEL = 277
Constant  TIFF_TAG_STRIP_BYTE_COUNTS = 279
Constant  TIFF_COMPRESSION_UNCOMPRESSED = 1
Constant  TIFF_COMPRESSION_CCITT1D = 2
Constant  TIFF_COMPRESSION_GROUP_3_FAX = 3
Constant  TIFF_COMPRESSION_GROUP_4_FAX = 4
Constant  TIFF_COMPRESSION_LZW = 5
Constant  TIFF_COMPRESSION_JPEG = 6
Constant  TIFF_COMPRESSION_FLATE = 8
Constant  TIFF_COMPRESSION_FLATE_OBSOLETE_CODE = 32946
Constant  TIFF_COMPRESSION_PACKBITS = 32773
Constant  TIFF_PHOTOMETRIC_INTERPRETATION_WHITE_IS_ZERO = 0
Constant  TIFF_PHOTOMETRIC_INTERPRETATION_BLACK_IS_ZERO = 1
Constant  TIFF_PHOTOMETRIC_INTERPRETATION_RGB = 2
Constant  TIFF_PHOTOMETRIC_INTERPRETATION_RGB_INDEXED = 3
Constant  TIFF_PHOTOMETRIC_INTERPRETATION_CMYK = 5
Constant  TIFF_PHOTOMETRIC_INTERPRETATION_YCBCR = 6
Constant  TIFF_PHOTOMETRIC_INTERPRETATION_CIELAB = 8
Constant  PNG_COMPRESSION_DEFAULT_STRATEGY = 0
Constant  PNG_COMPRESSION_FILTERED = 1
Constant  PNG_COMPRESSION_HUFFMAN_ONLY = 2
Constant  PNG_COMPRESSION_RLE = 3
Constant  PNG_FILTER_NONE = 0
Constant  PNG_FILTER_SUB = 1
Constant  PNG_FILTER_UP = 2
Constant  PNG_FILTER_AVERAGE = 3
Constant  PNG_FILTER_PAETH = 4
Constant  PNG_INTERLACING_DISABLED = 0
Constant  PNG_INTERLACING_ENABLED = 1
Constant  PNG_CHANNEL_GRAY = 0
Constant  PNG_CHANNEL_RGB = 2
Constant  PNG_CHANNEL_INDEXED = 3
Constant  PNG_CHANNEL_GRAY_ALPHA = 4
Constant  PNG_CHANNEL_RGB_ALPHA = 6

Methods

methodprotected_extractJpegImage( \Zend_Pdf_FileParserDataSource $dataSource ) : \Zend_Pdf_Resource_Image_Jpeg
static

Attempts to extract a JPEG Image from the data source.

Parameters
Name Type Description
$dataSource \Zend_Pdf_FileParserDataSource
Returns
Type Description
\Zend_Pdf_Resource_Image_Jpeg May also return null if the data source does not appear to contain valid image data.
Throws
Exception Description
\Zend_Pdf_Exception
methodprotected_extractPngImage( \Zend_Pdf_FileParserDataSource $dataSource ) : \Zend_Pdf_Resource_Image_Png
static

Attempts to extract a PNG Image from the data source.

Parameters
Name Type Description
$dataSource \Zend_Pdf_FileParserDataSource
Returns
Type Description
\Zend_Pdf_Resource_Image_Png May also return null if the data source does not appear to contain valid image data.
methodprotected_extractTiffImage( \Zend_Pdf_FileParserDataSource $dataSource ) : \Zend_Pdf_Resource_Image_Tiff
static

Attempts to extract a TIFF Image from the data source.

Parameters
Name Type Description
$dataSource \Zend_Pdf_FileParserDataSource
Returns
Type Description
\Zend_Pdf_Resource_Image_Tiff May also return null if the data source does not appear to contain valid image data.
Throws
Exception Description
\Zend_Pdf_Exception
methodpublicimageWithPath( string $filePath ) : \Zend_Pdf_Resource_Image
static

Returns a {@link Zend_Pdf_Resource_Image} object by file path.

Parameters
Name Type Description
$filePath string

Full path to the image file.

Returns
Type Description
\Zend_Pdf_Resource_Image
Throws
Exception Description
\Zend_Pdf_Exception
Documentation was generated by DocBlox 0.15.1.