icingaweb2-module-graphite/library/Graphite/Web/Controller/TimeRangePickerTrait.php

<?php

namespace Icinga\Module\Graphite\Web\Controller;

use Icinga\Module\Graphite\Forms\TimeRangePicker\CommonForm;
use Icinga\Module\Graphite\Forms\TimeRangePicker\CustomForm;
use Icinga\Web\Request;
use Icinga\Web\Url;
use Icinga\Web\View;

/**
 * @method string translate($text, $context = null) {
 *  @param  string      $text
 *  @param  string|null $context
 * }
 *
 * @property View $view
 */
trait TimeRangePickerTrait
{
    /**
     * @var CommonForm
     */
    protected $timeRangePickerCommonForm;

    /**
     * @var CustomForm
     */
    protected $timeRangePickerCustomForm;

    /**
     * Process the given request using the forms
     *
     * @param   Request $request    The request to be processed
     *
     * @return  Request             The request supposed to be processed
     */
    protected function handleTimeRangePickerRequest(Request $request = null)
    {
        $this->getTimeRangePickerCommonForm()->handleRequest($request);
        return $this->getTimeRangePickerCustomForm()->handleRequest($request);
    }

    /**
     * Render all needed forms and links
     *
     * @return string
     */
    protected function renderTimeRangePicker()
    {
        $result = $this->getTimeRangePickerCommonForm();
        $url = Url::fromRequest();
        $relevantParams = ['graph_range', 'graph_start', 'graph_end'];
        $hasLink = false;

        foreach ($relevantParams as $param) {
            if ($url->hasParam($param)) {
                $result .= $this->view->qlink(
                    $this->translate('Clear', 'TimeRangePicker'),
                    $url->without($relevantParams)
                );
                $hasLink = true;
                break;
            }
        }

        if ($url->hasParam('graph_range_custom')) {
            $result .= $this->getTimeRangePickerCustomForm();
        } else {
            if ($hasLink) {
                $result .= '&emsp;';
            }

            $result .= $this->view->qlink(
                $this->translate('Custom', 'TimeRangePicker'),
                $url->with('graph_range_custom', '1')
            );
        }

        return $result;
    }

    /**
     * Get {@link timeRangePickerCommonForm}
     *
     * @return CommonForm
     */
    public function getTimeRangePickerCommonForm()
    {
        if ($this->timeRangePickerCommonForm === null) {
            $this->timeRangePickerCommonForm = new CommonForm();
        }

        return $this->timeRangePickerCommonForm;
    }

    /**
     * Set {@link timeRangePickerCommonForm}
     *
     * @param CommonForm $timeRangePickerCommonForm
     *
     * @return $this
     */
    public function setTimeRangePickerCommonForm(CommonForm $timeRangePickerCommonForm)
    {
        $this->timeRangePickerCommonForm = $timeRangePickerCommonForm;
        return $this;
    }

    /**
     * Get {@link timeRangePickerCustomForm}
     *
     * @return CustomForm
     */
    public function getTimeRangePickerCustomForm()
    {
        if ($this->timeRangePickerCustomForm === null) {
            $this->timeRangePickerCustomForm = new CustomForm();
        }

        return $this->timeRangePickerCustomForm;
    }

    /**
     * Set {@link timeRangePickerCustomForm}
     *
     * @param CustomForm $timeRangePickerCustomForm
     *
     * @return $this
     */
    public function setTimeRangePickerCustomForm(CustomForm $timeRangePickerCustomForm)
    {
        $this->timeRangePickerCustomForm = $timeRangePickerCustomForm;
        return $this;
    }
}