bkdotcom/PHPDebugConsole

View on GitHub
src/Teams/Elements/AbstractElement.php

Summary

Maintainability
A
0 mins
Test Coverage
A
100%
<?php

namespace bdk\Teams\Elements;

use bdk\Teams\Enums;

/**
 * aka Extendable.Element
 */
abstract class AbstractElement extends AbstractToggleableItem implements ElementInterface
{
    /**
     * Constructor
     *
     * @param array<string, mixed> $fields Field values
     * @param string               $type   Item type
     */
    public function __construct(array $fields, $type)
    {
        $fields = \array_merge(array(
            'fallback' => null,
            'height' => null,
            'separator' => null,
            'spacing' => null,
        ), $fields);
        parent::__construct($fields, $type);
    }

    /**
     * {@inheritDoc}
     */
    public function getContent($version)
    {
        $attrVersions = array(
            'fallback' => 1.1,
            'height' => 1.1,
            'separator' => 1.0,
            'spacing' => 1.0,
        );

        $content = parent::getContent($version);
        foreach ($attrVersions as $name => $ver) {
            if ($version >= $ver) {
                /** @var mixed */
                $content[$name] = $this->fields[$name];
            }
        }

        return self::normalizeContent($content, $version);
    }

    /**
     * Describes what to do when an unknown element is encountered
     * or the requires of this or any children can't be met.
     *
     * @param ElementInterface|Enums::FALLBACK_* $fallback How to we fallback?
     *
     * @return static
     */
    public function withFallback($fallback)
    {
        self::assertFallback(
            $fallback,
            'bdk\\Teams\\Elements\\ElementInterface',
            $this->type . ' fallback should be instance of ElementInterface or one of Enum::FALLBACK_x values'
        );
        return $this->with('fallback', $fallback);
    }

    /**
     * Return new instance with specified height
     *
     * @param Enums::HEIGHT_* $height Height of the element.
     *
     * @return static
     */
    public function withHeight($height)
    {
        self::assertEnumValue($height, 'HEIGHT_', 'height');
        return $this->with('height', $height);
    }

    /**
     * Return new instance with specified separator value
     * When true, draw a separating line at the top of the element.
     *
     * @param bool $separator Add separating line?
     *
     * @return static
     */
    public function withSeparator($separator = true)
    {
        self::assertBool($separator, 'separator');
        return $this->with('separator', $separator);
    }

    /**
     * Return new instance with specified spacing value
     * Controls the amount of spacing between this element and the preceding element.
     *
     * @param Enums::SPACING_* $spacing Spacing
     *
     * @return static
     */
    public function withSpacing($spacing)
    {
        self::assertEnumValue($spacing, 'SPACING_', 'spacing');
        return $this->with('spacing', $spacing);
    }
}