1. class
  2. SilverStripe
  3. \
  4. CMS
  5. \
  6. Search
  7. \
  8. ContentControllerSearchExtension

ContentControllerSearchExtension

class ContentControllerSearchExtension extends Extension (View source)

Extension to provide a search interface when applied to ContentController

Methods

__construct()

No description

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

Called when this extension is added to a particular class

from  Extension
setOwner(object $owner)

Set the owner of this extension.

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

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

from  Extension
clearOwner()

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

from  Extension
object
getOwner()

Returns the owner of this extension.

from  Extension
static string
get_classname_without_arguments(string $extensionStr)

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

from  Extension
mixed
invokeExtension(object $owner, string $method, array ...$arguments)

Invoke extension point. This will prefer explicit extend prefixed methods.

from  Extension
SearchForm
SearchForm()

Site search form

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

Process and render search results.

Details

in Extension at line 39
__construct()

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 {@link DataObject::$extensions} or {@link Object::add_extension()}.

Parameters

string $extensionStr

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

Return Value

string

Extension classname, e.g. "Versioned"

in Extension at line 128
mixed invokeExtension(object $owner, string $method, array ...$arguments)

Invoke extension point. This will prefer explicit extend prefixed methods.

Parameters

object $owner
string $method
array ...$arguments

Return Value

mixed

at line 27
SearchForm SearchForm()

Site search form

Return Value

SearchForm

at line 55
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