class WordfilterItem in Wordfilter 8.2

Hierarchy

• class \Drupal\wordfilter\WordfilterItem

3 files declare their use of WordfilterItem

WordfilterConfiguration.php in src/Entity/WordfilterConfiguration.php

WordfilterConfigurationForm.php in src/Form/WordfilterConfigurationForm.php

WordfilterConfigurationInterface.php in src/Entity/WordfilterConfigurationInterface.php

File

src/WordfilterItem.php, line 7

Namespace

Drupal\wordfilter

class WordfilterItem {

  /**
   * The parent entity, which is holding the filtering item.
   *
   * @var \Drupal\wordfilter\Entity\WordfilterConfigurationInterface
   */
  protected $parent;

  /**
   * The item data as array.
   *
   * Contains the following keys:
   *   'delta': The delta of the filtering item.
   *   'substitute': The substitution string.
   *   'filter_words': The list of words to filter.
   *                   This list is being stored as a string,
   *                   words are being separated by ", ".
   *
   * @var array
   */
  protected $data;

  /**
   * WordfilterItem constructor.
   *
   * @param array &$data
   *   The item values as array.
   *   Must contain the keys 'delta', 'substitute' and 'filter_words',
   *   which are all strings.
   */
  public function __construct(WordfilterConfigurationInterface $parent, array &$data) {
    $this
      ->setParent($parent);
    $this
      ->setData($data);
  }

  /**
   * Get the parent entity.
   *
   * @return \Drupal\wordfilter\Entity\WordfilterConfigurationInterface
   */
  public function getParent() {
    return $this->parent;
  }

  /**
   * Set the parent entity.
   *
   * @param \Drupal\wordfilter\Entity\WordfilterConfigurationInterface $parent
   */
  protected function setParent(WordfilterConfigurationInterface $parent) {
    $this->parent = $parent;
  }

  /**
   * Set the item data.
   *
   * @param array &$data
   */
  protected function setData(&$data) {
    $this->data =& $data;
  }

  /**
   * Get the delta of this filtering item.
   *
   * @return integer
   */
  public function getDelta() {
    return $this->data['delta'];
  }

  /**
   * Set the delta of this filtering item.
   *
   * @param $delta
   */
  public function setDelta($delta) {
    $this->data['delta'] = $delta;
  }

  /**
   * Get the substitution string.
   *
   * @return string
   */
  public function getSubstitute() {
    return $this->data['substitute'];
  }

  /**
   * Set the substitution string.
   *
   * @param string $substitute
   *   The substitution string.
   */
  public function setSubstitute($substitute) {
    $this->data['substitute'] = $substitute;
  }

  /**
   * Get the filter words.
   *
   * @return array
   *  An array of the filter words.
   */
  public function getFilterWords() {
    return $this
      ->wordsToArray($this->data['filter_words']);
  }

  /**
   * Set the filter words.
   *
   * @param mixed $words
   *   A string or array of filter words.
   *   As a string, multiple words are to be separated by ", ".
   */
  public function setFilterWords($words) {
    if (is_string($words)) {
      $words = $this
        ->wordsToArray($words);
    }

    // Filter out duplicates.
    // Todo Replace with a case-insensitive filter.
    $words = array_unique($words);
    $words = implode(", ", $words);
    $this->data['filter_words'] = $words;
  }

  /**
   * Helper function to transform a string of words to an array.
   *
   * @param $words_string
   *  The string of words, usually separated by ", ".
   * @return array
   *  The array of words.
   */
  protected function wordsToArray($words_string) {
    $words_array = !empty($words_string) ? explode(',', $words_string) : [];
    $words_array = array_map('trim', $words_array);
    return $words_array;
  }

  /**
   * Array representation of this object.
   *
   * @return array
   */
  public function toArray() {
    return $this->data;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
WordfilterItem::$data	protected	property	The item data as array.
WordfilterItem::$parent	protected	property	The parent entity, which is holding the filtering item.
WordfilterItem::getDelta	public	function	Get the delta of this filtering item.
WordfilterItem::getFilterWords	public	function	Get the filter words.
WordfilterItem::getParent	public	function	Get the parent entity.
WordfilterItem::getSubstitute	public	function	Get the substitution string.
WordfilterItem::setData	protected	function	Set the item data.
WordfilterItem::setDelta	public	function	Set the delta of this filtering item.
WordfilterItem::setFilterWords	public	function	Set the filter words.
WordfilterItem::setParent	protected	function	Set the parent entity.
WordfilterItem::setSubstitute	public	function	Set the substitution string.
WordfilterItem::toArray	public	function	Array representation of this object.
WordfilterItem::wordsToArray	protected	function	Helper function to transform a string of words to an array.
WordfilterItem::__construct	public	function	WordfilterItem constructor.