API Documentation

Pdf/Element/Stream.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Pdf  
version
$Id: Stream.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Pdf_Element_Stream

PDF file 'stream' element implementation

Extends from
\Zend_Pdf_Element
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Pdf  

Properties

Propertypublic\Zend_Memory_Container  $value= ''

Object value

Details
Type
\Zend_Memory_Container

Methods

methodpublic__construct( string $val ) : void

Object constructor

Parameters
Name Type Description
$val string
methodpublicappend( mixed $val ) : void

Append value to a stream

Parameters
Name Type Description
$val mixed
methodpubliccleanUp( ) : void

Clean up resources, used by object

Inherited from: \Zend_Pdf_Element::cleanUp()
methodpublicclear( ) : void

Clear stream

methodpublicgetParentObject( ) : \Zend_Pdf_Element_Object

Get top level parent indirect object.

Inherited from: \Zend_Pdf_Element::getParentObject()
Returns
Type Description
\Zend_Pdf_Element_Object
methodpublicgetType( ) : integer

Return type of the element.

See ZPdfPDFConst for possible values

Returns
Type Description
integer
methodpubliclength( ) : integer

Stream length.

(Method is used to avoid string copying, which may occurs in some cases)

Returns
Type Description
integer
methodpublicmakeClone( \Zend_Pdf_ElementFactory $factory, array $processed, integer $mode ) : void

Detach PDF object from the factory (if applicable), clone it and attach to new factory.

Parameters
Name Type Description
$factory \Zend_Pdf_ElementFactory The factory to attach
$processed array

&$processed List of already processed indirect objects, used to avoid objects duplication

$mode integer

Cloning mode (defines filter for objects cloning)

Details
returns
Zend_Pdf_Element  
methodpublicphpToPdf( mixed $input ) : \Zend_Pdf_Element
static

Convert PHP value into PDF element.

Inherited from: \Zend_Pdf_Element::phpToPdf()
Parameters
Name Type Description
$input mixed
Returns
Type Description
\Zend_Pdf_Element
methodpublicsetParentObject( \Zend_Pdf_Element_Object $parent ) : void

Set top level parent indirect object.

Inherited from: \Zend_Pdf_Element::setParentObject()
Parameters
Name Type Description
$parent \Zend_Pdf_Element_Object
methodpublictoPhp( ) : mixed

Convert PDF element to PHP type.

Inherited from: \Zend_Pdf_Element::toPhp()
Returns
Type Description
mixed
methodpublictoString( \Zend_Pdf_Factory $factory = null ) : string

Return object as string

$factory parameter defines operation context.

Parameters
Name Type Description
$factory \Zend_Pdf_Factory
Returns
Type Description
string
methodpublictouch( ) : void

Mark object as modified, to include it into new PDF file segment.

Inherited from: \Zend_Pdf_Element::touch()

We don't automate this action to keep control on PDF update process. All new objects are treated as "modified" automatically.

Documentation was generated by DocBlox 0.13.3.