Documentation

Escher
in package

Table of Contents

Constants

BLIPJPEG  = 0xf01d
BLIPPNG  = 0xf01e
BSE  = 0xf007
BSTORECONTAINER  = 0xf001
CLIENTANCHOR  = 0xf010
CLIENTDATA  = 0xf011
CLIENTTEXTBOX  = 0xf00d
DG  = 0xf008
DGCONTAINER  = 0xf002
DGG  = 0xf006
DGGCONTAINER  = 0xf000
OPT  = 0xf00b
SP  = 0xf00a
SPCONTAINER  = 0xf004
SPGR  = 0xf009
SPGRCONTAINER  = 0xf003
SPLITMENUCOLORS  = 0xf11e
TERTIARYOPT  = 0xf122
WHICH_ROUTINE  = [self::DGGCONTAINER => 'readDggContainer', self::DGG => 'readDgg', self::BSTORECONTAINER => 'readBstoreContainer', self::BSE => 'readBSE', self::BLIPJPEG => 'readBlipJPEG', self::BLIPPNG => 'readBlipPNG', self::OPT => 'readOPT', self::TERTIARYOPT => 'readTertiaryOPT', self::SPLITMENUCOLORS => 'readSplitMenuColors', self::DGCONTAINER => 'readDgContainer', self::DG => 'readDg', self::SPGRCONTAINER => 'readSpgrContainer', self::SPCONTAINER => 'readSpContainer', self::SPGR => 'readSpgr', self::SP => 'readSp', self::CLIENTTEXTBOX => 'readClientTextbox', self::CLIENTANCHOR => 'readClientAnchor', self::CLIENTDATA => 'readClientData']

Properties

$data  : string
Escher stream data (binary).
$dataSize  : int
Size in bytes of the Escher stream data.
$object  : BSE|BstoreContainer|DgContainer|DggContainer|Escher|SpContainer|SpgrContainer
The object to be returned by the reader. Modified during load.
$pos  : int
Current position of stream pointer in Escher stream data.

Methods

__construct()  : mixed
Create a new Escher instance.
load()  : BSE|BstoreContainer|DgContainer|DggContainer|Escher|SpContainer|SpgrContainer
Load Escher stream data. May be a partial Escher stream.
applyAttribute()  : void
readBlipJPEG()  : void
Read BlipJPEG record. Holds raw JPEG image data.
readBlipPNG()  : void
Read BlipPNG record. Holds raw PNG image data.
readBSE()  : void
Read BSE record.
readBstoreContainer()  : void
Read BstoreContainer record (Blip Store Container).
readClientAnchor()  : void
Read ClientAnchor record. This record holds information about where the shape is anchored in worksheet.
readClientData()  : void
Read ClientData record.
readClientTextbox()  : void
Read ClientTextbox record.
readDefault()  : void
Read a generic record.
readDg()  : void
Read Dg record (Drawing).
readDgContainer()  : void
Read DgContainer record (Drawing Container).
readDgg()  : void
Read Dgg record (Drawing Group).
readDggContainer()  : void
Read DggContainer record (Drawing Group Container).
readOfficeArtRGFOPTE()  : void
Read OfficeArtRGFOPTE table of property-value pairs.
readOPT()  : void
Read OPT record. This record may occur within DggContainer record or SpContainer.
readSp()  : void
Read Sp record (Shape).
readSpContainer()  : void
Read SpContainer record (Shape Container).
readSpgr()  : void
Read Spgr record (Shape Group).
readSpgrContainer()  : void
Read SpgrContainer record (Shape Group Container).
readSplitMenuColors()  : void
Read SplitMenuColors record.
readTertiaryOPT()  : void
Read TertiaryOPT record.

Constants

BLIPJPEG

public mixed BLIPJPEG = 0xf01d

BLIPPNG

public mixed BLIPPNG = 0xf01e

BSTORECONTAINER

public mixed BSTORECONTAINER = 0xf001

