CellAddress
in package
implements
Stringable
Table of Contents
Interfaces
- Stringable
Properties
- $cellAddress : string
- $columnId : int
- $columnName : string
- $rowId : int
- $worksheet : Worksheet|null
Methods
- __construct() : mixed
- __destruct() : mixed
- __toString() : string
- The returned address string will contain the worksheet name as well, if available, (ie. if a Worksheet was provided to the constructor).
- cellAddress() : string
- The returned address string will contain just the column/row address, (even if a Worksheet was provided to the constructor).
- columnId() : int
- columnName() : string
- fromCellAddress() : self
- fromColumnAndRow() : self
- fromColumnRowArray() : self
- fullCellAddress() : string
- The returned address string will contain the worksheet name as well, if available, (ie. if a Worksheet was provided to the constructor).
- nextColumn() : self
- nextRow() : self
- previousColumn() : self
- previousRow() : self
- rowId() : int
- worksheet() : Worksheet|null
- validateColumnAndRow() : void
Properties
$cellAddress
protected
string
$cellAddress
$columnId
protected
int
$columnId
$columnName
protected
string
$columnName
= ''
$rowId
protected
int
$rowId
$worksheet
protected
Worksheet|null
$worksheet
Methods
__construct()
public
__construct(string $cellAddress[, Worksheet|null $worksheet = null ]) : mixed
Parameters
- $cellAddress : string
- $worksheet : Worksheet|null = null
__destruct()
public
__destruct() : mixed
__toString()
The returned address string will contain the worksheet name as well, if available, (ie. if a Worksheet was provided to the constructor).
public
__toString() : string
e.g. "'Mark''s Worksheet'!C5".
Return values
stringcellAddress()
The returned address string will contain just the column/row address, (even if a Worksheet was provided to the constructor).
public
cellAddress() : string
e.g. "C5".
Return values
stringcolumnId()
public
columnId() : int
Return values
intcolumnName()
public
columnName() : string
Return values
stringfromCellAddress()
public
static fromCellAddress(string $cellAddress[, Worksheet|null $worksheet = null ]) : self
Parameters
- $cellAddress : string
- $worksheet : Worksheet|null = null
Return values
selffromColumnAndRow()
public
static fromColumnAndRow(int|string $columnId, int|string $rowId[, Worksheet|null $worksheet = null ]) : self
Parameters
- $columnId : int|string
- $rowId : int|string
- $worksheet : Worksheet|null = null
Return values
selffromColumnRowArray()
public
static fromColumnRowArray(array<string|int, mixed> $array[, Worksheet|null $worksheet = null ]) : self
Parameters
- $array : array<string|int, mixed>
- $worksheet : Worksheet|null = null
Return values
selffullCellAddress()
The returned address string will contain the worksheet name as well, if available, (ie. if a Worksheet was provided to the constructor).
public
fullCellAddress() : string
e.g. "'Mark''s Worksheet'!C5".
Return values
stringnextColumn()
public
nextColumn([int $offset = 1 ]) : self
Parameters
- $offset : int = 1
Return values
selfnextRow()
public
nextRow([int $offset = 1 ]) : self
Parameters
- $offset : int = 1
Return values
selfpreviousColumn()
public
previousColumn([int $offset = 1 ]) : self
Parameters
- $offset : int = 1
Return values
selfpreviousRow()
public
previousRow([int $offset = 1 ]) : self
Parameters
- $offset : int = 1
Return values
selfrowId()
public
rowId() : int
Return values
intworksheet()
public
worksheet() : Worksheet|null
Return values
Worksheet|nullvalidateColumnAndRow()
private
static validateColumnAndRow(int|string $columnId, int|string $rowId) : void
Parameters
- $columnId : int|string
- $rowId : int|string