PHP Класс Box\Spout\Writer\Common\Sheet

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$SHEETS_NAME_USED Associative array [SHEET_INDEX] => [SHEET_NAME] keeping track of sheets' name to enforce uniqueness
$index Index of the sheet, based on order in the workbook (zero-based)
$name Name of the sheet
$stringHelper Box\Spout\Common\Helper\StringHelper

Открытые методы

Метод Описание
__construct ( integer $sheetIndex )
getIndex ( ) : integer
getName ( ) : string
setName ( string $name ) : Sheet 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

Защищенные методы

Метод Описание
doesContainInvalidCharacters ( string $name ) : boolean Returns whether the given name contains at least one invalid character.
doesStartOrEndWithSingleQuote ( string $name ) : boolean Returns whether the given name starts or ends with a single quote
isNameUnique ( string $name ) : boolean Returns whether the given name is unique.
throwIfNameIsInvalid ( string $name ) : void Throws an exception if the given sheet's name is not valid.

Описание методов

__construct() публичный Метод

public __construct ( integer $sheetIndex )
$sheetIndex integer Index of the sheet, based on order in the workbook (zero-based)

doesContainInvalidCharacters() защищенный Метод

Returns whether the given name contains at least one invalid character.
См. также: Sheet::$INVALID_CHARACTERS_IN_SHEET_NAME for the full list.
protected doesContainInvalidCharacters ( string $name ) : boolean
$name string
Результат boolean TRUE if the name contains invalid characters, FALSE otherwise.

doesStartOrEndWithSingleQuote() защищенный Метод

Returns whether the given name starts or ends with a single quote
protected doesStartOrEndWithSingleQuote ( string $name ) : boolean
$name string
Результат boolean TRUE if the name starts or ends with a single quote, FALSE otherwise.

getIndex() публичный Метод

public getIndex ( ) : integer
Результат integer Index of the sheet, based on order in the workbook (zero-based)

getName() публичный Метод

public getName ( ) : string
Результат string Name of the sheet

isNameUnique() защищенный Метод

Returns whether the given name is unique.
protected isNameUnique ( string $name ) : boolean
$name string
Результат boolean TRUE if the name is unique, FALSE otherwise.

setName() публичный Метод

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
public setName ( string $name ) : Sheet
$name string Name of the sheet
Результат Sheet

throwIfNameIsInvalid() защищенный Метод

Throws an exception if the given sheet's name is not valid.
См. также: Sheet::setName for validity rules.
protected throwIfNameIsInvalid ( string $name ) : void
$name string
Результат void

Описание свойств

$SHEETS_NAME_USED защищенное статическое свойство

Associative array [SHEET_INDEX] => [SHEET_NAME] keeping track of sheets' name to enforce uniqueness
protected static $SHEETS_NAME_USED

$index защищенное свойство

Index of the sheet, based on order in the workbook (zero-based)
protected $index

$name защищенное свойство

Name of the sheet
protected $name

$stringHelper защищенное свойство

protected StringHelper,Box\Spout\Common\Helper $stringHelper
Результат Box\Spout\Common\Helper\StringHelper