Column
in package
Table of Contents
Methods
- __construct() : mixed
- Create a new column.
- __destruct() : mixed
- Destructor.
- getCellIterator() : ColumnCellIterator
- Get cell iterator.
- getColumnIndex() : string
- Get column index as string eg: 'A'.
- getRowIterator() : ColumnCellIterator
- Get row iterator. Synonym for getCellIterator().
- getWorksheet() : Worksheet
- Returns bound worksheet.
- isEmpty() : bool
- Returns a boolean true if the column contains no cells. By default, this means that no cell records exist in the collection for this column. false will be returned otherwise.
Methods
__construct()
Create a new column.
public
__construct(Worksheet $worksheet[, string $columnIndex = 'A' ]) : mixed
Parameters
- $worksheet : Worksheet
- $columnIndex : string = 'A'
__destruct()
Destructor.
public
__destruct() : mixed
getCellIterator()
Get cell iterator.
public
getCellIterator([int $startRow = 1 ][, int|null $endRow = null ][, bool $iterateOnlyExistingCells = false ]) : ColumnCellIterator
Parameters
- $startRow : int = 1
-
The row number at which to start iterating
- $endRow : int|null = null
-
Optionally, the row number at which to stop iterating
- $iterateOnlyExistingCells : bool = false
Return values
ColumnCellIteratorgetColumnIndex()
Get column index as string eg: 'A'.
public
getColumnIndex() : string
Return values
stringgetRowIterator()
Get row iterator. Synonym for getCellIterator().
public
getRowIterator([int $startRow = 1 ][, int|null $endRow = null ][, bool $iterateOnlyExistingCells = false ]) : ColumnCellIterator
Parameters
- $startRow : int = 1
-
The row number at which to start iterating
- $endRow : int|null = null
-
Optionally, the row number at which to stop iterating
- $iterateOnlyExistingCells : bool = false
Return values
ColumnCellIteratorgetWorksheet()
Returns bound worksheet.
public
getWorksheet() : Worksheet
Return values
WorksheetisEmpty()
Returns a boolean true if the column contains no cells. By default, this means that no cell records exist in the collection for this column. false will be returned otherwise.
public
isEmpty([int $definitionOfEmptyFlags = 0 ][, int $startRow = 1 ][, int|null $endRow = null ]) : bool
This rule can be modified by passing a $definitionOfEmptyFlags value: 1 - CellIterator::TREAT_NULL_VALUE_AS_EMPTY_CELL If the only cells in the collection are null value cells, then the column will be considered empty. 2 - CellIterator::TREAT_EMPTY_STRING_AS_EMPTY_CELL If the only cells in the collection are empty string value cells, then the column will be considered empty. 3 - CellIterator::TREAT_NULL_VALUE_AS_EMPTY_CELL | CellIterator::TREAT_EMPTY_STRING_AS_EMPTY_CELL If the only cells in the collection are null value or empty string value cells, then the column will be considered empty.
Parameters
- $definitionOfEmptyFlags : int = 0
-
Possible Flag Values are: CellIterator::TREAT_NULL_VALUE_AS_EMPTY_CELL CellIterator::TREAT_EMPTY_STRING_AS_EMPTY_CELL
- $startRow : int = 1
-
The row number at which to start checking if cells are empty
- $endRow : int|null = null
-
Optionally, the row number at which to stop checking if cells are empty