PageRenderTime 27ms CodeModel.GetById 11ms RepoModel.GetById 0ms app.codeStats 0ms

/framework/vendor/zend/Zend/Pdf/ElementFactory/Interface.php

http://zoop.googlecode.com/
PHP | 151 lines | 19 code | 15 blank | 117 comment | 0 complexity | ab8ab2577b547eccf83ff382c6df4243 MD5 | raw file
Possible License(s): BSD-3-Clause, LGPL-2.1
  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. * @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  18. * @license http://framework.zend.com/license/new-bsd New BSD License
  19. * @version $Id: Interface.php 20096 2010-01-06 02:05:09Z bkarwin $
  20. */
  21. /**
  22. * PDF element factory interface.
  23. * Responsibility is to log PDF changes
  24. *
  25. * @package Zend_Pdf
  26. * @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  27. * @license http://framework.zend.com/license/new-bsd New BSD License
  28. */
  29. interface Zend_Pdf_ElementFactory_Interface
  30. {
  31. /**
  32. * Close factory and clean-up resources
  33. *
  34. * @internal
  35. */
  36. public function close();
  37. /**
  38. * Get source factory object
  39. *
  40. * @return Zend_Pdf_ElementFactory
  41. */
  42. public function resolve();
  43. /**
  44. * Get factory ID
  45. *
  46. * @return integer
  47. */
  48. public function getId();
  49. /**
  50. * Set object counter
  51. *
  52. * @param integer $objCount
  53. */
  54. public function setObjectCount($objCount);
  55. /**
  56. * Get object counter
  57. *
  58. * @return integer
  59. */
  60. public function getObjectCount();
  61. /**
  62. * Attach factory to the current;
  63. *
  64. * @param Zend_Pdf_ElementFactory_Interface $factory
  65. */
  66. public function attach(Zend_Pdf_ElementFactory_Interface $factory);
  67. /**
  68. * Calculate object enumeration shift.
  69. *
  70. * @param Zend_Pdf_ElementFactory_Interface $factory
  71. * @return integer
  72. */
  73. public function calculateShift(Zend_Pdf_ElementFactory_Interface $factory);
  74. /**
  75. * Clean enumeration shift cache.
  76. * Has to be used after PDF render operation to let followed updates be correct.
  77. *
  78. * @param Zend_Pdf_ElementFactory_Interface $factory
  79. * @return integer
  80. */
  81. public function cleanEnumerationShiftCache();
  82. /**
  83. * Retrive object enumeration shift.
  84. *
  85. * @param Zend_Pdf_ElementFactory_Interface $factory
  86. * @return integer
  87. * @throws Zend_Pdf_Exception
  88. */
  89. public function getEnumerationShift(Zend_Pdf_ElementFactory_Interface $factory);
  90. /**
  91. * Mark object as modified in context of current factory.
  92. *
  93. * @param Zend_Pdf_Element_Object $obj
  94. * @throws Zend_Pdf_Exception
  95. */
  96. public function markAsModified(Zend_Pdf_Element_Object $obj);
  97. /**
  98. * Remove object in context of current factory.
  99. *
  100. * @param Zend_Pdf_Element_Object $obj
  101. * @throws Zend_Pdf_Exception
  102. */
  103. public function remove(Zend_Pdf_Element_Object $obj);
  104. /**
  105. * Generate new Zend_Pdf_Element_Object
  106. *
  107. * @todo Reusage of the freed object. It's not a support of new feature, but only improvement.
  108. *
  109. * @param Zend_Pdf_Element $objectValue
  110. * @return Zend_Pdf_Element_Object
  111. */
  112. public function newObject(Zend_Pdf_Element $objectValue);
  113. /**
  114. * Generate new Zend_Pdf_Element_Object_Stream
  115. *
  116. * @todo Reusage of the freed object. It's not a support of new feature, but only improvement.
  117. *
  118. * @param mixed $objectValue
  119. * @return Zend_Pdf_Element_Object_Stream
  120. */
  121. public function newStreamObject($streamValue);
  122. /**
  123. * Enumerate modified objects.
  124. * Returns array of Zend_Pdf_UpdateInfoContainer
  125. *
  126. * @param Zend_Pdf_ElementFactory $rootFactory
  127. * @return array
  128. */
  129. public function listModifiedObjects($rootFactory = null);
  130. /**
  131. * Check if PDF file was modified
  132. *
  133. * @return boolean
  134. */
  135. public function isModified();
  136. }