[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/lib/spout/src/Spout/Writer/Common/ -> Sheet.php (summary)

(no description)

File Size: 159 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Sheet:: (8 methods):
  __construct()
  getIndex()
  getName()
  setName()
  isNameValid()
  doesContainInvalidCharacters()
  doesStartOrEndWithSingleQuote()
  isNameUnique()


Class: Sheet  - X-Ref

Class Sheet
External representation of a worksheet within a ODS file

__construct($sheetIndex)   X-Ref

param: int $sheetIndex Index of the sheet, based on order in the workbook (zero-based)

getIndex()   X-Ref

return: int Index of the sheet, based on order in the workbook (zero-based)

getName()   X-Ref

return: string Name of the sheet

setName($name)   X-Ref
Sets the name of the sheet. Note that Excel has some restrictions on the name:
- it should not be blank
- it should not exceed 31 characters
- it should not contain these characters: \ / ? * : [ or ]
- it should be unique

param: string $name Name of the sheet
return: Sheet

isNameValid($name)   X-Ref
Returns whether the given sheet's name is valid.

param: string $name
return: bool TRUE if the name is valid, FALSE otherwise.

doesContainInvalidCharacters($name)   X-Ref
Returns whether the given name contains at least one invalid character.

param: string $name
return: bool TRUE if the name contains invalid characters, FALSE otherwise.

doesStartOrEndWithSingleQuote($name)   X-Ref
Returns whether the given name starts or ends with a single quote

param: string $name
return: bool TRUE if the name starts or ends with a single quote, FALSE otherwise.

isNameUnique($name)   X-Ref
Returns whether the given name is unique.

param: string $name
return: bool TRUE if the name is unique, FALSE otherwise.



Generated: Thu Aug 11 10:00:09 2016 Cross-referenced by PHPXref 0.7.1