Overview

Namespaces

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

Classes

  • AbstractDocument
  • AbstractEvent
  • AbstractFaq
  • AbstractImage
  • AbstractNews
  • AbstractSection
  • AbstractText
  • AbstractVideo
  • Config
  • Document
  • DocumentCategory
  • EmptySection
  • Event
  • EventCategory
  • ExternalSection
  • Faq
  • FaqCategory
  • Image
  • ImageCategory
  • News
  • NewsCategory
  • Section
  • Tag
  • Text
  • TextCategory
  • Video
  • VideoCategory

Interfaces

  • DocumentInterface
  • EventInterface
  • FaqInterface
  • ImageInterface
  • MetatagInterface
  • NewsInterface
  • SearchableInterface
  • SectionInterface
  • TemplateableInterface
  • TextInterface
  • VideoInterface

Traits

  • MetatagTrait
  • SearchableTrait
  • TemplateableTrait
  • Overview
  • Namespace
  • Class

Trait SearchableTrait

Default implementation, as Trait, of the SearchableInterface

Direct Known Users

Charcoal\Cms\AbstractEvent, Charcoal\Cms\AbstractFaq, Charcoal\Cms\AbstractNews, Charcoal\Cms\AbstractSection, Charcoal\Cms\AbstractText

Indirect Known Users

Charcoal\Cms\EmptySection, Charcoal\Cms\Event, Charcoal\Cms\ExternalSection, Charcoal\Cms\Faq, Charcoal\Cms\News, Charcoal\Cms\Section, Charcoal\Cms\Section\BlocksSection, Charcoal\Cms\Section\ContentSection, Charcoal\Cms\Text
Namespace: Charcoal\Cms
Located at Charcoal/Cms/SearchableTrait.php
Methods summary
public Charcoal\Cms\SearchableTrait
# setSearchProperties( array $properties )

Parameters

$properties
The properties to search into.

Returns

Charcoal\Cms\SearchableTrait
public array
# searchProperties( )

Returns

array
public Charcoal\Cms\SearchableTrait
# setSearchKeywords( mixed $keywords )

Parameters

$keywords
The search keywords (localized).

Returns

Charcoal\Cms\SearchableTrait
public Charcoal\Translator\Translation|string|null
# searchKeywords( )

Returns

Charcoal\Translator\Translation|string|null
API documentation generated by ApiGen