API Documentation

Pdf/Element/Object.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: Object.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Pdf_Element_Object

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_Element_Object
jump to top

Extends from
Zend_Pdf_Element
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
Properties
$_value
$_objNum
$_genNum
$_factory
Methods
__construct
getFactory
getType
getObjNum
getGenNum
toString
dump
__get
__set
__call
touch
getObject
cleanUp
toPhp

Description

PDF file 'indirect object' element implementation

Properties

$_factory
jump to class

Zend_Pdf_ElementFactory $_factory = ''

Reference to the factory.

Details

$_factory
Zend_Pdf_ElementFactory
visibility
protected
default
final
false
static
false

$_genNum
jump to class

integer $_genNum = ''

Generation number

Details

$_genNum
integer
visibility
protected
default
final
false
static
false

$_objNum
jump to class

integer $_objNum = ''

Object number within PDF file

Details

$_objNum
integer
visibility
protected
default
final
false
static
false

$_value
jump to class

Zend_Pdf_Element $_value = ''

Object value

Details

$_value
Zend_Pdf_Element
visibility
protected
default
final
false
static
false

Methods

__call
jump to class

__call( string $method, array $args ) : mixed

Call handler

Arguments
$method
string
$args
array
Output
mixed
Details
visibility
public
final
false
static
false

__construct
jump to class

__construct( Zend_Pdf_Element $val, integer $objNum, integer $genNum, Zend_Pdf_ElementFactory $factory ) :

Object constructor

Arguments
$val
Zend_Pdf_Element
$objNum
integer
$genNum
integer
$factory
Zend_Pdf_ElementFactory
Details
visibility
public
final
false
static
false
throws

__get
jump to class

__get( string $property ) : mixed

Get handler

Arguments
$property
string
Output
mixed
Details
visibility
public
final
false
static
false

__set
jump to class

__set( string $property, mixed $value ) :

Set handler

Arguments
$property
string
$value
mixed
Details
visibility
public
final
false
static
false

cleanUp
jump to class

cleanUp( ) :

Clean up resources, used by object

Details
visibility
public
final
false
static
false

dump
jump to class

dump( Zend_Pdf_ElementFactory $factory ) : string

Dump object to a string to save within PDF file.

$factory parameter defines operation context.

Arguments
$factory
Zend_Pdf_ElementFactory
Output
string
Details
visibility
public
final
false
static
false

getFactory
jump to class

getFactory( ) : Zend_Pdf_ElementFactory

Check, that object is generated by specified factory

Output
Zend_Pdf_ElementFactory
Details
visibility
public
final
false
static
false

getGenNum
jump to class

getGenNum( ) : integer

Get generation number

Output
integer
Details
visibility
public
final
false
static
false

getObjNum
jump to class

getObjNum( ) : integer

Get object number

Output
integer
Details
visibility
public
final
false
static
false

getObject
jump to class

getObject( ) : Zend_Pdf_Element_Object

Return object, which can be used to identify object and its references identity

Output
Zend_Pdf_Element_Object
Details
visibility
public
final
false
static
false

getType
jump to class

getType( ) : integer

Return type of the element.

Output
integer
Details
visibility
public
final
false
static
false

toPhp
jump to class

toPhp( ) : mixed

Convert PDF element to PHP type.

Output
mixed
Details
visibility
public
final
false
static
false

toString
jump to class

toString( Zend_Pdf_Factory $factory = null ) : string

Return reference to the object

Arguments
$factory
Zend_Pdf_Factory
Output
string
Details
visibility
public
final
false
static
false

touch
jump to class

touch( ) :

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

Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.