PHP 클래스 Box\Spout\Writer\Common\Sheet

파일 보기 프로젝트 열기: box/spout 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$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