PHP Class Pop\Pdf\Object\Object

Author: Nick Sagona, III ([email protected])
Mostra file Open project: nicksagona/PopPHP Class Usage Examples

Public Properties

Property Type Description
$index integer PDF object index

Protected Properties

Property Type Description
$compress boolean Compression property
$data string PDF object data
$def string PDF object definition
$isCompressed boolean Compressed flag property
$isPalette boolean Palette object property
$isXObject boolean XObject object property
$stream string PDF object stream

Public Methods

Method Description
__construct ( integer | string $i ) : Object Constructor
__toString ( ) : string Method to print the PDF object.
compress ( ) : void Method to compress the PDF object.
define ( string $str ) : void Method to define the PDF object.
getByteLength ( ) : integer Method to get the PDF object byte length.
getDef ( ) : string Method to return the PDF object definition.
getStream ( ) : string Method to return the PDF object stream.
isCompressed ( ) : boolean Method to determine whether or not the PDF object is compressed.
isPalette ( ) : boolean Method to get whether the PDF object is a palette object.
isXObject ( ) : boolean Method to get whether the PDF object is an XObject.
setPalette ( boolean $is ) : void Method to set whether the PDF object is a palette object.
setStream ( string $str ) : void Method to set the stream the PDF object.

Protected Methods

Method Description
calcByteLength ( string $str ) : integer Method to calculate the byte length.

Method Details

__construct() public method

Instantiate a PDF object.
public __construct ( integer | string $i ) : Object
$i integer | string
return Object

__toString() public method

Method to print the PDF object.
public __toString ( ) : string
return string

calcByteLength() protected method

Method to calculate the byte length.
protected calcByteLength ( string $str ) : integer
$str string
return integer

compress() public method

Method to compress the PDF object.
public compress ( ) : void
return void

define() public method

Method to define the PDF object.
public define ( string $str ) : void
$str string
return void

getByteLength() public method

Method to get the PDF object byte length.
public getByteLength ( ) : integer
return integer

getDef() public method

Method to return the PDF object definition.
public getDef ( ) : string
return string

getStream() public method

Method to return the PDF object stream.
public getStream ( ) : string
return string

isCompressed() public method

Method to determine whether or not the PDF object is compressed.
public isCompressed ( ) : boolean
return boolean

isPalette() public method

Method to get whether the PDF object is a palette object.
public isPalette ( ) : boolean
return boolean

isXObject() public method

Method to get whether the PDF object is an XObject.
public isXObject ( ) : boolean
return boolean

setPalette() public method

Method to set whether the PDF object is a palette object.
public setPalette ( boolean $is ) : void
$is boolean
return void

setStream() public method

Method to set the stream the PDF object.
public setStream ( string $str ) : void
$str string
return void

Property Details

$compress protected_oe property

Compression property
protected bool $compress
return boolean

$data protected_oe property

PDF object data
protected string $data
return string

$def protected_oe property

PDF object definition
protected string $def
return string

$index public_oe property

PDF object index
public int $index
return integer

$isCompressed protected_oe property

Compressed flag property
protected bool $isCompressed
return boolean

$isPalette protected_oe property

Palette object property
protected bool $isPalette
return boolean

$isXObject protected_oe property

XObject object property
protected bool $isXObject
return boolean

$stream protected_oe property

PDF object stream
protected string $stream
return string