Charcoal\Cms\SearchableTrait

Complexity

Total Complexity

4

Size/Duplication

Total Lines	48
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes	3
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	setSearchProperties()	0	5	1
A	searchProperties()	0	4	1
A	setSearchKeywords()	0	5	1
A	searchKeywords()	0	4	1

<?php

namespace Charcoal\Cms;

use \Charcoal\Translation\TranslationString;

/**
 * Default implementation, as Trait, of the SearchableInterface
 */
trait SearchableTrait
{
    /**
     * @var array $searchProperties
     */
    private $searchProperties = [];

    /**
     * @var TranslationString $searchKeywords
     */
    private $searchKeywords;

    /**
     * @param array $properties The properties to search into.
     * @return SearchableInterface Chainable
     */
    public function setSearchProperties(array $properties)
    {
        $this->searchProperties = $properties;
        return $this;
    }

    /**
     * @return array
     */
    public function searchProperties()
    {
        return $this->searchProperties;
    }

    /**
     * @param mixed $keywords The search keywords (localized).
     * @return SearchableInterface Chainable
     */
    public function setSearchKeywords($keywords)
    {
        $this->searchKeywords = new TranslationString($keywords);
        return $this;
    }

    /**
     * @return TranslationString
     */
    public function searchKeywords()
    {
        return $this->searchKeywords;
    }
}