OLE
[ class tree: OLE ] [ index: OLE ] [ all elements ]

Class: OLE

Source Location: /OLE-1.0.0RC2/OLE.php

Class Overview

PEAR
   |
   --OLE

OLE package base class.


Author(s):

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 50]
OLE package base class.


[ Top ]


Class Variables

$bbat =

[line 75]

Big Block Allocation Table
  • Var: (blockId => nextBlockId)

Type:   array


[ Top ]

$bigBlockSize =

[line 87]

Size of big blocks. This is usually 512.
  • Var: number of octets per block.

Type:   int


[ Top ]

$root =

[line 69]

Root directory of OLE container

Type:   OLE_PPS_Root


[ Top ]

$sbat =

[line 81]

Short Block Allocation Table
  • Var: (blockId => nextBlockId)

Type:   array


[ Top ]

$smallBlockSize =

[line 93]

Size of small blocks. This is usually 64.
  • Var: number of octets per block

Type:   int


[ Top ]



Method Detail

OLE (Constructor)   [line 99]

OLE OLE( )

Creates a new OLE object
  • Access: public

[ Top ]

Asc2Ucs   [line 478]

string Asc2Ucs( string $ascii)

Utility function to transform ASCII text to Unicode
  • Return: The string in Unicode
  • Access: public

Parameters:

string   $ascii   —  The ASCII string to transform

[ Top ]

getData   [line 440]

string getData( integer $index, integer $position, integer $length)

Gets data from a PPS If there is no PPS for the index given, it will return an empty string.

Parameters:

integer   $index   —  The index for the PPS
integer   $position   —  The position from which to start reading (relative to the PPS)
integer   $length   —  The amount of bytes to read (at most)

[ Top ]

getDataLength   [line 462]

integer getDataLength( integer $index)

Gets the data length from a PPS If there is no PPS for the index given, it will return 0.
  • Return: The amount of bytes in data the PPS has
  • Access: public

Parameters:

integer   $index   —  The index for the PPS

[ Top ]

getStream   [line 228]

resource getStream( int|PPS $blockIdOrPps)

Returns a stream for use with fread() etc. External callers should use OLE_PPS_File::getStream().
  • Return: read-only stream

Parameters:

int|PPS   $blockIdOrPps   —  block id or PPS

[ Top ]

isFile   [line 396]

bool isFile( integer $index)

Checks whether a PPS is a File PPS or not.

If there is no PPS for the index given, it will return false.

  • Return: true if it's a File PPS, false otherwise
  • Access: public

Parameters:

integer   $index   —  The index for the PPS

[ Top ]

isRoot   [line 411]

bool isRoot( integer $index)

Checks whether a PPS is a Root PPS or not.

If there is no PPS for the index given, it will return false.

  • Return: true if it's a Root PPS, false otherwise
  • Access: public

Parameters:

integer   $index   —  The index for the PPS.

[ Top ]

LocalDate2OLE   [line 496]

string LocalDate2OLE( [integer $date = null])

Utility function Returns a string for the OLE container with the date given
  • Return: The string for the OLE container
  • Access: public

Parameters:

integer   $date   —  A timestamp

[ Top ]

OLE2LocalDate   [line 541]

string OLE2LocalDate( integer $string)

Returns a timestamp from an OLE container's date
  • Return: The timestamp corresponding to the string
  • Access: public

Parameters:

integer   $string   —  A binary string with the encoded date

[ Top ]

ppsTotal   [line 424]

integer ppsTotal( )

Gives the total number of PPS's found in the OLE container.
  • Return: The total number of PPS's found in the OLE container
  • Access: public

[ Top ]

read   [line 122]

mixed read( string $file)

Reads an OLE container from the contents of the file given.
  • Return: true on success, PEAR_Error on failure
  • Access: public

Parameters:

string   $file   — 

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:47:10 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.