Group.php

<?php
/*
 * citeproc-php
 *
 * @link        http://github.com/seboettg/citeproc-php for the source repository
 * @copyright   Copyright (c) 2016 Sebastian Böttger.
 * @license     https://opensource.org/licenses/MIT
 */
 
namespace Seboettg\CiteProc\Rendering;
 
use Seboettg\CiteProc\Exception\InvalidStylesheetException;
use Seboettg\CiteProc\Styles\AffixesTrait;
use Seboettg\CiteProc\Styles\ConsecutivePunctuationCharacterTrait;
use Seboettg\CiteProc\Styles\DelimiterTrait;
use Seboettg\CiteProc\Styles\DisplayTrait;
use Seboettg\CiteProc\Styles\FormattingTrait;
use Seboettg\CiteProc\Util\Factory;
use Seboettg\CiteProc\Util\StringHelper;
use Seboettg\Collection\ArrayList;
use SimpleXMLElement;
 
class Group implements Rendering, HasParent
{
    use DelimiterTrait,
        AffixesTrait,
        DisplayTrait,
        FormattingTrait,
        ConsecutivePunctuationCharacterTrait;
 
    private $children;
 
    private $delimiter = "";
 
    private $parent;
 
    private $renderedChildsWithVariable = [];
 
 
    public function __construct(SimpleXMLElement $node, $parent)
    {
        $this->parent = $parent;
        $this->children = new ArrayList();
        foreach ($node->children() as $child) {
            $this->children->append(Factory::create($child, $this));
        }
        $this->initDisplayAttributes($node);
        $this->initAffixesAttributes($node);
        $this->initDelimiterAttributes($node);
        $this->initFormattingAttributes($node);
    }
 
    public function render($data, $citationNumber = null)
    {
        $textParts = [];
        $terms = $variables = $haveVariables = $elementCount = 0;
        foreach ($this->children as $child) {
            $elementCount++;
 
            if (($child instanceof Text)
                && ($child->getSource() == 'term'
                || $child->getSource() == 'value')
            ) {
                ++$terms;
            }
 
            if (($child instanceof Label)) {
                ++$terms;
            }
            if (method_exists($child, "getSource") && $child->getSource() == 'variable'
                && !empty($child->getVariable()) && $child->getVariable() != "date"
                && !empty($data->{$child->getVariable()})
            ) {
                ++$variables;
            }
 
            $text = $child->render($data, $citationNumber);
            $delimiter = $this->delimiter;
            if (!empty($text)) {
                if ($delimiter && ($elementCount < count($this->children))) {
                    //check to see if the delimiter is already the last character of the text string
                    //if so, remove it so we don't have two of them when the group will be merged
                    $stext = strip_tags(trim($text));
                    if ((strrpos($stext, $delimiter[0]) + 1) == strlen($stext) && strlen($stext) > 1) {
                        $text = str_replace($stext, '----REPLACE----', $text);
                        $stext = substr($stext, 0, -1);
                        $text = str_replace('----REPLACE----', $stext, $text);
                    }
                }
                $textParts[] = $text;
 
                if (method_exists($child, "getSource") && $child->getSource() == 'variable'
                    || (method_exists(
                        $child,
                        "getVariable"
                    ) && $child->getVariable() != "date" && !empty($child->getVariable()))
                ) {
                    $haveVariables++;
                }
 
                if (method_exists($child, "getSource") && $child->getSource() == 'macro') {
                    $haveVariables++;
                }
            }
        }
        return $this->formatting($textParts, $variables, $haveVariables, $terms);
    }
 
    public function getParent()
    {
        return $this->parent;
    }
 
    protected function formatting($textParts, $variables, $haveVariables, $terms)
    {
        if (empty($textParts)) {
            return "";
        }
 
        if ($variables && !$haveVariables) {
            return ""; // there has to be at least one other none empty value before the term is output
        }
 
        if (count($textParts) == $terms) {
            return ""; // there has to be at least one other none empty value before the term is output
        }
 
        $text = StringHelper::implodeAndPreventConsecutiveChars($this->delimiter, $textParts);
 
        if (!empty($text)) {
            return $this->wrapDisplayBlock($this->addAffixes($this->format(($text))));
        }
 
        return "";
    }
 
    public function hasDelimiter()
    {
        return !empty($this->delimiter);
    }
 
    public function getDelimiter()
    {
        return $this->delimiter;
    }
}