1. class
  2. CWP
  3. \
  4. Search
  5. \
  6. Extensions
  7. \
  8. SearchControllerExtension

SearchControllerExtension

class SearchControllerExtension extends Extension (View source)

Adds a search form and handling method to a Controller instance, using the configured CWP search engine

Traits

Configurable

Provides extensions to this object to integrate it with standard config API methods.

Config options

allowed_actions
results_per_page int

How many search results should be shown per-page?
search_follow_suggestions bool

If spelling suggestions for searches are given, enable suggested searches to be followed immediately

Properties

protected object $owner

The object this extension is applied to.

 from  Extension

Methods

public
__construct()

No description

from  Extension
public static 
add_to_class(string $class, string $extensionClass, mixed $args = null)

Called when this extension is added to a particular class

from  Extension
public
setOwner(object $owner)

Set the owner of this extension.

from  Extension
public
mixed
withOwner(mixed $owner, callable $callback, array $args = [])

Temporarily modify the owner. The original owner is ensured to be restored

from  Extension
public
clearOwner()

Clear the current owner, and restore extension to the state prior to the last setOwner()

from  Extension
public
object
getOwner()

Returns the owner of this extension.

from  Extension
public static 
string
get_classname_without_arguments(string $extensionStr)

Helper method to strip eval'ed arguments from a string that's passed to DataObject::$extensions or Object::add_extension().

from  Extension
public static 
Config_ForClass
config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

from  Configurable
public
mixed
stat(string $name) deprecated

Get inherited config value

from  Configurable
public
mixed
uninherited(string $name)

Gets the uninherited value for the given config option

from  Configurable
public
$this
set_stat(string $name, mixed $value) deprecated

Update the config value for a given property

from  Configurable
public
SearchForm()

Site search form

public
SearchForm
HeaderSearchForm()

Get search form with _header suffix

public
DBHTMLText
results(array $data, SearchForm $form, HTTPRequest $request)

Process and render search results.

protected
array
getResultsTemplate(HTTPRequest $request)

Select the template to render search results with

Details

in Extension at line 39
__construct()

No description

in Extension at line 50
static add_to_class(string $class, string $extensionClass, mixed $args = null)

Called when this extension is added to a particular class

Parameters

string $class
string $extensionClass
mixed $args

in Extension at line 60
setOwner(object $owner)

Set the owner of this extension.

Parameters

object $owner

The owner object

in Extension at line 74
mixed withOwner(mixed $owner, callable $callback, array $args = [])

Temporarily modify the owner. The original owner is ensured to be restored

Parameters

mixed $owner

Owner to set
callable $callback

Callback to invoke
array $args

Args to pass to callback

Return Value

mixed

in Extension at line 87
clearOwner()

Clear the current owner, and restore extension to the state prior to the last setOwner()

in Extension at line 100
object getOwner()

Returns the owner of this extension.

Return Value

object

in Extension at line 113
static string get_classname_without_arguments(string $extensionStr)

Helper method to strip eval'ed arguments from a string that's passed to DataObject::$extensions or Object::add_extension().

Parameters

string $extensionStr

E.g. "Versioned('Stage','Live')"

Return Value

string

Extension classname, e.g. "Versioned"

in Configurable at line 20
static Config_ForClass config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

Return Value

Config_ForClass

in Configurable at line 32
mixed stat(string $name) deprecated

deprecated 5.0 Use ->config()->get() instead

Get inherited config value

Parameters

string $name

Return Value

mixed

in Configurable at line 44
mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

in Configurable at line 57
$this set_stat(string $name, mixed $value) deprecated

deprecated 5.0 Use ->config()->set() instead

Update the config value for a given property

Parameters

string $name
mixed $value

Return Value

$this

at line 64
SearchForm()

Site search form

at line 86
SearchForm HeaderSearchForm()

Get search form with _header suffix

Return Value

SearchForm

at line 99
DBHTMLText results(array $data, SearchForm $form, HTTPRequest $request)

Process and render search results.

Parameters

array $data

The raw request data submitted by user
SearchForm $form

The form instance that was submitted
HTTPRequest $request

Request generated for this action

Return Value

DBHTMLText

at line 148
protected array getResultsTemplate(HTTPRequest $request)

Select the template to render search results with

Parameters

HTTPRequest $request

Return Value

array