Presenter::getParamsFetcher() - Code Metrics - Inspection of "feature/Method getParamsFetcher was created" - alexdodonov/mezon-application - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0ea0cc...2ded10 )

by Alex

created 2020-06-23 15:52 UTC

Presenter::getParamsFetcher() A

↳ Parent: Presenter

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	3
nc	2
nop	0
dl	0
loc	7
rs	10
c	0
b	0
f	0

<?php
namespace Mezon\Application;

use Mezon\Transport\RequestParamsInterface;

/**
 * Class Presenter
 *
 * @package Mezon
 * @subpackage Presenter
 * @author Dodonov A.A.
 * @version v.1.0 (2020/01/12)
 * @copyright Copyright (c) 2020, aeon.org
 */

/**
 * Base class for all views
 *
 * @deprecated since 2020-06-26
 */
class Presenter extends \Mezon\Application\AbstractPresenter
{

    /**
     * Router
     *
     * @var \Mezon\Transport\RequestParams
     */
    private $requestParams = null;

    /**
     * Constructor
     *
     * @param string $presenterName
     *            Presenter name to be executed
     * @param ?\Mezon\Transport\RequestParams $requestParams
     *            request params fetcher
     */
    public function __construct(string $presenterName = '', ?\Mezon\Transport\RequestParams $requestParams = null)
    {
        $this->setPresenterName($presenterName);

        $this->requestParams = $requestParams;
    }

    /**
     * Method return $requestParams and thrown exception if it was not set
     *
     * @return RequestParamsInterface request params fetcher
     */
    public function getParamsFetcher(): RequestParamsInterface
    {
        if ($this->requestParams === null) {
            throw (new \Exception('Param fetcher was not setup'));
        }

        return $this->requestParams;
    }

    /**
     * Method runs controller
     *
     * @param
     *            string PresenterName
     *            Presenter name to be run
     * @return mixed result of the controller
     */
    public function run(string $presenterName = '')
    {
        if ($presenterName === '') {
            $presenterName = $this->getPresenterName();
        }

        if ($presenterName === '') {
            $presenterName = 'Default';
        }

        if (method_exists($this, 'presenter' . $presenterName)) {
            return call_user_func([
                $this,
                'presenter' . $presenterName
            ]);
        }

        throw (new \Exception('Presenter ' . $presenterName . ' was not found'));
    }

    /**
     * May be these functions should be excluded to base class common with View
     */

    /**
     * Method redirects user to another page
     *
     * @param string $url
     * @codeCoverageIgnore
     */
    public function redirectTo(string $url): void
    {
        header("Location: $url");
        exit(0);
    }

    /**
     * Method builds route data
     *
     * @param string $route
     *            route
     * @param string $method
     *            HTTP method
     * @param string $function
     *            controller's function name
     * @return array built route data
     */
    public function buildRoute(string $route, string $method, string $function): array
    {
        return [
            'route' => $route,
            'method' => $method,
            'callback' => [
                $this,
                $function
            ]
        ];
    }

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

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

    }

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

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

    }
}


1			<?php
2			namespace Mezon\Application;
3
4			use Mezon\Transport\RequestParamsInterface;
5
6			/**
7			* Class Presenter
8			*
9			* @package Mezon
10			* @subpackage Presenter
11			* @author Dodonov A.A.
12			* @version v.1.0 (2020/01/12)
13			* @copyright Copyright (c) 2020, aeon.org
14			*/
15
16			/**
17			* Base class for all views
18			*
19			* @deprecated since 2020-06-26
20			*/
21			class Presenter extends \Mezon\Application\AbstractPresenter
22			{
23
24			/**
25			* Router
26			*
27			* @var \Mezon\Transport\RequestParams
28			*/
29			private $requestParams = null;
30
31			/**
32			* Constructor
33			*
34			* @param string $presenterName
35			* Presenter name to be executed
36			* @param ?\Mezon\Transport\RequestParams $requestParams
37			* request params fetcher
38			*/
39			public function __construct(string $presenterName = '', ?\Mezon\Transport\RequestParams $requestParams = null)
40			{
41			$this->setPresenterName($presenterName);
42
43			$this->requestParams = $requestParams;
44			}
45
46			/**
47			* Method return $requestParams and thrown exception if it was not set
48			*
49			* @return RequestParamsInterface request params fetcher
50			*/
51			public function getParamsFetcher(): RequestParamsInterface
52			{
53			if ($this->requestParams === null) {
54			throw (new \Exception('Param fetcher was not setup'));
55			}
56
57			return $this->requestParams;
58			}
59
60			/**
61			* Method runs controller
62			*
63			* @param
64			* string PresenterName
65			* Presenter name to be run
66			* @return mixed result of the controller
67			*/
68			public function run(string $presenterName = '')
69			{
70			if ($presenterName === '') {
71			$presenterName = $this->getPresenterName();
72			}
73
74			if ($presenterName === '') {
75			$presenterName = 'Default';
76			}
77
78			if (method_exists($this, 'presenter' . $presenterName)) {
79			return call_user_func([
80			$this,
81			'presenter' . $presenterName
82			]);
83			}
84
85			throw (new \Exception('Presenter ' . $presenterName . ' was not found'));
86			}
87
88			/**
89			* May be these functions should be excluded to base class common with View
90			*/
91
92			/**
93			* Method redirects user to another page
94			*
95			* @param string $url
96			* @codeCoverageIgnore
97			*/
98			public function redirectTo(string $url): void
99			{
100			header("Location: $url");
101			exit(0);
102			}
103
104			/**
105			* Method builds route data
106			*
107			* @param string $route
108			* route
109			* @param string $method
110			* HTTP method
111			* @param string $function
112			* controller's function name
113			* @return array built route data
114			*/
115			public function buildRoute(string $route, string $method, string $function): array
116			{
117			return [
118			'route' => $route,
119			'method' => $method,
120			'callback' => [
121			$this,
122			$function
123			]
124			];
125			}
126
127			/**
128			* Method returns code of the last error
129			*
130			* @return int code of the last error
131			* @codeCoverageIgnore
132			*/
133			public function getErrorCode(): int
134			{
135			return $this->errorCode;
136			}
137
138			/**
139			* Method sets code of the last error
140			*
141			* @param int $code
142			* code of the last error
143			* @codeCoverageIgnore
144			*/
145			public function setErrorCode(int $errorCode): void
146			{
147			$this->errorCode = $errorCode;
			0 ignored issues – show Bug Best Practice introduced 2020-06-23 15:17 UTC by Report Bug Copy Issue Report The property `errorCode` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
148			}
149
150			/**
151			* Method return last error description
152			*
153			* @return string last error description
154			* @codeCoverageIgnore
155			*/
156			public function getErrorMessage(): string
157			{
158			return $this->errorMessage;
159			}
160
161			/**
162			* Method sets last error description
163			*
164			* @param
165			* string last error description
166			* @codeCoverageIgnore
167			*/
168			public function setErrorMessage(string $errorMessage): void
169			{
170			$this->errorMessage = $errorMessage;
			0 ignored issues – show Bug Best Practice introduced 2020-06-23 15:20 UTC by Report Bug Copy Issue Report The property `errorMessage` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
171			}
172			}
173

alexdodonov / mezon-application

Push — master ( 0ea0cc...2ded10 )

Presenter::getParamsFetcher() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like