Documentation

FragmentFinder
in package

EXPERIMENTAL WARNING! This class implementation will change in the next major point release.

Tags
phpstan-type

selection array{selection:string, start:int<-1, max>, end:?int, length:int, columns:array}

experimental

Table of Contents

Constants

REGEXP_CELLS_SELECTION  = '/^(?<csr>\d+),(?<csc>\d+)(-(?<end>((?<cer>\d+),(?<cec>\d+))|\*))?$/'
REGEXP_ROWS_COLUMNS_SELECTION  = '/^(?<start>\d+)(-(?<end>\d+|\*))?$/'
REGEXP_URI_FRAGMENT  = ',^(?<type>row|cell|col)=(?<selections>.*)$,i'
TYPE_COLUMN  = 'col'
TYPE_ROW  = 'row'
TYPE_UNKNOWN  = 'unknown'

Methods

create()  : self
DEPRECATION WARNING! This method will be removed in the next major point release.
findAll()  : iterable<int, TabularDataReader>
EXPERIMENTAL WARNING! This method implementation will change in the next major point release.
findFirst()  : TabularDataReader|null
EXPERIMENTAL WARNING! This method implementation will change in the next major point release.
findFirstOrFail()  : TabularDataReader
EXPERIMENTAL WARNING! This method implementation will change in the next major point release.
find()  : array<int, TabularDataReader>
parseCellSelection()  : selection
parseColumnSelection()  : selection
parseExpression()  : array<string|int, mixed>
parseRowColumnSelection()  : array{int<-1, max>, int|null|"*"}
parseRowSelection()  : selection
tabularData()  : TabularData

Constants

REGEXP_CELLS_SELECTION

private mixed REGEXP_CELLS_SELECTION = '/^(?<csr>\d+),(?<csc>\d+)(-(?<end>((?<cer>\d+),(?<cec>\d+))|\*))?$/'

REGEXP_ROWS_COLUMNS_SELECTION

private mixed REGEXP_ROWS_COLUMNS_SELECTION = '/^(?<start>\d+)(-(?<end>\d+|\*))?$/'

REGEXP_URI_FRAGMENT

private mixed REGEXP_URI_FRAGMENT = ',^(?<type>row|cell|col)=(?<selections>.*)$,i'

Methods

create()

DEPRECATION WARNING! This method will be removed in the next major point release.

public static create() : self

Since version 9.22.0

use League\Csv\FragmentFinder::__construct()

Tags
see
FragmentFinder::__construct()
codeCoverageIgnore

Returns a new instance.

Return values
self

findAll()

EXPERIMENTAL WARNING! This method implementation will change in the next major point release.

public findAll(string $expression, TabularData|TabularDataProvider $tabularData) : iterable<int, TabularDataReader>

Extract all found fragment identifiers for the specifield tabular data

Parameters
$expression : string
$tabularData : TabularData|TabularDataProvider
Tags
experimental

since version 9.12.0

throws
SyntaxError
Return values
iterable<int, TabularDataReader>

findFirstOrFail()

EXPERIMENTAL WARNING! This method implementation will change in the next major point release.

public findFirstOrFail(string $expression, TabularData|TabularDataProvider $tabularData) : TabularDataReader

Extract the first found fragment identifier of the tabular data or fail

Parameters
$expression : string
$tabularData : TabularData|TabularDataProvider
Tags
experimental

since version 9.12.0

throws
SyntaxError
throws
FragmentNotFound

if the expression can not be parsed

Return values
TabularDataReader

parseCellSelection()

private parseCellSelection(string $selection, TabularData $tabularData) : selection
Parameters
$selection : string
$tabularData : TabularData
Return values
selection

parseColumnSelection()

private parseColumnSelection(string $selection, TabularData $tabularData) : selection
Parameters
$selection : string
$tabularData : TabularData
Return values
selection

parseExpression()

private parseExpression(string $expression, TabularData $tabularData) : array<string|int, mixed>
Parameters
$expression : string
$tabularData : TabularData
Return values
array<string|int, mixed>

parseRowColumnSelection()

private parseRowColumnSelection(string $selection) : array{int<-1, max>, int|null|"*"}
Parameters
$selection : string
Return values
array{int<-1, max>, int|null|"*"}

parseRowSelection()

private parseRowSelection(string $selection) : selection
Parameters
$selection : string
Return values
selection 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results