Documentation

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

Methods

__construct()

public __construct(string $cellAddress[, Worksheet|null $worksheet = null ]) : mixed
Parameters
$cellAddress : string
$worksheet : Worksheet|null = null

__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
string

cellAddress()

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
string

columnId()

public columnId() : int
Return values
int

columnName()

public columnName() : string
Return values
string

fromCellAddress()

public static fromCellAddress(string $cellAddress[, Worksheet|null $worksheet = null ]) : self
Parameters
$cellAddress : string
$worksheet : Worksheet|null = null
Return values
self

fromColumnAndRow()

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
self

fromColumnRowArray()

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
self

fullCellAddress()

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
string

nextColumn()

public nextColumn([int $offset = 1 ]) : self
Parameters
$offset : int = 1
Return values
self

nextRow()

public nextRow([int $offset = 1 ]) : self
Parameters
$offset : int = 1
Return values
self

previousColumn()

public previousColumn([int $offset = 1 ]) : self
Parameters
$offset : int = 1
Return values
self

previousRow()

public previousRow([int $offset = 1 ]) : self
Parameters
$offset : int = 1
Return values
self

validateColumnAndRow()

private static validateColumnAndRow(int|string $columnId, int|string $rowId) : void
Parameters
$columnId : int|string
$rowId : int|string
Tags
phpstan-assert

int|numeric-string $columnId

phpstan-assert

int|numeric-string $rowId


        
On this page

Search results