API Documentation
\
Charcoal
Admin
Widget
Cms
Cms
Config
Mixin
Traits
Route
Section
Service
Loader
Manager
ServiceProvider
Support
Helpers
Interfaces
Traits
Property

\Charcoal\CmsSearchableTrait

Default implementation, as Trait, of the SearchableInterface

Summary

Methods
Properties
Constants
setSearchProperties()
searchProperties()
setSearchKeywords()
searchKeywords()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$searchProperties
$searchKeywords
N/A

Properties

$searchProperties

$searchProperties : array

Type

array

$searchKeywords

$searchKeywords : \Charcoal\Translator\Translation|string|null

Type

\Charcoal\Translator\Translation|string|null

Methods

setSearchProperties()

setSearchProperties(array  $properties) : self

Parameters

array $properties

The properties to search into.

Returns

self

searchProperties()

searchProperties() : array

Returns

array

setSearchKeywords()

setSearchKeywords(mixed  $keywords) : self

Parameters

mixed $keywords

The search keywords (localized).

Returns

self

searchKeywords()

searchKeywords() : \Charcoal\Translator\Translation|string|null

Returns

\Charcoal\Translator\Translation|string|null