Multimag  0.2.992
Открытые члены | Поля данных
Класс workbook
Граф наследования:workbook:
writerHelper

Открытые члены

 __construct ($filename='')
 
 close ()
 
 sheets ()
 
 worksheets ()
 
 setVersion ($version)
 
 setCountry ($code)
 
addWorksheet ($name= '')
 
addFormat ($properties=array())
 
addValidator ()
 
 setCustomColor ($index, $red, $green, $blue)
 
 _setPaletteXl97 ()
 
 _storeWorkbook ()
 
 _storeOLEFile ()
 
 _calcSheetOffsets ()
 
 _storeAllFonts ()
 
 _storeAllNumFormats ()
 
 _storeAllXfs ()
 
 _storeAllStyles ()
 
 _storeExterns ()
 
 _storeNames ()
 
 _storeCodepage ()
 
 _storeWindow1 ()
 
 _storeBoundsheet ($sheetname, $offset)
 
 _storeSupbookInternal ()
 
 _storeExternsheetBiff8 ()
 
 _storeStyle ()
 
 _storeNumFormat ($format, $ifmt)
 
 _storeDatemode ()
 
 _storeExterncount ($cxals)
 
 _storeExternsheet ($sheetname)
 
 _storeNameShort ($index, $type, $rowmin, $rowmax, $colmin, $colmax)
 
 _storeNameLong ($index, $type, $rowmin, $rowmax, $colmin, $colmax)
 
 _storeCountry ()
 
 _storePalette ()
 
 _calculateSharedStringsSizes ()
 
 _storeSharedStringsTable ()
 

Поля данных

 $_filename
 
 $_parser
 
 $_1904
 
 $_activesheet
 
 $_firstsheet
 
 $_selected
 
 $_xf_index
 
 $_fileclosed
 
 $_biffsize
 
 $_sheetname
 
 $_tmp_format
 
 $_worksheets
 
 $_sheetnames
 
 $_formats
 
 $_palette
 
 $_url_format
 
 $_codepage
 
 $_country_code
 
 $_string_sizeinfo_size
 

Подробное описание

См. определение в файле workbook.php строка 56

Конструктор(ы)

__construct (   $filename = '')

Class constructor

Аргументы
stringfilename for storing the workbook. "-" for writing to stdout. public

См. определение в файле workbook.php строка 179

Методы

_calcSheetOffsets ( )

Calculate offsets for Worksheet BOF records.

private

См. определение в файле workbook.php строка 607

_calculateSharedStringsSizes ( )

Calculate Handling of the SST continue blocks is complicated by the need to include an additional continuation byte depending on whether the string is split between blocks or whether it starts at the beginning of the block. (There are also additional complications that will arise later when/if Rich Strings are supported).

private

См. определение в файле workbook.php строка 1294

_setPaletteXl97 ( )

Sets the colour palette to the Excel 97+ default.

private

См. определение в файле workbook.php строка 422

_storeAllFonts ( )

Store the Excel FONT records.

private

См. определение в файле workbook.php строка 646

_storeAllNumFormats ( )

Store user defined numerical formats i.e. FORMAT records

private

См. определение в файле workbook.php строка 690

_storeAllStyles ( )

Write all STYLE records.

private

См. определение в файле workbook.php строка 765

_storeAllXfs ( )

Write all XF records.

private

См. определение в файле workbook.php строка 738

_storeBoundsheet (   $sheetname,
  $offset 
)

Writes Excel BIFF BOUNDSHEET record. FIXME: inconsistent with BIFF documentation

Аргументы
string$sheetnameWorksheet name
integer$offsetLocation of worksheet BOF private

См. определение в файле workbook.php строка 922

_storeCodepage ( )

Stores the CODEPAGE biff record.

private

См. определение в файле workbook.php строка 872

_storeCountry ( )

Stores the COUNTRY record for localization

private

См. определение в файле workbook.php строка 1248

_storeDatemode ( )

Write DATEMODE record to indicate the date system in use (1904 or 1900).

private

См. определение в файле workbook.php строка 1034

_storeExterncount (   $cxals)

Write BIFF record EXTERNCOUNT to indicate the number of external sheet references in the workbook.

Excel only stores references to external sheets that are used in NAME. The workbook NAME record is required to define the print area and the repeat rows and columns.

A similar method is used in Worksheet.php for a slightly different purpose.

Аргументы
integer$cxalsNumber of external references private

См. определение в файле workbook.php строка 1060

_storeExterns ( )

Write the EXTERNCOUNT and EXTERNSHEET records. These are used as indexes for the NAME records.

private

См. определение в файле workbook.php строка 776

_storeExternsheet (   $sheetname)

Writes the Excel BIFF EXTERNSHEET record. These references are used by formulas. NAME record is required to define the print area and the repeat rows and columns.

A similar method is used in Worksheet.php for a slightly different purpose.

Аргументы
string$sheetnameWorksheet name private

См. определение в файле workbook.php строка 1081

_storeExternsheetBiff8 ( )

Writes the Excel BIFF EXTERNSHEET record. These references are used by formulas.

Аргументы
string$sheetnameWorksheet name private

См. определение в файле workbook.php строка 965

_storeNameLong (   $index,
  $type,
  $rowmin,
  $rowmax,
  $colmin,
  $colmax 
)

Store the NAME record in the long format that is used for storing the repeat rows and columns when both are specified. This shares a lot of code with _storeNameShort() but we use a separate method to keep the code clean. Code abstraction for reuse can be carried too far, and I should know. ;-)

Аргументы
integer$indexSheet index
integer$typeBuilt-in name type
integer$rowminStart row
integer$rowmaxEnd row
integer$colminStart colum
integer$colmaxEnd column private

