Pdf/StringParser.php

Show: PublicProtectedPrivateinherited
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 license@zend.com 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: StringParser.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Pdf_StringParser
jump to top

Package: Zend\Pdf
PDF string parser
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprivate\Zend_Pdf_Element_Reference_Context $_context = null
Current reference context
Default valuenullDetails
Type
\Zend_Pdf_Element_Reference_Context
>VPropertyprivatearray $_elements = array()
Array of elements of the currently parsed object/trailer
Default valuearray()Details
Type
array
>VPropertyprivate\Zend_Pdf_ElementFactory_Interface $_objFactory = null
PDF objects factory.
Default valuenullDetails
Type
\Zend_Pdf_ElementFactory_Interface
>VPropertypublicstring $data = ''
Source PDF
Default value''Details
Type
string
>VPropertypublicinteger $offset = 0
Current position in a data
Default value0Details
Type
integer

Methods

methodpublic__construct( $source, \Zend_Pdf_ElementFactory_Interface $factory) : void

Object constructor

Note: PHP duplicates string, which is sent by value, only of it's updated. Thus we don't need to care about overhead

Parameters
NameTypeDescription
$source
$factory\Zend_Pdf_ElementFactory_Interface
methodprivate_readArray() : \Zend_Pdf_Element_Array

Read array PDF object Also reads trailing ']' from a pdf stream

Returns
TypeDescription
\Zend_Pdf_Element_Array
Throws
ExceptionDescription
\Zend_Pdf_Exception
methodprivate_readBinaryString() : \Zend_Pdf_Element_String_Binary

Read binary string PDF object Also reads trailing '>' from a pdf stream

Returns
TypeDescription
\Zend_Pdf_Element_String_Binary
Throws
ExceptionDescription
\Zend_Pdf_Exception
methodprivate_readDictionary() : \Zend_Pdf_Element_Dictionary

Read dictionary PDF object Also reads trailing '>>' from a pdf stream

Returns
TypeDescription
\Zend_Pdf_Element_Dictionary
Throws
ExceptionDescription
\Zend_Pdf_Exception
methodprivate_readNumeric(string $nextLexeme = null) : \Zend_Pdf_Element_Numeric

Read numeric PDF object

Parameters
NameTypeDescription
$nextLexemestring
Returns
TypeDescription
\Zend_Pdf_Element_Numeric
methodprivate_readReference(string $nextLexeme = null) : \Zend_Pdf_Element_Reference

Read reference PDF object

Parameters
NameTypeDescription
$nextLexemestring
Returns
TypeDescription
\Zend_Pdf_Element_Reference
methodprivate_readString() : \Zend_Pdf_Element_String

Read string PDF object Also reads trailing ')' from a pdf stream

Returns
TypeDescription
\Zend_Pdf_Element_String
Throws
ExceptionDescription
\Zend_Pdf_Exception
methodpubliccleanUp() : void

Clean up resources.

Clear current state to remove cyclic object references

methodpublicgetLength() : integer

Get length of source string

Returns
TypeDescription
integer
methodpublicgetObject(integer $offset, \Zend_Pdf_Element_Reference_Context $context) : \Zend_Pdf_Element_Object

Read inderect object from a PDF stream

Parameters
NameTypeDescription
$offsetinteger
$context\Zend_Pdf_Element_Reference_Context
Returns
TypeDescription
\Zend_Pdf_Element_Object
methodpublicgetString() : string

Get source string

Returns
TypeDescription
string
methodpublicisDelimiter(integer $chCode) : boolean
static

Character with code $chCode is a delimiter character

Parameters
NameTypeDescription
$chCodeinteger
Returns
TypeDescription
boolean
methodpublicisWhiteSpace(integer $chCode) : boolean
static

Character with code $chCode is white space

Parameters
NameTypeDescription
$chCodeinteger
Returns
TypeDescription
boolean
methodpublicparseIntFromStream(string $stream, integer $offset, integer $size) : integer
static

Parse integer value from a binary stream

Parameters
NameTypeDescription
$streamstring
$offsetinteger
$sizeinteger
Returns
TypeDescription
integer
methodpublicreadComment() : string

Read comment line

Returns
TypeDescription
string
methodpublicreadElement( $nextLexeme = null) : \Zend_Pdf_Element

Read elemental object from a PDF stream

Parameters
NameTypeDescription
$nextLexeme
Returns
TypeDescription
\Zend_Pdf_Element
Throws
ExceptionDescription
\Zend_Pdf_Exception
methodpublicreadLexeme() : string

Returns next lexeme from a pdf stream

Returns
TypeDescription
string
methodpublicsetContext(\Zend_Pdf_Element_Reference_Context $context) : void

Set current context

Parameters
NameTypeDescription
$context\Zend_Pdf_Element_Reference_Context
methodpublicskipComment() : void

Skip comment

methodpublicskipWhiteSpace(boolean $skipComment = true) : void

Skip white space

Parameters
NameTypeDescription
$skipCommentboolean
Documentation was generated by phpDocumentor 2.0.0a12.