ServiceBase::getLogics() - Code Metrics - Inspection of "feature/Refactoring, unit-tests were improved" - alexdodonov/mezon-service - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 464b66...8b88c7 )

by Alex

created 2021-10-16 12:19 UTC

ServiceBase::getLogics() A

↳ Parent: ServiceBase

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php
namespace Mezon\Service;

use Mezon\Security\ProviderInterface;
use Mezon\Service\ServiceRestTransport\ServiceRestTransport;

/**
 * Class Service
 *
 * @package Mezon
 * @subpackage ServiceBase
 * @author Dodonov A.A.
 * @version v.1.0 (2019/12/09)
 * @copyright Copyright (c) 2019, aeon.org
 */

/**
 * Base service class
 *
 * It bounds together transport, request parameters fetcher, logic, authorization and model
 *
 * @author Dodonov A.A.
 */
class ServiceBase
{

    /**
     * Service's ransport
     *
     * @var object Service transport object
     */
    private $serviceTransport = false;

    /**
     * Service's logic
     *
     * @var array Login object or list of logic objects
     */
    private $serviceLogic = false;


    /**
     * Constructor
     *
     * @param ServiceBaseLogic $serviceLogic
     *            service's logic
     * @param ServiceModel $serviceModel
     *            service's model
     * @param ProviderInterface $securityProvider
     *            service's security provider
     * @param TransportInterface $serviceTransport
     *            service's transport
     */
    public function __construct(
        ServiceBaseLogic $serviceLogic,
        ServiceModel $serviceModel,
        ProviderInterface $securityProvider,
        TransportInterface $serviceTransport)
    {
        try {
            $this->initTransport($serviceTransport, $securityProvider);

            $this->initServiceLogic($serviceLogic, $serviceModel);

            $this->initCustomRoutes();

            $this->fetchActions();
        } catch (\Exception $e) {
            $this->getTransport()->handleException($e);
        }
    }

    /**
     * Method fetches actions if they are existing
     */
    protected function fetchActions(): void
    {
        if ($this instanceof ServiceBaseLogicInterface) {
            $this->serviceTransport->fetchActions($this);
        }

        foreach ($this->serviceLogics as $actionsSet) {
            if ($actionsSet instanceof ServiceBaseLogicInterface) {
                $this->serviceTransport->fetchActions($actionsSet);
            }
        }
    }

    /**
     * Method inits service's transport
     *
     * @param mixed $serviceTransport
     *            Service's transport
     * @param mixed $securityProvider
     *            Service's security provider
     */
    protected function initTransport($serviceTransport, $securityProvider): void
    {
        if (is_string($serviceTransport)) {
            $this->serviceTransport = new $serviceTransport($securityProvider);
        } else {
            $this->serviceTransport = $serviceTransport;
        }
    }

    /**
     * Method constructs service logic if necessary
     *
     * @param mixed $serviceLogic
     *            Service logic class name of object itself
     * @param mixed $serviceModel
     *            Service model class name of object itself
     * @return ServiceLogic logic object
     */
    protected function constructServiceLogic($serviceLogic, $serviceModel)
    {
        if (is_string($serviceLogic)) {
            $result = new $serviceLogic(
                $this->serviceTransport->getParamsFetcher(),
                $this->serviceTransport->getSecurityProvider(),
                $serviceModel);
        } else {
            $result = $serviceLogic;
        }

        return $result;
    }

    /**
     * Method inits service's logic
     *
     * @param mixed $serviceLogic
     *            Service's logic
     * @param mixed $serviceModel
     *            Service's Model
     */
    protected function initServiceLogic($serviceLogic, $serviceModel): void
    {
        if (is_array($serviceLogic)) {
            $this->serviceLogics = [];


            foreach ($serviceLogic as $logic) {
                $this->serviceLogics[] = $this->constructServiceLogic($logic, $serviceModel);
            }
        } else {
            $this->serviceLogics = [
                $this->constructServiceLogic($serviceLogic, $serviceModel)
            ];
        }

        $this->serviceTransport->setServiceLogics($this->serviceLogics);
    }

    /**
     * Method inits custom routes if necessary
     */
    protected function initCustomRoutes(): void
    {
        $reflector = new \ReflectionClass(get_class($this));
        $classPath = dirname($reflector->getFileName());

        // TODO make /Conf/...
        if (file_exists($classPath . '/conf/routes.php')) {
            $this->serviceTransport->loadRoutesFromConfig($classPath . '/conf/routes.php');
        }

        if (file_exists($classPath . '/conf/routes.json')) {
            $this->serviceTransport->loadRoutes(json_decode(file_get_contents($classPath . '/conf/routes.json'), true));
        }
    }

    /**
     * Running $this->serviceTransport run loop
     */
    public function run(): void
    {
        $this->serviceTransport->run();
    }

    /**
     * Method sets transport
     *
     * @param Transport $transport
     */
    public function setTransport(Transport $transport): void
    {
        $this->serviceTransport = $transport;
    }

    /**
     * Method returns transport
     *
     * @return Transport
     */
    public function getTransport(): Transport
    {
        return $this->serviceTransport;
    }

    /**
     * Method returns logic objects
     *
     * @return ServiceLogic[]
     */
    public function getLogics()
    {
        return $this->serviceLogics;
    }
}


