Skip to content
This repository
Browse code

Move constructor/destructor discussion to class level docblock

- and remove entirely from the class body
  • Loading branch information...
commit ad43d3128d61ec67071872d4e4484ea2be1d4d8e 1 parent 3653351
Matthew Weier O'Phinney authored
33  library/Zend/Pdf/BinaryParser/DataSource/AbstractDataSource.php
@@ -39,7 +39,16 @@
39 39
  * Subclasses should also override {@link moveToOffset()} and
40 40
  * {@link __toString()} as appropriate.
41 41
  *
42  
- * @uses       \Zend\Pdf\Exception
  42
+ * The constructor is not defined in this abstract class. However, implementing
  43
+ * classes should provide one. It should do the following:
  44
+ * - Open the data source for parsing.
  45
+ * - Should set $this->_size to the total size in bytes of the data source.
  46
+ * - If the data source cannot be opened for any reason (such as insufficient
  47
+ *   permissions, missing file, etc.), it should throw an appropriate exception.
  48
+ *
  49
+ * The destructor is also not defined in this abstract class. However, 
  50
+ * implementing classes should define one, and have it close the data source.
  51
+ *
43 52
  * @package    Zend_PDF
44 53
  * @subpackage Zend_PDF_BinaryParser
45 54
  * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
@@ -70,28 +79,6 @@
70 79
     /* Abstract Methods */
71 80
 
72 81
     /**
73  
-     * Object constructor. Opens the data source for parsing.
74  
-     *
75  
-     * Must set $this->_size to the total size in bytes of the data source.
76  
-     *
77  
-     * Upon return the data source can be interrogated using the primitive
78  
-     * methods described here.
79  
-     *
80  
-     * If the data source cannot be opened for any reason (such as insufficient
81  
-     * permissions, missing file, etc.), will throw an appropriate exception.
82  
-     *
83  
-     * @throws \Zend\Pdf\Exception
84  
-     */
85  
-    //abstract public function __construct();
86  
-
87  
-    /**
88  
-     * Object destructor. Closes the data source.
89  
-     *
90  
-     * May also perform cleanup tasks such as deleting temporary files.
91  
-     */
92  
-    //abstract public function __destruct();
93  
-
94  
-    /**
95 82
      * Returns the specified number of raw bytes from the data source at the
96 83
      * byte offset of the current read position.
97 84
      *

0 notes on commit ad43d31

Please sign in to comment.
Something went wrong with that request. Please try again.