|
ILIAS
release_5-4 Revision v5.4.26-12-gabc799a52e6
|
OLE package base class. More...
Collaboration diagram for PhpOffice\PhpSpreadsheet\Shared\OLE:Public Member Functions | |
| read ($file) | |
| Reads an OLE container from the contents of the file given. More... | |
| getBlockOffset ($blockId) | |
| getStream ($blockIdOrPps) | |
| Returns a stream for use with fread() etc. More... | |
| readPpsWks ($blockId) | |
| Gets information about all PPS's on the OLE container from the PPS WK's creates an OLE_PPS object for each one. More... | |
| isFile ($index) | |
| Checks whether a PPS is a File PPS or not. More... | |
| isRoot ($index) | |
| Checks whether a PPS is a Root PPS or not. More... | |
| ppsTotal () | |
| Gives the total number of PPS's found in the OLE container. More... | |
| getData ($index, $position, $length) | |
| Gets data from a PPS If there is no PPS for the index given, it will return an empty string. More... | |
| getDataLength ($index) | |
| Gets the data length from a PPS If there is no PPS for the index given, it will return 0. More... | |
Static Public Member Functions | |
| static | ascToUcs ($ascii) |
| Utility function to transform ASCII text to Unicode. More... | |
| static | localDateToOLE ($date) |
| Utility function Returns a string for the OLE container with the date given. More... | |
| static | OLE2LocalDate ($oleTimestamp) |
| Returns a timestamp from an OLE container's date. More... | |
Data Fields | |
| const | OLE_PPS_TYPE_ROOT = 5 |
| const | OLE_PPS_TYPE_DIR = 1 |
| const | OLE_PPS_TYPE_FILE = 2 |
| const | OLE_DATA_SIZE_SMALL = 0x1000 |
| const | OLE_LONG_INT_SIZE = 4 |
| const | OLE_PPS_SIZE = 0x80 |
| $_file_handle | |
| $_list = [] | |
| $root | |
| $bbat | |
| $sbat | |
| $bigBlockSize | |
| $smallBlockSize | |
| $bigBlockThreshold | |
Private Member Functions | |
| ppsTreeComplete ($index) | |
| It checks whether the PPS tree is complete (all PPS's read) starting with the given PPS (not necessarily root). More... | |
Static Private Member Functions | |
| static | readInt1 ($fh) |
| Reads a signed char. More... | |
| static | readInt2 ($fh) |
| Reads an unsigned short (2 octets). More... | |
| static | readInt4 ($fh) |
| Reads an unsigned long (4 octets). More... | |
|
static |
Utility function to transform ASCII text to Unicode.
| string | $ascii | The ASCII string to transform |
Definition at line 478 of file OLE.php.
References $i.
Referenced by PhpOffice\PhpSpreadsheet\Shared\OLE\PPS\Root\__construct(), and PhpOffice\PhpSpreadsheet\Writer\Xls\save().
Here is the caller graph for this function:| PhpOffice\PhpSpreadsheet\Shared\OLE::getBlockOffset | ( | $blockId | ) |
| int | $blockId | byte offset from beginning of file |
Definition at line 206 of file OLE.php.
References PhpOffice\PhpSpreadsheet\Shared\OLE\$bigBlockSize.
Referenced by PhpOffice\PhpSpreadsheet\Shared\OLE\read().
Here is the caller graph for this function:| PhpOffice\PhpSpreadsheet\Shared\OLE::getData | ( | $index, | |
| $position, | |||
| $length | |||
| ) |
Gets data from a PPS If there is no PPS for the index given, it will return an empty string.
| int | $index | The index for the PPS |
| int | $position | The position from which to start reading (relative to the PPS) |
| int | $length | The amount of bytes to read (at most) |
Definition at line 441 of file OLE.php.
References $data, $index, and PhpOffice\PhpSpreadsheet\Shared\OLE\getStream().
Here is the call graph for this function:| PhpOffice\PhpSpreadsheet\Shared\OLE::getDataLength | ( | $index | ) |
| PhpOffice\PhpSpreadsheet\Shared\OLE::getStream | ( | $blockIdOrPps | ) |
Returns a stream for use with fread() etc.
External callers should use \PhpOffice\PhpSpreadsheet\Shared\OLE\PPS\File::getStream().
| int | OLE\PPS | $blockIdOrPps | block id or PPS |
Definition at line 219 of file OLE.php.
References PhpOffice\PhpSpreadsheet\Shared\$GLOBALS, $keys, and $path.
Referenced by PhpOffice\PhpSpreadsheet\Shared\OLE\getData(), PhpOffice\PhpSpreadsheet\Shared\OLE\read(), and PhpOffice\PhpSpreadsheet\Shared\OLE\readPpsWks().
Here is the caller graph for this function:| PhpOffice\PhpSpreadsheet\Shared\OLE::isFile | ( | $index | ) |
Checks whether a PPS is a File PPS or not.
If there is no PPS for the index given, it will return false.
| int | $index | The index for the PPS |
Definition at line 392 of file OLE.php.
References $index, and PhpOffice\PhpSpreadsheet\Shared\OLE\OLE_PPS_TYPE_FILE.
| PhpOffice\PhpSpreadsheet\Shared\OLE::isRoot | ( | $index | ) |
Checks whether a PPS is a Root PPS or not.
If there is no PPS for the index given, it will return false.
| int | $index | the index for the PPS |
Definition at line 409 of file OLE.php.
References $index, and PhpOffice\PhpSpreadsheet\Shared\OLE\OLE_PPS_TYPE_ROOT.
|
static |
Utility function Returns a string for the OLE container with the date given.
| float | int | $date | A timestamp |
Definition at line 498 of file OLE.php.
Referenced by PhpOffice\PhpSpreadsheet\Shared\OLE\PPS\getPpsWk(), and PhpOffice\PhpSpreadsheet\Writer\Xls\writeSummaryPropOle().
Here is the caller graph for this function:
|
static |
Returns a timestamp from an OLE container's date.
| string | $oleTimestamp | A binary string with the encoded date |
Definition at line 543 of file OLE.php.
References PhpOffice\PhpSpreadsheet\Shared\IntOrFloat\evaluate().
Referenced by PhpOffice\PhpSpreadsheet\Reader\Xls\readDocumentSummaryInformation(), PhpOffice\PhpSpreadsheet\Shared\OLE\readPpsWks(), and PhpOffice\PhpSpreadsheet\Reader\Xls\readSummaryInformation().
Here is the call graph for this function:
Here is the caller graph for this function:| PhpOffice\PhpSpreadsheet\Shared\OLE::ppsTotal | ( | ) |
|
private |
It checks whether the PPS tree is complete (all PPS's read) starting with the given PPS (not necessarily root).
| int | $index | The index of the PPS from which we are checking |
Definition at line 372 of file OLE.php.
References $index.
Referenced by PhpOffice\PhpSpreadsheet\Shared\OLE\readPpsWks().
Here is the caller graph for this function:| PhpOffice\PhpSpreadsheet\Shared\OLE::read | ( | $file | ) |
Reads an OLE container from the contents of the file given.
@acces public
| string | $file |
Definition at line 117 of file OLE.php.
References $i, PhpOffice\PhpSpreadsheet\Shared\OLE\getBlockOffset(), PhpOffice\PhpSpreadsheet\Shared\OLE\getStream(), PhpOffice\PhpSpreadsheet\Shared\OLE\readInt2(), PhpOffice\PhpSpreadsheet\Shared\OLE\readInt4(), and PhpOffice\PhpSpreadsheet\Shared\OLE\readPpsWks().
Here is the call graph for this function:
|
staticprivate |
Reads a signed char.
| resource | $fh | file handle |
Definition at line 252 of file OLE.php.
Referenced by PhpOffice\PhpSpreadsheet\Shared\OLE\readPpsWks().
Here is the caller graph for this function:
|
staticprivate |
Reads an unsigned short (2 octets).
| resource | $fh | file handle |
Definition at line 266 of file OLE.php.
Referenced by PhpOffice\PhpSpreadsheet\Shared\OLE\read(), and PhpOffice\PhpSpreadsheet\Shared\OLE\readPpsWks().
Here is the caller graph for this function:
|
staticprivate |
Reads an unsigned long (4 octets).
| resource | $fh | file handle |
Definition at line 280 of file OLE.php.
Referenced by PhpOffice\PhpSpreadsheet\Shared\OLE\read(), and PhpOffice\PhpSpreadsheet\Shared\OLE\readPpsWks().
Here is the caller graph for this function:| PhpOffice\PhpSpreadsheet\Shared\OLE::readPpsWks | ( | $blockId | ) |
Gets information about all PPS's on the OLE container from the PPS WK's creates an OLE_PPS object for each one.
| int | $blockId | the block id of the first block |
Definition at line 295 of file OLE.php.
References $name, $type, PhpOffice\PhpSpreadsheet\Shared\OLE\getStream(), PhpOffice\PhpSpreadsheet\Shared\OLE\OLE2LocalDate(), PhpOffice\PhpSpreadsheet\Shared\OLE\OLE_PPS_TYPE_DIR, PhpOffice\PhpSpreadsheet\Shared\OLE\OLE_PPS_TYPE_FILE, PhpOffice\PhpSpreadsheet\Shared\OLE\OLE_PPS_TYPE_ROOT, PhpOffice\PhpSpreadsheet\Shared\OLE\ppsTreeComplete(), PhpOffice\PhpSpreadsheet\Shared\OLE\readInt1(), PhpOffice\PhpSpreadsheet\Shared\OLE\readInt2(), and PhpOffice\PhpSpreadsheet\Shared\OLE\readInt4().
Referenced by PhpOffice\PhpSpreadsheet\Shared\OLE\read().
Here is the call graph for this function:
Here is the caller graph for this function:| PhpOffice\PhpSpreadsheet\Shared\OLE::$bigBlockSize |
Definition at line 92 of file OLE.php.
Referenced by PhpOffice\PhpSpreadsheet\Shared\OLE\getBlockOffset().
| const PhpOffice\PhpSpreadsheet\Shared\OLE::OLE_DATA_SIZE_SMALL = 0x1000 |
Definition at line 48 of file OLE.php.
Referenced by PhpOffice\PhpSpreadsheet\Shared\OLE\PPS\Root\calcSize(), PhpOffice\PhpSpreadsheet\Shared\OLE\PPS\Root\makeSmallData(), and PhpOffice\PhpSpreadsheet\Shared\OLE\PPS\Root\saveBigData().
| const PhpOffice\PhpSpreadsheet\Shared\OLE::OLE_LONG_INT_SIZE = 4 |
| const PhpOffice\PhpSpreadsheet\Shared\OLE::OLE_PPS_SIZE = 0x80 |
Definition at line 50 of file OLE.php.
Referenced by PhpOffice\PhpSpreadsheet\Shared\OLE\PPS\Root\calcSize(), and PhpOffice\PhpSpreadsheet\Shared\OLE\PPS\Root\savePps().
| const PhpOffice\PhpSpreadsheet\Shared\OLE::OLE_PPS_TYPE_DIR = 1 |
Definition at line 46 of file OLE.php.
Referenced by PhpOffice\PhpSpreadsheet\Shared\OLE\readPpsWks(), and PhpOffice\PhpSpreadsheet\Shared\OLE\PPS\Root\saveBigData().
| const PhpOffice\PhpSpreadsheet\Shared\OLE::OLE_PPS_TYPE_FILE = 2 |
Definition at line 47 of file OLE.php.
Referenced by PhpOffice\PhpSpreadsheet\Shared\OLE\PPS\File\__construct(), PhpOffice\PhpSpreadsheet\Shared\OLE\PPS\Root\calcSize(), PhpOffice\PhpSpreadsheet\Shared\OLE\isFile(), PhpOffice\PhpSpreadsheet\Shared\OLE\PPS\Root\makeSmallData(), and PhpOffice\PhpSpreadsheet\Shared\OLE\readPpsWks().
| const PhpOffice\PhpSpreadsheet\Shared\OLE::OLE_PPS_TYPE_ROOT = 5 |
Definition at line 45 of file OLE.php.
Referenced by PhpOffice\PhpSpreadsheet\Shared\OLE\PPS\Root\__construct(), PhpOffice\PhpSpreadsheet\Shared\OLE\isRoot(), PhpOffice\PhpSpreadsheet\Shared\OLE\readPpsWks(), and PhpOffice\PhpSpreadsheet\Shared\OLE\PPS\Root\saveBigData().