Mezon\Application\AbstractPresenter

Complexity

Total Complexity

15

Size/Duplication

Total Lines	143
Duplicated Lines	0 %

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	setErrorMessage()	0	6	2
A	getPresenterName()	0	3	1
A	getErrorCode()	0	3	2
A	getErrorMessage()	0	3	2
A	setPresenterName()	0	3	1
A	__construct()	0	3	1
A	setErrorCode()	0	6	2
A	getViewParameter()	0	7	2
A	setViewParameter()	0	4	2

<?php
namespace Mezon\Application;

/**
 * Interface PresenterInterface
 *
 * @package Application
 * @subpackage PresenterInterface
 * @author Dodonov A.A.
 * @version v.1.0 (2020/06/23)
 * @copyright Copyright (c) 2020, aeon.org
 */

// TODO move all methods of the Presenter method after the Controller class will be removed
// TODO create methods 'setMessage' 'getMessage' because we have not only error messages but success notifications also

/**
 * Base class for all presenters
 */
abstract class AbstractPresenter implements PresenterInterface
{

    /**
     * Presenter's name
     *
     * @var string
     */
    private $presenterName = '';

    /**
     * View object
     *
     * @var ViewInterface
     */
    private $view = null;

    /**
     * Error code
     *
     * @var integer
     */
    private $errorCode = 0;

    /**
     * Error message
     *
     * @var string
     */
    private $errorMessage = '';

    /**
     * Constructor
     *
     * @param ?ViewInterface $view
     *            view object
     */
    public function __construct(?ViewInterface $view = null)
    {
        $this->view = $view;
    }

    /**
     * Method returns presenter's name
     *
     * @return string presenter's name
     */
    public function getPresenterName(): string
    {
        return $this->presenterName;
    }

    /**
     * Method returns presenter's name
     *
     * @return string presenter's name
     */
    public function setPresenterName(string $presenterName): void
    {
        $this->presenterName = $presenterName;
    }

    /**
     * Method returns code of the last error
     *
     * @return int code of the last error
     */
    public function getErrorCode(): int
    {
        return $this->view === null ? $this->errorCode : $this->view->getErrorCode();
    }

    /**
     * Method sets code of the last error
     *
     * @param int $code
     *            code of the last error
     */
    public function setErrorCode(int $errorCode): void
    {
        if ($this->view === null) {
            $this->errorCode = $errorCode;
        } else {
            $this->view->setErrorCode($errorCode);
        }
    }

    /**
     * Method return last error description
     *
     * @return string last error description
     */
    public function getErrorMessage(): string
    {
        return $this->view === null ? $this->errorMessage : $this->view->getErrorMessage();
    }

    /**
     * Method sets last error description
     *
     * @param
     *            string last error description
     */
    public function setErrorMessage(string $errorMessage): void
    {
        if ($this->view === null) {
            $this->errorMessage = $errorMessage;
        } else {
            $this->view->setErrorMessage($errorMessage);
        }
    }

    /**
     * Method sets view's var
     *
     * @param string $name
     *            var name
     * @param mixed $value
     *            var value
     * @param bool $setTemplateVar
     *            do we need to set template parameter
     */
    public function setViewParameter(string $name, $value, bool $setTemplateVar): void
    {
        if ($this->view !== null) {
            $this->view->setViewParameter($name, $value, $setTemplateVar);
        }
    }

    /**
     * Method gets view's var
     *
     * @param string $name
     *            var name
     * @return mixed view's variable
     */
    public function getViewParameter(string $name)
    {
        if ($this->view !== null) {
            return $this->view->getViewParameter($name);
        }

        return null;
    }
}