API Documentation

Pdf/StringParser.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Pdf
version
$Id: StringParser.php 22312 2010-05-27 13:11:23Z padraic $
Classes
Zend_Pdf_StringParser

Description

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.

Zend_Pdf_StringParser
jump to top

copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Pdf
Properties
$data
$offset
$_context
$_elements
$_objFactory
Methods
cleanUp
isWhiteSpace
isDelimiter
skipWhiteSpace
skipComment
readComment
readLexeme
readElement
_readString
_readBinaryString
_readArray
_readDictionary
_readReference
_readNumeric
getObject
getLength
getString
parseIntFromStream
setContext
__construct

Description

PDF string parser

Properties

$_context
jump to class

Zend_Pdf_Element_Reference_Context $_context = 'null'

Current reference context

Details

$_context
Zend_Pdf_Element_Reference_Context
visibility
private
default
null
final
false
static
false

$_elements
jump to class

array $_elements = 'array'

Array of elements of the currently parsed object/trailer

Details

$_elements
array
visibility
private
default
array
final
false
static
false

$_objFactory
jump to class

Zend_Pdf_ElementFactory_Interface $_objFactory = 'null'

PDF objects factory.

Details

$_objFactory
Zend_Pdf_ElementFactory_Interface
visibility
private
default
null
final
false
static
false

$data
jump to class

string $data = ''

Source PDF

Details

$data
string
visibility
public
default
final
false
static
false

$offset
jump to class

integer $offset = '0'

Current position in a data

Details

$offset
integer
visibility
public
default
0
final
false
static
false

Methods

__construct
jump to class

__construct(  $source, Zend_Pdf_ElementFactory_Interface $factory ) :

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

Arguments
$source
$factory
Zend_Pdf_ElementFactory_Interface
Details
visibility
public
final
false
static
false

_readArray
jump to class

_readArray( ) : Zend_Pdf_Element_Array

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

Output
Zend_Pdf_Element_Array
Details
visibility
private
final
false
static
false
throws

_readBinaryString
jump to class

_readBinaryString( ) : Zend_Pdf_Element_String_Binary

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

Output
Zend_Pdf_Element_String_Binary
Details
visibility
private
final
false
static
false
throws

_readDictionary
jump to class

_readDictionary( ) : Zend_Pdf_Element_Dictionary

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

Output
Zend_Pdf_Element_Dictionary
Details
visibility
private
final
false
static
false
throws

_readNumeric
jump to class

_readNumeric( string $nextLexeme = null ) : Zend_Pdf_Element_Numeric

Read numeric PDF object

Arguments
$nextLexeme
string
Output
Zend_Pdf_Element_Numeric
Details
visibility
private
final
false
static
false

_readReference
jump to class

_readReference( string $nextLexeme = null ) : Zend_Pdf_Element_Reference

Read reference PDF object

Arguments
$nextLexeme
string
Output
Zend_Pdf_Element_Reference
Details
visibility
private
final
false
static
false

_readString
jump to class

_readString( ) : Zend_Pdf_Element_String

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

Output
Zend_Pdf_Element_String
Details
visibility
private
final
false
static
false
throws

cleanUp
jump to class

cleanUp( ) :

Clean up resources.

Clear current state to remove cyclic object references

Details
visibility
public
final
false
static
false

getLength
jump to class

getLength( ) : integer

Get length of source string

Output
integer
Details
visibility
public
final
false
static
false

getObject
jump to class

getObject( integer $offset, Zend_Pdf_Element_Reference_Context $context ) : Zend_Pdf_Element_Object

Read inderect object from a PDF stream

Arguments
$offset
integer
$context
Zend_Pdf_Element_Reference_Context
Output
Zend_Pdf_Element_Object
Details
visibility
public
final
false
static
false

getString
jump to class

getString( ) : string

Get source string

Output
string
Details
visibility
public
final
false
static
false

isDelimiter
jump to class

isDelimiter( integer $chCode ) : boolean

Character with code $chCode is a delimiter character

Arguments
$chCode
integer
Output
boolean
Details
visibility
public
final
false
static
true

isWhiteSpace
jump to class

isWhiteSpace( integer $chCode ) : boolean

Character with code $chCode is white space

Arguments
$chCode
integer
Output
boolean
Details
visibility
public
final
false
static
true

parseIntFromStream
jump to class

parseIntFromStream( string $stream, integer $offset, integer $size ) : integer

Parse integer value from a binary stream

Arguments
$stream
string
$offset
integer
$size
integer
Output
integer
Details
visibility
public
final
false
static
true

readComment
jump to class

readComment( ) : string

Read comment line

Output
string
Details
visibility
public
final
false
static
false

readElement
jump to class

readElement(  $nextLexeme = null ) : Zend_Pdf_Element

Read elemental object from a PDF stream

Arguments
$nextLexeme
Output
Zend_Pdf_Element
Details
visibility
public
final
false
static
false
throws

readLexeme
jump to class

readLexeme( ) : string

Returns next lexeme from a pdf stream

Output
string
Details
visibility
public
final
false
static
false

setContext
jump to class

setContext( Zend_Pdf_Element_Reference_Context $context ) :

Set current context

Arguments
$context
Zend_Pdf_Element_Reference_Context
Details
visibility
public
final
false
static
false

skipComment
jump to class

skipComment( ) :

Skip comment

Details
visibility
public
final
false
static
false

skipWhiteSpace
jump to class

skipWhiteSpace( boolean $skipComment = true ) :

Skip white space

Arguments
$skipComment
boolean
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.