[ Index ]

PHP Cross Reference of DokuWiki

title

Body

[close]

/inc/Ui/ -> SearchState.php (summary)

(no description)

File Size: 141 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

SearchState:: (6 methods):
  __construct()
  withNamespace()
  withFragments()
  withTimeLimitations()
  withSorting()
  getSearchLink()


Class: SearchState  - X-Ref

__construct(array $parsedQuery)   X-Ref
SearchState constructor.

param: array $parsedQuery

withNamespace($ns, array $notns = [])   X-Ref
Get a search state for the current search limited to a new namespace

return: SearchState
param: string $ns the namespace to which to limit the search, falsy to remove the limitation
param: array  $notns

withFragments(array $and, array $not, array $phrases = [])   X-Ref
Get a search state for the current search with new search fragments and optionally phrases

return: SearchState
param: array $and
param: array $not
param: array $phrases

withTimeLimitations($after, $before)   X-Ref
Get a search state for the current search with with adjusted time limitations

return: SearchState
param: $after
param: $before

withSorting($sort)   X-Ref
Get a search state for the current search with adjusted sort preference

return: SearchState
param: $sort

getSearchLink($label)   X-Ref
Get a link that represents the current search state

Note that this represents only a simplified version of the search state.
Grouping with braces and "OR" conditions are not supported.

return: string
param: $label