1			<?php
2			namespace Mezon\Service;
3
4			use Mezon\Security\ProviderInterface;
5			use Mezon\Service\ServiceRestTransport\ServiceRestTransport;
6
7			/**
8			* Class Service
9			*
10			* @package Mezon
11			* @subpackage ServiceBase
12			* @author Dodonov A.A.
13			* @version v.1.0 (2019/12/09)
14			* @copyright Copyright (c) 2019, aeon.org
15			*/
16
17			/**
18			* Base service class
19			*
20			* It bounds together transport, request parameters fetcher, logic, authorization and model
21			*
22			* @author Dodonov A.A.
23			*/
24			class ServiceBase
25			{
26
27			/**
28			* Service's ransport
29			*
30			* @var object Service transport object
31			*/
32			private $serviceTransport = false;
33
34			/**
35			* Service's logic
36			*
37			* @var array Login object or list of logic objects
38			*/
39			private $serviceLogic = false;
			0 ignored issues – show introduced 2021-10-16 12:22 UTC by Report Bug Copy Issue Report The private property `$serviceLogic` is not used, and could be removed. Loading history...
40
41			/**
42			* Constructor
43			*
44			* @param ServiceBaseLogic $serviceLogic
45			* service's logic
46			* @param ServiceModel $serviceModel
47			* service's model
48			* @param ProviderInterface $securityProvider
49			* service's security provider
50			* @param TransportInterface $serviceTransport
51			* service's transport
52			*/
53			public function __construct(
54			ServiceBaseLogic $serviceLogic,
55			ServiceModel $serviceModel,
56			ProviderInterface $securityProvider,
57			TransportInterface $serviceTransport)
58			{
59			try {
60			$this->initTransport($serviceTransport, $securityProvider);
61
62			$this->initServiceLogic($serviceLogic, $serviceModel);
63
64			$this->initCustomRoutes();
65
66			$this->fetchActions();
67			} catch (\Exception $e) {
68			$this->getTransport()->handleException($e);
69			}
70			}
71
72			/**
73			* Method fetches actions if they are existing
74			*/
75			protected function fetchActions(): void
76			{
77			if ($this instanceof ServiceBaseLogicInterface) {
78			$this->serviceTransport->fetchActions($this);
79			}
80
81			foreach ($this->serviceLogics as $actionsSet) {
82			if ($actionsSet instanceof ServiceBaseLogicInterface) {
83			$this->serviceTransport->fetchActions($actionsSet);
84			}
85			}
86			}
87
88			/**
89			* Method inits service's transport
90			*
91			* @param mixed $serviceTransport
92			* Service's transport
93			* @param mixed $securityProvider
94			* Service's security provider
95			*/
96			protected function initTransport($serviceTransport, $securityProvider): void
97			{
98			if (is_string($serviceTransport)) {
99			$this->serviceTransport = new $serviceTransport($securityProvider);
100			} else {
101			$this->serviceTransport = $serviceTransport;
102			}
103			}
104
105			/**
106			* Method constructs service logic if necessary
107			*
108			* @param mixed $serviceLogic
109			* Service logic class name of object itself
110			* @param mixed $serviceModel
111			* Service model class name of object itself
112			* @return ServiceLogic logic object
113			*/
114			protected function constructServiceLogic($serviceLogic, $serviceModel)
115			{
116			if (is_string($serviceLogic)) {
117			$result = new $serviceLogic(
118			$this->serviceTransport->getParamsFetcher(),
119			$this->serviceTransport->getSecurityProvider(),
120			$serviceModel);
121			} else {
122			$result = $serviceLogic;
123			}
124
125			return $result;
126			}
127
128			/**
129			* Method inits service's logic
130			*
131			* @param mixed $serviceLogic
132			* Service's logic
133			* @param mixed $serviceModel
134			* Service's Model
135			*/
136			protected function initServiceLogic($serviceLogic, $serviceModel): void
137			{
138			if (is_array($serviceLogic)) {
139			$this->serviceLogics = [];
			0 ignored issues – show Bug Best Practice introduced 2021-10-16 12:22 UTC by Report Bug Copy Issue Report The property `serviceLogics` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
140
141			foreach ($serviceLogic as $logic) {
142			$this->serviceLogics[] = $this->constructServiceLogic($logic, $serviceModel);
143			}
144			} else {
145			$this->serviceLogics = [
146			$this->constructServiceLogic($serviceLogic, $serviceModel)
147			];
148			}
149
150			$this->serviceTransport->setServiceLogics($this->serviceLogics);
151			}
152
153			/**
154			* Method inits custom routes if necessary
155			*/
156			protected function initCustomRoutes(): void
157			{
158			$reflector = new \ReflectionClass(get_class($this));
159			$classPath = dirname($reflector->getFileName());
160
161			// TODO make /Conf/...
162			if (file_exists($classPath . '/conf/routes.php')) {
163			$this->serviceTransport->loadRoutesFromConfig($classPath . '/conf/routes.php');
164			}
165
166			if (file_exists($classPath . '/conf/routes.json')) {
167			$this->serviceTransport->loadRoutes(json_decode(file_get_contents($classPath . '/conf/routes.json'), true));
168			}
169			}
170
171			/**
172			* Running $this->serviceTransport run loop
173			*/
174			public function run(): void
175			{
176			$this->serviceTransport->run();
177			}
178
179			/**
180			* Method sets transport
181			*
182			* @param Transport $transport
183			*/
184			public function setTransport(Transport $transport): void
185			{
186			$this->serviceTransport = $transport;
187			}
188
189			/**
190			* Method returns transport
191			*
192			* @return Transport
193			*/
194			public function getTransport(): Transport
195			{
196			return $this->serviceTransport;
197			}
198
199			/**
200			* Method returns logic objects
201			*
202			* @return ServiceLogic[]
203			*/
204			public function getLogics()
205			{
206			return $this->serviceLogics;
207			}
208			}
209

alexdodonov / mezon-service

Push — master ( 464b66...8b88c7 )

ServiceBase::getLogics() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like