i3Soft\CDA\Traits\ContextControlCodeTrait

Complexity

Total Complexity

6

Size/Duplication

Total Lines	48
Duplicated Lines	0 %

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getContextControlCode()	0	3	1
A	setContextControlCode()	0	8	2
A	renderContextControlCode()	0	7	2
A	hasContextControlCode()	0	3	1

<?php

/**
 * The MIT License
 *
 * Copyright 2018  Peter Gee <https://github.com/pgee70>.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */


namespace i3Soft\CDA\Traits;


use i3Soft\CDA\Interfaces\ContextControlCodeInterface;

/**
 * Trait ContextControlCodeTrait
 *
 * @package i3Soft\CDA\Traits
 */
trait ContextControlCodeTrait
{
  /** @var string */
  private $contextControlCode = '';

  /**
   * @param \DOMElement $el
   *
   * @return self
   */
  public function renderContextControlCode (\DOMElement $el): self
  {
    if ($this->hasContextControlCode())
    {
      $el->setAttribute('contextControlCode', $this->getContextControlCode());
    }
    return $this;
  }

  /**
   * @return bool
   */
  public function hasContextControlCode (): bool
  {
    return '' !== $this->contextControlCode;
  }

  /**
   * @return string
   */
  public function getContextControlCode (): string
  {
    return $this->contextControlCode;
  }

  /**
   * @param string $contextControlCode
   *
   * @return self
   */
  public function setContextControlCode (string $contextControlCode): self
  {
    if (\in_array($contextControlCode, ContextControlCodeInterface::CDA, TRUE) === FALSE)
    {
      throw new \InvalidArgumentException("The context control value $contextControlCode was not valid!");
    }
    $this->contextControlCode = $contextControlCode;
    return $this;
  }

}