ICanBoogie
  • Documentation
  • API Reference
  • Facets master
Namespaces
  • ICanBoogie
    • Facets
      • Criterion
      • CriterionValue
      • Fetcher
      • RecordCollection
Classes
  • CriterionList
  • CriterionNotDefined
  • CriterionValue
  • QueryString
  • QueryStringWord
  • RecordCollection
Interfaces
  • Criterion
  • Fetcher
Traits
  • CriterionTrait
  • FetcherTrait
  • ModelBindings

Class QueryString

Representation of a query string.

ICanBoogie\Facets\QueryString implements IteratorAggregate uses ICanBoogie\Accessor\AccessorTrait (not available)
Namespace: ICanBoogie\Facets
Located at QueryString.php

Methods summary

public __construct( $query_string )
public __toString( void )
public getIterator( void )

Implementation of

IteratorAggregate::getIterator()
public search( string $phrase ) : ICanBoogie\Facets\QueryStringWord[]|null

Search the phrase in the query string.

Search the phrase in the query string.

Parameters

$phrase

Returns

ICanBoogie\Facets\QueryStringWord[]|null
public before( ICanBoogie\Facets\QueryStringWord $word ) : ICanBoogie\Facets\QueryStringWord|null

Returns the word before the specified query string word, if any.

Returns the word before the specified query string word, if any.

Parameters

$word

Returns

ICanBoogie\Facets\QueryStringWord|null
public after( ICanBoogie\Facets\QueryStringWord $word ) : ICanBoogie\Facets\QueryStringWord|null

Returns the word after the specified query string word, if any.

Returns the word after the specified query string word, if any.

Parameters

$word

Returns

ICanBoogie\Facets\QueryStringWord|null
protected get_matched( void ) : ICanBoogie\Facets\QueryStringWord[]

Returns the query string words that have a match.

Returns the query string words that have a match.

Returns

ICanBoogie\Facets\QueryStringWord[]
protected get_not_matched( void ) : ICanBoogie\Facets\QueryStringWord[]

Returns the query string words that do not have a match.

Returns the query string words that do not have a match.

Returns

ICanBoogie\Facets\QueryStringWord[]
protected get_matches( void ) : array

Returns criterion values per criterion identifier.

Returns criterion values per criterion identifier.

Returns

array
protected get_conditions( void ) : array

Returns an array of facet conditions.

Returns an array of facet conditions.

Returns

array
protected get_remains( void )

Returns what remains of the query string after removing matched words.

Returns what remains of the query string after removing matched words.

Properties summary

protected $query_string

		
protected $words

		

Magic properties

public read-only $matched : ICanBoogie\Facets\QueryStringWord[]

Query string words for which a match was found.

public read-only $not_matched : ICanBoogie\Facets\QueryStringWord[]

Query string words for which no match was found.

public read-only $matches : array

Unique matches.

public read-only $conditions : array

An array of conditions suitable for Criterion::alter_query_with_conditions.

public read-only $remains : string

What remains of the query string after removing matched words.

Facets master – Check on GitHub – API documentation generated by ApiGen