alexdodonov / mezon-application

AbstractPresenter.php

<?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

/**
 * 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
     * @deprecated Must be removed after the Controller class will be removed.
     */
    private $errorCode = 0;

    /**
     * Error message
     *
     * @var string
     * @deprecated Must be removed after the Controller class will be removed.
     */
    private $errorMessage = '';

    /**
     * Constructor
     *
     * @param ViewInterface $view
     *            view object
     */
    public function __construct(ViewInterface $view)
    {
        $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
     * @codeCoverageIgnore
     */
    public function getErrorCode(): int
    {
        return $this->view === null ? $this->errorCode : $this->view->getErrorCode();

The property Mezon\Application\AbstractPresenter::$errorCode has been deprecated: Must be removed after the Controller class will be removed.

    }

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

The property Mezon\Application\AbstractPresenter::$errorCode has been deprecated: Must be removed after the Controller class will be removed.

        } else {
            $this->view->setErrorCode($errorCode);
        }
    }

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

The property Mezon\Application\AbstractPresenter::$errorMessage has been deprecated: Must be removed after the Controller class will be removed.

    }

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

The property Mezon\Application\AbstractPresenter::$errorMessage has been deprecated: Must be removed after the Controller class will be removed.

        } else {
            $this->view->setErrorMessage($errorMessage);
        }
    }
}