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( )`
`public`	# `getIterator( )` Implementation of `IteratorAggregate::getIterator()`
`public ICanBoogie\Facets\QueryStringWord[]\|null`	# `search( string $phrase )` Search the phrase in the query string. Search the phrase in the query string. Parameters `$phrase` Returns `ICanBoogie\Facets\QueryStringWord[]`\|null
`public ICanBoogie\Facets\QueryStringWord\|null`	# `before( ICanBoogie\Facets\QueryStringWord $word )` 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 ICanBoogie\Facets\QueryStringWord\|null`	# `after( ICanBoogie\Facets\QueryStringWord $word )` 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 ICanBoogie\Facets\QueryStringWord[]`	# `get_matched( )` Returns the query string words that have a match. Returns the query string words that have a match. Returns `ICanBoogie\Facets\QueryStringWord[]`
`protected ICanBoogie\Facets\QueryStringWord[]`	# `get_not_matched( )` 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 array`	# `get_matches( )` Returns criterion values per criterion identifier. Returns criterion values per criterion identifier. Returns array
`protected array`	# `get_conditions( )` Returns an array of facet conditions. Returns an array of facet conditions. Returns array
`protected`	# `get_remains( )` 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 ICanBoogie\Facets\QueryStringWord[]`	`$matched` Query string words for which a match was found.
`public read-only ICanBoogie\Facets\QueryStringWord[]`	`$not_matched` Query string words for which no match was found.
`public read-only array`	`$matches` Unique matches.
`public read-only array`	`$conditions` An array of conditions suitable for Criterion::alter_query_with_conditions.
`public read-only string`	`$remains` What remains of the query string after removing matched words.