См. определение в файле workbook.php строка 1173

_storeNames ( )

Write the NAME record to define the print area and the repeat rows and cols.

private

См. определение в файле workbook.php строка 792

_storeNameShort (   $index,
  $type,
  $rowmin,
  $rowmax,
  $colmin,
  $colmax 
)

Store the NAME record in the short format that is used for storing the print area, repeat rows only and repeat columns only.

Аргументы
integer$indexSheet index
integer$typeBuilt-in name type
integer$rowminStart row
integer$rowmaxEnd row
integer$colminStart colum
integer$colmaxEnd column private

См. определение в файле workbook.php строка 1107

_storeNumFormat (   $format,
  $ifmt 
)

Writes Excel FORMAT record for non "built-in" numerical formats.

Аргументы
string$formatCustom format string
integer$ifmtFormat index code private

См. определение в файле workbook.php строка 1007

_storeOLEFile ( )

Store the workbook in an OLE container

private

Возвращает
mixed true on success. PEAR_Error on failure

См. определение в файле workbook.php строка 567

_storePalette ( )

Stores the PALETTE biff record.

private

См. определение в файле workbook.php строка 1264

_storeSharedStringsTable ( )

Write all of the workbooks strings into an indexed array. See the comments in _calculate_shared_string_sizes() for more information.

The Excel documentation says that the SST record should be followed by an EXTSST record. The EXTSST record is a hash table that is used to optimise access to SST. However, despite the documentation it doesn't seem to be required so we will ignore it.

private

См. определение в файле workbook.php строка 1440

_storeStyle ( )

Write Excel BIFF STYLE records.

private

См. определение в файле workbook.php строка 985

_storeSupbookInternal ( )

Write Internal SUPBOOK record

private

См. определение в файле workbook.php строка 948

_storeWindow1 ( )

Write Excel BIFF WINDOW1 record.

private

См. определение в файле workbook.php строка 889

_storeWorkbook ( )

Assemble worksheets into a workbook and send the BIFF data to an OLE storage.

private

Возвращает
mixed true on success. PEAR_Error on failure

См. определение в файле workbook.php строка 491

& addFormat (   $properties = array())

Add a new format to the Excel workbook. Also, pass any properties to the Format constructor.

public

Аргументы
array$propertiesarray with properties for initializing the format.
Возвращает
&Spreadsheet_Excel_Writer_Format reference to an Excel Format

См. определение в файле workbook.php строка 360

& addValidator ( )

Create new validator.

public

Возвращает
&Spreadsheet_Excel_Writer_Validator reference to a Validator

См. определение в файле workbook.php строка 374

& addWorksheet (   $name = '')

Add a new worksheet to the Excel workbook. If no name is given the name of the worksheet will be Sheeti$i, with $i in [1..].

public

Аргументы
string$namethe optional name of the worksheet
Возвращает
mixed reference to a worksheet object on success, PEAR_Error on failure

См. определение в файле workbook.php строка 314

close ( )

Calls finalization methods. This method should always be the last one to be called on every workbook

public

Возвращает
mixed true on success. PEAR_Error on failure

См. определение в файле workbook.php строка 217

setCountry (   $code)

Set the country identifier for the workbook

public

Аргументы
integer$codeIs the international calling country code for the chosen country.

См. определение в файле workbook.php строка 299

setCustomColor (   $index,
  $red,
  $green,
  $blue 
)

Change the RGB components of the elements in the colour palette.

public

Аргументы
integer$indexcolour index
integer$redred RGB value [0-255]
integer$greengreen RGB value [0-255]
integer$blueblue RGB value [0-255]
Возвращает
integer The palette index for the custom color

См. определение в файле workbook.php строка 389

setVersion (   $version)

Sets the BIFF version. This method exists just to access experimental functionality from BIFF8. It will be deprecated ! Only possible value is 8 (Excel 97/2000). For any other value it fails silently.

public

Аргументы
integer$versionThe BIFF version

См. определение в файле workbook.php строка 266

sheets ( )

An accessor for the _worksheets[] array Returns an array of the worksheet objects in a workbook It actually calls to worksheets()

public

См. также
worksheets()
Возвращает
array

См. определение в файле workbook.php строка 239

worksheets ( )

An accessor for the _worksheets[] array. Returns an array of the worksheet objects in a workbook

public

Возвращает
array

См. определение в файле workbook.php строка 251

Поля

$_1904

См. определение в файле workbook.php строка 73

$_activesheet

См. определение в файле workbook.php строка 79

$_biffsize

См. определение в файле workbook.php строка 111

$_codepage

См. определение в файле workbook.php строка 159

$_country_code

См. определение в файле workbook.php строка 165

$_fileclosed

См. определение в файле workbook.php строка 104

$_filename

См. определение в файле workbook.php строка 61

$_firstsheet

См. определение в файле workbook.php строка 85

$_formats

См. определение в файле workbook.php строка 141

$_palette

См. определение в файле workbook.php строка 147

$_parser

См. определение в файле workbook.php строка 67

$_selected

См. определение в файле workbook.php строка 91

$_sheetname

См. определение в файле workbook.php строка 117

$_sheetnames

См. определение в файле workbook.php строка 135

$_string_sizeinfo_size

См. определение в файле workbook.php строка 171

$_tmp_format

См. определение в файле workbook.php строка 123

$_url_format

См. определение в файле workbook.php строка 153

$_worksheets

См. определение в файле workbook.php строка 129

$_xf_index

См. определение в файле workbook.php строка 97


Объявления и описания членов класса находятся в файле: