Documentation

StructuredReference
in package
implements Operand, Stringable

FinalYes

Table of Contents

Interfaces

Operand
Stringable

Constants

NAME  = 'Structured Reference'
CLOSE_BRACE  = ']'
ITEM_SPECIFIER_ALL  = '#All'
ITEM_SPECIFIER_DATA  = '#Data'
ITEM_SPECIFIER_HEADERS  = '#Headers'
ITEM_SPECIFIER_ROWS_SET  = [self::ITEM_SPECIFIER_ALL, self::ITEM_SPECIFIER_HEADERS, self::ITEM_SPECIFIER_DATA, self::ITEM_SPECIFIER_TOTALS]
ITEM_SPECIFIER_THIS_ROW  = '#This Row'
ITEM_SPECIFIER_TOTALS  = '#Totals'
OPEN_BRACE  = '['
TABLE_REFERENCE  = '/([\p{L}_\\\\][\p{L}\p{N}\._]+)?(\[(?:[^\]\[]+|(?R))*+\])/miu'

Properties

$columns  : array<string|int, mixed>
$firstDataRow  : int
$headersRow  : int|null
$lastDataRow  : int
$reference  : string
$table  : Table
$tableName  : string
$totalsRow  : int|null
$value  : string

Methods

__construct()  : mixed
__toString()  : string
fromParser()  : self
parse()  : string
value()  : string
adjustRowReference()  : string
fullData()  : string
getColumnReference()  : string
getColumns()  : array<string|int, mixed>
getColumnsForColumnReference()  : string
getMaximumRow()  : int
getMinimumRow()  : int
getRowReference()  : string
getRowsForColumnReference()  : array<int, int>
getTableByName()  : Table
getTableForCell()  : Table
getTableStructure()  : void
isRowReference()  : bool
validateParsedReference()  : string

Constants

ITEM_SPECIFIER_ROWS_SET

private mixed ITEM_SPECIFIER_ROWS_SET = [self::ITEM_SPECIFIER_ALL, self::ITEM_SPECIFIER_HEADERS, self::ITEM_SPECIFIER_DATA, self::ITEM_SPECIFIER_TOTALS]

TABLE_REFERENCE

private mixed TABLE_REFERENCE = '/([\p{L}_\\\\][\p{L}\p{N}\._]+)?(\[(?:[^\]\[]+|(?R))*+\])/miu'

Properties

Methods

__construct()

public __construct(string $structuredReference) : mixed
Parameters
$structuredReference : string

fromParser()

public static fromParser(string $formula, int $index, array<string|int, string> $matches) : self
Parameters
$formula : string
$index : int
$matches : array<string|int, string>
Return values
self

adjustRowReference()

private adjustRowReference(string $columnName, string $reference, Cell $cell, string $columnId) : string
Parameters
$columnName : string
$reference : string
$cell : Cell
$columnId : string
Return values
string

fullData()

private fullData(int $startRow, int $endRow) : string
Parameters
$startRow : int
$endRow : int
Return values
string

getColumns()

private getColumns(Cell $cell, array<string|int, array<string|int, int|string>> $tableRange) : array<string|int, mixed>
Parameters
$cell : Cell
$tableRange : array<string|int, array<string|int, int|string>>
Return values
array<string|int, mixed>

getColumnsForColumnReference()

private getColumnsForColumnReference(string $reference, int $startRow, int $endRow) : string
Parameters
$reference : string
$startRow : int
$endRow : int
Return values
string

getMaximumRow()

private getMaximumRow(string $reference) : int
Parameters
$reference : string
Return values
int

getMinimumRow()

private getMinimumRow(string $reference) : int
Parameters
$reference : string
Return values
int

getRowsForColumnReference()

private getRowsForColumnReference(string &$reference, int $startRow, int $endRow) : array<int, int>
Parameters
$reference : string
$startRow : int
$endRow : int
Return values
array<int, int>

validateParsedReference()

private validateParsedReference(string $reference) : string
Parameters
$reference : string
Tags
throws
Exception
throws
Exception
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results