eymengunay / php-passbook

src/Passbook/Pass/Structure.php

<?php

/*
 * This file is part of the Passbook package.
 *
 * (c) Eymen Gunay <eymen@egunay.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Passbook\Pass;

/**
 * Pass Structure
 *
 * @author Eymen Gunay <eymen@egunay.com>
 */
class Structure implements StructureInterface
{
    /**
     * Fields to be displayed in the header on the front of the pass.
     * @var array
     */
    public $headerFields = [];

    /**
     * Fields to be displayed prominently on the front of the pass.
     * @var array
     */
    public $primaryFields = [];

    /**
     * Fields to be displayed on the front of the pass.
     * @var array
     */
    public $secondaryFields = [];

    /**
     * Additional fields to be displayed on the front of the pass.
     * @var array
     */
    public $auxiliaryFields = [];

    /**
     * Fields to be on the back of the pass.
     * @var array
     */
    public $backFields = [];

    public function toArray()
    {
        $array = [];

        foreach ($this->getHeaderFields() as $headerField) {
            $array['headerFields'][] = $headerField->toArray();
        }

        foreach ($this->getPrimaryFields() as $primaryField) {
            $array['primaryFields'][] = $primaryField->toArray();
        }

        foreach ($this->getSecondaryFields() as $secondaryField) {
            $array['secondaryFields'][] = $secondaryField->toArray();
        }

        foreach ($this->getAuxiliaryFields() as $auxiliaryField) {
            $array['auxiliaryFields'][] = $auxiliaryField->toArray();
        }

        foreach ($this->getBackFields() as $backField) {
            $array['backFields'][] = $backField->toArray();
        }

        return empty($array) ? (object)null : $array;

The expression return empty($array) ? (object)null : $array also could return the type object which is incompatible with the return type mandated by Passbook\ArrayableInterface::toArray() of array.

    }

    /**
     * {@inheritdoc}
     */
    public function addHeaderField(FieldInterface $headerField)
    {
        $this->headerFields[] = $headerField;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function getHeaderFields()
    {
        return $this->headerFields;
    }

    /**
     * {@inheritdoc}
     */
    public function addPrimaryField(FieldInterface $primaryField)
    {
        $this->primaryFields[] = $primaryField;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function getPrimaryFields()
    {
        return $this->primaryFields;
    }

    /**
     * {@inheritdoc}
     */
    public function addSecondaryField(FieldInterface $secondaryField)
    {
        $this->secondaryFields[] = $secondaryField;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function getSecondaryFields()
    {
        return $this->secondaryFields;
    }

    /**
     * {@inheritdoc}
     */
    public function addAuxiliaryField(FieldInterface $auxiliaryField)
    {
        $this->auxiliaryFields[] = $auxiliaryField;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function getAuxiliaryFields()
    {
        return $this->auxiliaryFields;
    }

    /**
     * {@inheritdoc}
     */
    public function addBackField(FieldInterface $backField)
    {
        $this->backFields[] = $backField;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function getBackFields()
    {
        return $this->backFields;
    }
}