\Dewdrop\Fields\HelperSelectModifierInterface

This interface is for all field helpers that modify Select objects (e.g. sorting, filtering, etc.).

Summary

Methods
Constants
setPrefix()
getPrefix()
matchesName()
modifySelect()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

setPrefix()

setPrefix(string  $prefix) : mixed

Set a prefix that should be used when pulling information from the request.

Parameters

string $prefix

Returns

mixed

getPrefix()

getPrefix() : string

Get the prefix used for request parameters.

Returns

string

matchesName()

matchesName(string  $name) : boolean

Check to see if the SelectModifier matches the supplied name.

Parameters

string $name

Returns

boolean

modifySelect()

modifySelect(\Dewdrop\Fields  $fields, \Dewdrop\Db\Select  $select) : \Dewdrop\Db\Select

Using the supplied \Dewdrop\Fields and \Dewdrop\Db\Select, modify the Select and return it.

Parameters

\Dewdrop\Fields $fields
\Dewdrop\Db\Select $select

Returns

\Dewdrop\Db\Select