pgee70 / cda

lib/Elements/Html/Paragraph.php

<?php
/**
 * The MIT License
 *
 * Copyright 2017 Julien Fastré <julien.fastre@champs-libres.coop>.
 *
 * 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\Elements\Html;

/**
 * Class Paragraph
 *
 * @package i3Soft\CDA\Elements
 * there can be 0 or 1 caption tags, and 0 or more of the other tags.
 * there can be an optional text element.
 */
class Paragraph extends AbstractHtmlElement
{
  /** @var Caption */
  protected $caption;

  /**
   * Paragraph constructor.
   *
   * @param null $choice

Are you sure the doc-type for parameter $choice is correct as it would always require null to be passed?

   */
  public function __construct ($choice = NULL)
  {
    parent::__construct(\is_string($choice)

The condition is_string($choice) is always false.

      ? $choice
      : '');
    $this->addTag($choice);
  }

  /**
   * @param \DOMDocument $doc
   *
   * @return \DOMElement
   */
  public function toDOMElement (\DOMDocument $doc): \DOMElement
  {
    $el = $this->createElement($doc);

    if ($this->hasCaption())
    {
      $el->appendChild($this->getCaption()->toDOMElement($doc));
    }
    foreach ($this->getTags() as $tag)
    {
      $el->appendChild($tag->toDOMElement($doc));
    }
    if ($this->hasContent())
    {
      $el->appendChild($doc->createTextNode($this->getContent()));
    }
    return $el;
  }

  /**
   * @return bool
   */
  public function hasCaption (): bool
  {
    return NULL !== $this->caption;
  }

  /**
   * @return Caption
   */
  public function getCaption (): Caption
  {
    return $this->caption;
  }

  /**
   * @param Caption $caption
   *
   * @return self
   */
  public function setCaption (Caption $caption): self
  {
    $this->caption = $caption;
    return $this;
  }

  protected function canAddTag ($choice): bool
  {
    return ($choice
            && ($choice instanceof LinkHtml
                || $choice instanceof Sub
                || $choice instanceof Sup
                || $choice instanceof Br
                || $choice instanceof Footnote
                || $choice instanceof FootNoteRef
                || $choice instanceof RenderMultiMedia));
  }

  /**
   * @return string
   */
  protected function getElementTag (): string
  {
    return 'paragraph';
  }


}