CLIENTANCHOR

public mixed CLIENTANCHOR = 0xf010

CLIENTDATA

public mixed CLIENTDATA = 0xf011

CLIENTTEXTBOX

public mixed CLIENTTEXTBOX = 0xf00d

DGCONTAINER

public mixed DGCONTAINER = 0xf002

DGGCONTAINER

public mixed DGGCONTAINER = 0xf000

SPCONTAINER

public mixed SPCONTAINER = 0xf004

SPGRCONTAINER

public mixed SPGRCONTAINER = 0xf003

SPLITMENUCOLORS

public mixed SPLITMENUCOLORS = 0xf11e

TERTIARYOPT

public mixed TERTIARYOPT = 0xf122

WHICH_ROUTINE

private mixed WHICH_ROUTINE = [self::DGGCONTAINER => 'readDggContainer', self::DGG => 'readDgg', self::BSTORECONTAINER => 'readBstoreContainer', self::BSE => 'readBSE', self::BLIPJPEG => 'readBlipJPEG', self::BLIPPNG => 'readBlipPNG', self::OPT => 'readOPT', self::TERTIARYOPT => 'readTertiaryOPT', self::SPLITMENUCOLORS => 'readSplitMenuColors', self::DGCONTAINER => 'readDgContainer', self::DG => 'readDg', self::SPGRCONTAINER => 'readSpgrContainer', self::SPCONTAINER => 'readSpContainer', self::SPGR => 'readSpgr', self::SP => 'readSp', self::CLIENTTEXTBOX => 'readClientTextbox', self::CLIENTANCHOR => 'readClientAnchor', self::CLIENTDATA => 'readClientData']

Properties

$data

Escher stream data (binary).

private string $data

$dataSize

Size in bytes of the Escher stream data.

private int $dataSize

$pos

Current position of stream pointer in Escher stream data.

private int $pos

Methods

applyAttribute()

private applyAttribute(string $name, mixed $value) : void
Parameters
$name : string
$value : mixed

readBlipJPEG()

Read BlipJPEG record. Holds raw JPEG image data.

private readBlipJPEG() : void

readBlipPNG()

Read BlipPNG record. Holds raw PNG image data.

private readBlipPNG() : void

readBSE()

Read BSE record.

private readBSE() : void

readBstoreContainer()

Read BstoreContainer record (Blip Store Container).

private readBstoreContainer() : void

readClientAnchor()

Read ClientAnchor record. This record holds information about where the shape is anchored in worksheet.

private readClientAnchor() : void

readClientData()

Read ClientData record.

private readClientData() : void

readClientTextbox()

Read ClientTextbox record.

private readClientTextbox() : void

readDefault()

Read a generic record.

private readDefault() : void

readDg()

Read Dg record (Drawing).

private readDg() : void

readDgContainer()

Read DgContainer record (Drawing Container).

private readDgContainer() : void

readDgg()

Read Dgg record (Drawing Group).

private readDgg() : void

readDggContainer()

Read DggContainer record (Drawing Group Container).

private readDggContainer() : void

readOfficeArtRGFOPTE()

Read OfficeArtRGFOPTE table of property-value pairs.

private readOfficeArtRGFOPTE(string $data, int $n) : void
Parameters
$data : string

Binary data

$n : int

Number of properties

readOPT()

Read OPT record. This record may occur within DggContainer record or SpContainer.

private readOPT() : void

readSp()

Read Sp record (Shape).

private readSp() : void

readSpContainer()

Read SpContainer record (Shape Container).

private readSpContainer() : void

readSpgr()

Read Spgr record (Shape Group).

private readSpgr() : void

readSpgrContainer()

Read SpgrContainer record (Shape Group Container).

private readSpgrContainer() : void

readSplitMenuColors()

Read SplitMenuColors record.

private readSplitMenuColors() : void

readTertiaryOPT()

Read TertiaryOPT record.

private readTertiaryOPT() : void 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results