PHP Class OpenSkill\Datatable\Queries\Parser\Datatable110QueryParser

Inheritance: extends OpenSkill\Datatable\Queries\Parser\QueryParser
Datei anzeigen Open project: openskill/datatable Class Usage Examples

Public Methods

Method Description
canParse ( Request $request ) : boolean Method to determine if this parser can handle the query parameters. If so then the parser should return true and be able to return a DTQueryConfiguration
getDrawCall ( Symfony\Component\HttpFoundation\ParameterBag $query, OpenSkill\Datatable\Queries\QueryConfigurationBuilder $builder )
getLength ( Symfony\Component\HttpFoundation\ParameterBag $query, OpenSkill\Datatable\Queries\QueryConfigurationBuilder $builder )
getRegex ( Symfony\Component\HttpFoundation\ParameterBag $query, OpenSkill\Datatable\Queries\QueryConfigurationBuilder $builder )
getSearch ( Symfony\Component\HttpFoundation\ParameterBag $query, OpenSkill\Datatable\Queries\QueryConfigurationBuilder $builder )
getSearchColumns ( Symfony\Component\HttpFoundation\ParameterBag $query, OpenSkill\Datatable\Queries\QueryConfigurationBuilder $builder, array $columnConfiguration )
getStart ( Symfony\Component\HttpFoundation\ParameterBag $query, OpenSkill\Datatable\Queries\QueryConfigurationBuilder $builder )
parse ( Request $request, array $columnConfiguration ) : OpenSkill\Datatable\Queries\QueryConfiguration Method that should parse the request and return a DTQueryConfiguration

Private Methods

Method Description
addColumnSearchToBuilderIfRequested ( array $columns, OpenSkill\Datatable\Queries\QueryConfigurationBuilder $builder, OpenSkill\Datatable\Columns\ColumnConfiguration $column, integer $position )
getOrder ( Symfony\Component\HttpFoundation\ParameterBag $query, OpenSkill\Datatable\Queries\QueryConfigurationBuilder $builder, array $columnConfiguration )
isArrayAndHasKey ( mixed $array, string $key ) : boolean Helper function that will check if an array key exists
isEmpty ( mixed $string ) : boolean Helper function that will check if a variable is empty

Method Details

canParse() public method

Method to determine if this parser can handle the query parameters. If so then the parser should return true and be able to return a DTQueryConfiguration
public canParse ( Request $request ) : boolean
$request Symfony\Component\HttpFoundation\Request The current request, that should be investigated
return boolean true if the parser is able to parse the query parameters and to return a DTQueryConfiguration

getDrawCall() public method

public getDrawCall ( Symfony\Component\HttpFoundation\ParameterBag $query, OpenSkill\Datatable\Queries\QueryConfigurationBuilder $builder )
$query Symfony\Component\HttpFoundation\ParameterBag
$builder OpenSkill\Datatable\Queries\QueryConfigurationBuilder

getLength() public method

public getLength ( Symfony\Component\HttpFoundation\ParameterBag $query, OpenSkill\Datatable\Queries\QueryConfigurationBuilder $builder )
$query Symfony\Component\HttpFoundation\ParameterBag
$builder OpenSkill\Datatable\Queries\QueryConfigurationBuilder

getRegex() public method

public getRegex ( Symfony\Component\HttpFoundation\ParameterBag $query, OpenSkill\Datatable\Queries\QueryConfigurationBuilder $builder )
$query Symfony\Component\HttpFoundation\ParameterBag
$builder OpenSkill\Datatable\Queries\QueryConfigurationBuilder

getSearch() public method

public getSearch ( Symfony\Component\HttpFoundation\ParameterBag $query, OpenSkill\Datatable\Queries\QueryConfigurationBuilder $builder )
$query Symfony\Component\HttpFoundation\ParameterBag
$builder OpenSkill\Datatable\Queries\QueryConfigurationBuilder

getSearchColumns() public method

public getSearchColumns ( Symfony\Component\HttpFoundation\ParameterBag $query, OpenSkill\Datatable\Queries\QueryConfigurationBuilder $builder, array $columnConfiguration )
$query Symfony\Component\HttpFoundation\ParameterBag
$builder OpenSkill\Datatable\Queries\QueryConfigurationBuilder
$columnConfiguration array

getStart() public method

public getStart ( Symfony\Component\HttpFoundation\ParameterBag $query, OpenSkill\Datatable\Queries\QueryConfigurationBuilder $builder )
$query Symfony\Component\HttpFoundation\ParameterBag
$builder OpenSkill\Datatable\Queries\QueryConfigurationBuilder

parse() public method

Method that should parse the request and return a DTQueryConfiguration
public parse ( Request $request, array $columnConfiguration ) : OpenSkill\Datatable\Queries\QueryConfiguration
$request Symfony\Component\HttpFoundation\Request The current request that should be investigated
$columnConfiguration array The configuration of the columns
return OpenSkill\Datatable\Queries\QueryConfiguration the configuration the provider can use to prepare the data