web/lib/Zend/Pdf/FileParserDataSource.php
changeset 886 1e110b03ae96
parent 807 877f952ae2bd
child 1230 68c69c656a2c
equal deleted inserted replaced
885:2251fb41dbc7 886:1e110b03ae96
    13  * to license@zend.com so we can send you a copy immediately.
    13  * to license@zend.com so we can send you a copy immediately.
    14  *
    14  *
    15  * @category   Zend
    15  * @category   Zend
    16  * @package    Zend_Pdf
    16  * @package    Zend_Pdf
    17  * @subpackage FileParser
    17  * @subpackage FileParser
    18  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
    18  * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
    19  * @license    http://framework.zend.com/license/new-bsd     New BSD License
    19  * @license    http://framework.zend.com/license/new-bsd     New BSD License
    20  * @version    $Id: FileParserDataSource.php 20096 2010-01-06 02:05:09Z bkarwin $
    20  * @version    $Id: FileParserDataSource.php 24806 2012-05-15 11:32:11Z adamlundrigan $
    21  */
    21  */
    22 
    22 
    23 /**
    23 /**
    24  * Abstract helper class for {@link Zend_Pdf_FileParser} that provides the
    24  * Abstract helper class for {@link Zend_Pdf_FileParser} that provides the
    25  * data source for parsing.
    25  * data source for parsing.
    33  * Subclasses should also override {@link moveToOffset()} and
    33  * Subclasses should also override {@link moveToOffset()} and
    34  * {@link __toString()} as appropriate.
    34  * {@link __toString()} as appropriate.
    35  *
    35  *
    36  * @package    Zend_Pdf
    36  * @package    Zend_Pdf
    37  * @subpackage FileParser
    37  * @subpackage FileParser
    38  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
    38  * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
    39  * @license    http://framework.zend.com/license/new-bsd     New BSD License
    39  * @license    http://framework.zend.com/license/new-bsd     New BSD License
    40  */
    40  */
    41 abstract class Zend_Pdf_FileParserDataSource
    41 abstract class Zend_Pdf_FileParserDataSource
    42 {
    42 {
    43   /**** Instance Variables ****/
    43   /**** Instance Variables ****/
    59 
    59 
    60   /**** Public Interface ****/
    60   /**** Public Interface ****/
    61 
    61 
    62 
    62 
    63   /* Abstract Methods */
    63   /* Abstract Methods */
    64 
       
    65     /**
       
    66      * Object constructor. Opens the data source for parsing.
       
    67      *
       
    68      * Must set $this->_size to the total size in bytes of the data source.
       
    69      *
       
    70      * Upon return the data source can be interrogated using the primitive
       
    71      * methods described here.
       
    72      *
       
    73      * If the data source cannot be opened for any reason (such as insufficient
       
    74      * permissions, missing file, etc.), will throw an appropriate exception.
       
    75      *
       
    76      * @throws Zend_Pdf_Exception
       
    77      */
       
    78     abstract public function __construct();
       
    79 
    64 
    80     /**
    65     /**
    81      * Object destructor. Closes the data source.
    66      * Object destructor. Closes the data source.
    82      *
    67      *
    83      * May also perform cleanup tasks such as deleting temporary files.
    68      * May also perform cleanup tasks such as deleting temporary files.