Pdf/Resource/ContentStream.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 [email protected] 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  
Version
$Id: Image.php 20096 2010-01-06 02:05:09Z bkarwin $  

\Zend_Pdf_Resource_ContentStream

Package: Zend\Pdf

Content stream (drawing instructions container)

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

Properties

Propertyprotectedstring $_bufferedContent = ''

Buffered content

Default value''Details
Type
string
Propertyprotected\Zend_Pdf_ElementFactory_Interface $_objectFactory =
inherited

Each Pdf resource (fonts, images, .

Inherited from: \Zend_Pdf_Resource::$$_objectFactory

..) interacts with a PDF itself. It creates appropriate PDF objects, structures and sometime embedded files. Resources are referenced in content streams by names, which are stored in a page resource dictionaries.

Thus, resources must be attached to the PDF.

Resource abstraction uses own PDF object factory to store all necessary information. At the render time internal object factory is appended to the global PDF file factory.

Resource abstraction also cashes information about rendered PDF files and doesn't duplicate resource description each time then Resource is rendered (referenced).

Details
Type
\Zend_Pdf_ElementFactory_Interface
Inherited_from
\Zend_Pdf_Resource::$$_objectFactory  
Propertyprotected\Zend_Pdf_Element_Object $_resource =
inherited

Main resource object

Inherited from: \Zend_Pdf_Resource::$$_resource

Methods

methodpublic__clone() : void
inherited

Clone page, extract it and dependent objects from the current document, so it can be used within other docs.

Inherited from: \Zend_Pdf_Resource::__clone()
methodpublic__construct(\Zend_Pdf_Element_Object_Stream | string $contentStreamObject = '') : void

Object constructor.

If resource is not a Zend_Pdf_Element object, then stream object with specified value is generated.

Parameters
Name Type Description
$contentStreamObject \Zend_Pdf_Element_Object_Stream | string
Throws
Exception Description
\Zend_Pdf_Exception
methodpublicaddInstructions(string $instructions) : \Zend_Pdf_Resource_ContentStream

Appends instructions to the end of the content stream

Parameters
Name Type Description
$instructions string
Returns
Type Description
\Zend_Pdf_Resource_ContentStream
methodpublicclear() : \Zend_Pdf_Resource_ContentStream

Clear stream content.

Returns
Type Description
\Zend_Pdf_Resource_ContentStream
methodpublicflush() : void

Flush buffered content

methodpublicgetInstructions() : string

Get current stream content

Returns
Type Description
string
Documentation was generated by phpDocumentor 2.0.0a8.