antaresproject/core

<?php

/**
 * Part of the Antares package.
 *
 * NOTICE OF LICENSE
 *
 * Licensed under the 3-clause BSD License.
 *
 * This source file is subject to the 3-clause BSD License that is
 * bundled with this package in the LICENSE file.
 *
 * @package        Antares Core
 * @version        0.9.0
 * @author         Antares Team
 * @author         Mariusz Jucha <mariuszjucha@gmail.com>
 * @author         Marcin Domański <marcin@domanskim.pl>
 * @license        BSD License (3-clause)
 * @copyright  (c) 2017, Antares
 * @link           http://antaresproject.io
 */

namespace Antares\Form\Controls;

use Antares\Form\Contracts\Attributable;
use Antares\Form\Decorators\AbstractDecorator;
use Antares\Form\Decorators\HorizontalDecorator;
use Antares\Form\Labels\AbstractLabel;
use Antares\Form\Labels\Label;
use Antares\Form\Traits\AttributesTrait;
use Antares\Messages\MessageBag;

abstract class AbstractType implements Attributable
{

    use AttributesTrait;

    /** @var string */
    protected $id;

    /** @var string */
    protected $name;

    /** @var string */
    protected $type;

    /** @var string|array */
    protected $value;

    /** @var AbstractLabel */
    protected $label;

    /** @var AbstractDecorator */
    protected $decorator;

    /** @var array */
    protected $messages = [];

    /** @var string */
    protected $prependHtml = '';

    /** @var string */
    protected $appendHtml = '';

    /**
     * AbstractType constructor
     *
     * @param string $name
     * @param array $attributes
     */
    public function __construct(string $name, array $attributes = [])
    {
        $this->setName($name);
        $this->attributes = array_merge($attributes, ['name' => $this->getName()]);
    }

    /**
     * @return mixed
     */
    public function getId()
    {
        return $this->id;
    }

    /**
     * @param mixed $id
     */
    public function setId($id)
    {
        $this->id = $id;
    }

    /**
     * @param AbstractLabel|string $label
     * @param string $info
     * @return AbstractType
     */
    public function setLabel($label, $info = ''): AbstractType
    {
        if (!$label instanceof AbstractLabel) {
            $label = new Label($label, $this, $info);
        }
        if (!$label->hasControl()) {
            $label->setControl($this);
        }
        $this->label = $label;

        return $this;
    }

    /**
     * @return string
     */
    public function getPrependHtml(): string
    {
        return $this->prependHtml;
    }

    /**
     * @param string $prependHtml
     */
    public function setPrependHtml(string $prependHtml)
    {
        $this->prependHtml = $prependHtml;
    }

    /**
     * @return string
     */
    public function getAppendHtml(): string
    {
        return $this->appendHtml;
    }

    /**
     * @param string $appendHtml
     */
    public function setAppendHtml(string $appendHtml)
    {
        $this->appendHtml = $appendHtml;
    }

    /**
     * @return bool
     */
    public function hasLabel(): bool
    {
        return $this->label instanceof AbstractLabel;
    }

    /**
     * @return AbstractLabel
     */
    public function getLabel(): AbstractLabel
    {
        return $this->label;
    }

    /**
     * @param AbstractDecorator|string $decorator
     * @return AbstractType
     */
    public function setDecorator($decorator)
    {
        $this->decorator = $decorator instanceof AbstractDecorator ? $decorator : app()->make($decorator);
        return $this;
    }

    /**
     * @return AbstractDecorator
     */
    public function getDecorator(): AbstractDecorator
    {
        return $this->decorator;
    }

    /**
     * @return string
     */
    public function getName(): string
    {
        return $this->name;
    }

    /**
     * @param string $name
     * @return AbstractType
     */
    public function setName(string $name): AbstractType
    {
        $this->name = $name;
        return $this;
    }

    /**
     * @return string
     */
    public function getType(): string
    {
        return $this->type;
    }

    /**
     * @param string $type
     * @return AbstractType
     */
    public function setType(string $type): AbstractType
    {
        $this->type = $type;
        return $this;
    }

    /**
     * @return array|string
     */
    public function getValue()
    {
        return $this->value;
    }

    /**
     * @param array|string $value
     * @return AbstractType
     */
    public function setValue($value): AbstractType
    {
        $this->value = $value;
        return $this;
    }

    /**
     * @param string $placeholder
     * @return AbstractType
     */
    public function setPlaceholder($placeholder): AbstractType
    {
        return $this->setAttribute('placeholder', $placeholder);
    }

    /**
     * @param string $class
     * @return AbstractType
     */
    public function addClass($class): AbstractType
    {
        return $this->setAttribute('class',
            $this->hasAttribute('class')
                ? sprintf('%s %s', $this->getAttribute('class'), $class) : $class);
    }

    /**
     * @return array
     */
    public function getMessages(): array
    {
        return $this->messages;
    }

    /**
     * @param string $type
     * @param string $message
     * @return AbstractType
     */
    public function addMessage(string $type, string $message): AbstractType
    {
        $this->messages[$type][] = $message;
        return $this;
    }

    /**
     * lookup for validation errors for this control
     */
    protected function findErrors()
    {
        $session = session();
        if (!$session->has('errors') || !$session->get('errors')->hasBag('default')) {
            return;
        }
        /** @var MessageBag $messageBag */
        $messageBag = session()->get('errors')->getBag('default');
        if (isset($messageBag->messages()[$this->name])) {
            foreach ($messageBag->messages()[$this->name] as $error) {
                $this->addError($error);
            }
        }
    }

    /**
     * @param string $error
     */
    public function addError(string $error)
    {
        $this->messages['errors'][] = $error;
    }

    /**
     * @return string
     */
    public function __toString(): string
    {
        try {
            return $this->render();
        } catch (\Throwable $e) {
            return $e->getMessage();
        }
    }

    /**
     * Rendering this very control
     *
     * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
     */
    public function renderControl()
    {
        return view('antares/foundation::form.controls.' . $this->type, ['control' => $this]);
    }

    /**
     * Render control to html
     *
     * @return string
     */
    protected function render()
    {
        $this->findErrors();

        if (!$this->label instanceof AbstractLabel) {
            $this->setLabel(new Label(ucfirst(str_replace('_', ' ', $this->name))));
        }
        if (!$this->decorator instanceof AbstractDecorator) {
            $this->setDecorator((new HorizontalDecorator()));
        }

        return $this->decorator->render($this);
    }

}