Kristuff\Phtemail\Core\HtmlContainerElement

Complexity

Total Complexity

4

Size/Duplication

Total Lines	68
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	elements()	0	3	1
A	getHtml()	0	15	2
A	add()	0	4	1

<?php

/**
 *  ____  _     _                       _ _
 * |  _ \| |__ | |_ ___ _ __ ___   __ _(_) |
 * | |_) | '_ \| __/ _ \ '_ ` _ \ / _` | | |
 * |  __/| | | | ||  __/ | | | | | (_| | | |
 * |_|   |_| |_|\__\___|_| |_| |_|\__,_|_|_|
 *
 * This file is part of Kristuff\Phtemail.
 *
 * (c) Kristuff <contact@kristuff.fr>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @version    0.2.0
 * @copyright  2017-2020 Kristuff
 */

namespace Kristuff\Phtemail\Core;

/** 
 * Class HtmlContainerElement
 * Abstract base class for Html email elements that can have child(s)
 */
abstract class HtmlContainerElement extends HtmlElement
{
    /** 
     * Allow to set padding and remove top/bottom padding
     */
    use \Kristuff\Phtemail\Core\ContainerPaddingTrait;

    /** 
     * Allow to set v/h align
     */
    use \Kristuff\Phtemail\Core\ContainerAlignTrait;

    /** 
     * The content of the email
     * 
     * @access private
     * @var array   $childElement
     */
    protected $childElements = array();

    /** 
     * Add an element to the HtmlElement collection
     * 
     * @access public 
     * @param HtmlElement   $element    An html element
     * 
     * @return void
     */
    public function add(HtmlElement $element)
    {
        $element->setParent($this);
        $this->childElements[] = $element;
    }

    /** 
     * Get the html element collection
     * 
     * @access public 
     * @return array
     */
    public function elements()
    {
        return $this->childElements;
    }

    /** 
     * Gets the HTML 
     *
     * @access public
     * @param string        $indent
     * 
     * @return string       The html string content
     */
    public function getHtml(string $indent)
    {
        // html result. start with an empty string or a html comment
        $html  = $this->getBuilder()->getHtmlComment('BLOCK', $indent);
     
        // render child elements collection
        foreach ($this->elements() as $element){
            $html .= PHP_EOL . $element->getHtml($indent);
        }
        
        // ending comment
        $html  .= $this->getBuilder()->getHtmlComment('END BLOCK', $indent);

        // return the build html 
        return $html;
    }    
}