SampleAppController::defaultArgumentActionGet() - Code Metrics - Inspection of "Add controller class SampleAppController for app-s..." - canax/controller - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 932e32...be0a32 )

by Mikael

created 2018-09-25 17:28 UTC

SampleAppController::defaultArgumentActionGet() A

↳ Parent: SampleAppController

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	5
Ratio	100 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	5
loc	5
ccs	0
cts	4
cp	0
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	2

<?php

namespace Anax\Controller;

use Anax\Commons\AppInjectableInterface;
use Anax\Commons\AppInjectableTrait;

// use Anax\Route\Exception\ForbiddenException;
// use Anax\Route\Exception\NotFoundException;
// use Anax\Route\Exception\InternalErrorException;

/**
 * A sample controller to show how a controller class can be implemented.
 * The controller will be injected with $app if implementing the interface
 * AppInjectableInterface, like this sample class does.
 * The controller is mounted on a particular route and can then handle all
 * requests for that mount point.
 */
class SampleAppController implements AppInjectableInterface

{
    use AppInjectableTrait;



    /**
     * @var string $db a sample member variable that gets initialised
     */
    private $db = "not active";



    /**
     * The initialize method is optional and will always be called before the
     * target method/action. This is a convienient method where you could
     * setup internal properties that are commonly used by several methods.
     *
     * @return void
     */
    public function initialize() : void
    {
        // Use to initialise member variables.
        $this->db = "active";

        // Use $this->app to access the framework services.
    }



    /**
     * This is the index method action, it handles:
     * ANY METHOD mountpoint
     * ANY METHOD mountpoint/
     * ANY METHOD mountpoint/index
     *
     * @return string
     */
    public function indexAction() : string
    {
        // Deal with the action and return a response.
        return __METHOD__ . ", \$db is {$this->db}";
    }



    /**
     * This sample method dumps the content of $app.
     * GET mountpoint/dump-app
     *
     * @return string
     */
    public function dumpAppActionGet() : string
    {
        // Deal with the action and return a response.
        $services = implode(", ", $this->app->getServices());
        return __METHOD__ . "<p>\$app contains: $services";
    }



    /**
     * Add the request method to the method name to limit what request methods
     * the handler supports.
     * GET mountpoint/info
     *
     * @return string
     */
    public function infoActionGet() : string
    {
        // Deal with the action and return a response.
        return __METHOD__ . ", \$db is {$this->db}";
    }



    /**
     * This sample method action it the handler for route:
     * GET mountpoint/create
     *
     * @return string
     */
    public function createActionGet() : string
    {
        // Deal with the action and return a response.
        return __METHOD__ . ", \$db is {$this->db}";
    }



    /**
     * This sample method action it the handler for route:
     * POST mountpoint/create
     *
     * @return string
     */
    public function createActionPost() : string
    {
        // Deal with the action and return a response.
        return __METHOD__ . ", \$db is {$this->db}";
    }



    /**
     * This sample method action takes one argument:
     * GET mountpoint/argument/<value>
     *
     * @param mixed $value
     *
     * @return string
     */
    public function argumentActionGet($value) : string
    {
        // Deal with the action and return a response.
        return __METHOD__ . ", \$db is {$this->db}, got argument '$value'";
    }



    /**
     * This sample method action takes zero or one argument and you can use - as a separator which will then be removed:
     * GET mountpoint/defaultargument/
     * GET mountpoint/defaultargument/<value>
     * GET mountpoint/default-argument/
     * GET mountpoint/default-argument/<value>
     *
     * @param mixed $value with a default string.
     *
     * @return string
     */
    public function defaultArgumentActionGet($value = "default") : string
    {
        // Deal with the action and return a response.
        return __METHOD__ . ", \$db is {$this->db}, got argument '$value'";
    }



    /**
     * This sample method action takes two typed arguments:
     * GET mountpoint/typed-argument/<string>/<int>
     *
     * NOTE. Its recommended to not use int as type since it will still
     * accept numbers such as 2hundred givving a PHP NOTICE. So, its better to
     * deal with type check within the action method and throuw exceptions
     * when the expected type is not met.
     *
     * @param mixed $value with a default string.
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return string
     */
    public function typedArgumentActionGet(string $str, int $int) : string
    {
        // Deal with the action and return a response.
        return __METHOD__ . ", \$db is {$this->db}, got string argument '$str' and int argument '$int'.";
    }



    /**
     * This sample method action takes a variadic list of arguments:
     * GET mountpoint/variadic/
     * GET mountpoint/variadic/<value>
     * GET mountpoint/variadic/<value>/<value>
     * GET mountpoint/variadic/<value>/<value>/<value>
     * etc.
     *
     * @param array $value as a variadic parameter.
     *
     * @return string
     */
    public function variadicActionGet(...$value) : string
    {
        // Deal with the action and return a response.
        return __METHOD__ . ", \$db is {$this->db}, got '" . count($value) . "' arguments: " . implode(", ", $value);
    }



    /**
     * Adding an optional catchAll() method will catch all actions sent to the
     * router. YOu can then reply with an actual response or return void to
     * allow for the router to move on to next handler.
     * A catchAll() handles the following, if a specific action method is not
     * created:
     * ANY METHOD mountpoint/**
     *
     * @param array $args as a variadic parameter.
     *
     * @return mixed
     *
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
    public function catchAll(...$args)
    {
        // Deal with the request and send an actual response, or not.
        //return __METHOD__ . ", \$db is {$this->db}, got '" . count($args) . "' arguments: " . implode(", ", $args);
        return;
    }
}


1		<?php
2
3		namespace Anax\Controller;
4
5		use Anax\Commons\AppInjectableInterface;
6		use Anax\Commons\AppInjectableTrait;
7
8		// use Anax\Route\Exception\ForbiddenException;
9		// use Anax\Route\Exception\NotFoundException;
10		// use Anax\Route\Exception\InternalErrorException;
11
12		/**
13		* A sample controller to show how a controller class can be implemented.
14		* The controller will be injected with $app if implementing the interface
15		* AppInjectableInterface, like this sample class does.
16		* The controller is mounted on a particular route and can then handle all
17		* requests for that mount point.
18		*/
19	View Code Duplication	class SampleAppController implements AppInjectableInterface
		0 ignored issues – show Duplication introduced 2018-09-25 17:31 UTC by Report Bug Copy Issue Report This class seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
20		{
21		use AppInjectableTrait;
22
23
24
25		/**
26		* @var string $db a sample member variable that gets initialised
27		*/
28		private $db = "not active";
29
30
31
32		/**
33		* The initialize method is optional and will always be called before the
34		* target method/action. This is a convienient method where you could
35		* setup internal properties that are commonly used by several methods.
36		*
37		* @return void
38		*/
39		public function initialize() : void
40		{
41		// Use to initialise member variables.
42		$this->db = "active";
43
44		// Use $this->app to access the framework services.
45		}
46
47
48
49		/**
50		* This is the index method action, it handles:
51		* ANY METHOD mountpoint
52		* ANY METHOD mountpoint/
53		* ANY METHOD mountpoint/index
54		*
55		* @return string
56		*/
57		public function indexAction() : string
58		{
59		// Deal with the action and return a response.
60		return __METHOD__ . ", \$db is {$this->db}";
61		}
62
63
64
65		/**
66		* This sample method dumps the content of $app.
67		* GET mountpoint/dump-app
68		*
69		* @return string
70		*/
71		public function dumpAppActionGet() : string
72		{
73		// Deal with the action and return a response.
74		$services = implode(", ", $this->app->getServices());
75		return __METHOD__ . "<p>\$app contains: $services";
76		}
77
78
79
80		/**
81		* Add the request method to the method name to limit what request methods
82		* the handler supports.
83		* GET mountpoint/info
84		*
85		* @return string
86		*/
87		public function infoActionGet() : string
88		{
89		// Deal with the action and return a response.
90		return __METHOD__ . ", \$db is {$this->db}";
91		}
92
93
94
95		/**
96		* This sample method action it the handler for route:
97		* GET mountpoint/create
98		*
99		* @return string
100		*/
101		public function createActionGet() : string
102		{
103		// Deal with the action and return a response.
104		return __METHOD__ . ", \$db is {$this->db}";
105		}
106
107
108
109		/**
110		* This sample method action it the handler for route:
111		* POST mountpoint/create
112		*
113		* @return string
114		*/
115		public function createActionPost() : string
116		{
117		// Deal with the action and return a response.
118		return __METHOD__ . ", \$db is {$this->db}";
119		}
120
121
122
123		/**
124		* This sample method action takes one argument:
125		* GET mountpoint/argument/<value>
126		*
127		* @param mixed $value
128		*
129		* @return string
130		*/
131		public function argumentActionGet($value) : string
132		{
133		// Deal with the action and return a response.
134		return __METHOD__ . ", \$db is {$this->db}, got argument '$value'";
135		}
136
137
138
139		/**
140		* This sample method action takes zero or one argument and you can use - as a separator which will then be removed:
141		* GET mountpoint/defaultargument/
142		* GET mountpoint/defaultargument/<value>
143		* GET mountpoint/default-argument/
144		* GET mountpoint/default-argument/<value>
145		*
146		* @param mixed $value with a default string.
147		*
148		* @return string
149		*/
150		public function defaultArgumentActionGet($value = "default") : string
151		{
152		// Deal with the action and return a response.
153		return __METHOD__ . ", \$db is {$this->db}, got argument '$value'";
154		}
155
156
157
158		/**
159		* This sample method action takes two typed arguments:
160		* GET mountpoint/typed-argument/<string>/<int>
161		*
162		* NOTE. Its recommended to not use int as type since it will still
163		* accept numbers such as 2hundred givving a PHP NOTICE. So, its better to
164		* deal with type check within the action method and throuw exceptions
165		* when the expected type is not met.
166		*
167		* @param mixed $value with a default string.
		0 ignored issues – show Bug introduced 2018-08-15 09:46 UTC by Report Bug Copy Issue Report There is no parameter named `$value`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
168		*
169		* @return string
170		*/
171		public function typedArgumentActionGet(string $str, int $int) : string
172		{
173		// Deal with the action and return a response.
174		return __METHOD__ . ", \$db is {$this->db}, got string argument '$str' and int argument '$int'.";
175		}
176
177
178
179		/**
180		* This sample method action takes a variadic list of arguments:
181		* GET mountpoint/variadic/
182		* GET mountpoint/variadic/<value>
183		* GET mountpoint/variadic/<value>/<value>
184		* GET mountpoint/variadic/<value>/<value>/<value>
185		* etc.
186		*
187		* @param array $value as a variadic parameter.
188		*
189		* @return string
190		*/
191		public function variadicActionGet(...$value) : string
192		{
193		// Deal with the action and return a response.
194		return __METHOD__ . ", \$db is {$this->db}, got '" . count($value) . "' arguments: " . implode(", ", $value);
195		}
196
197
198
199		/**
200		* Adding an optional catchAll() method will catch all actions sent to the
201		* router. YOu can then reply with an actual response or return void to
202		* allow for the router to move on to next handler.
203		* A catchAll() handles the following, if a specific action method is not
204		* created:
205		* ANY METHOD mountpoint/**
206		*
207		* @param array $args as a variadic parameter.
208		*
209		* @return mixed
210		*
211		* @SuppressWarnings(PHPMD.UnusedFormalParameter)
212		*/
213		public function catchAll(...$args)
214		{
215		// Deal with the request and send an actual response, or not.
216		//return __METHOD__ . ", \$db is {$this->db}, got '" . count($args) . "' arguments: " . implode(", ", $args);
217		return;
218		}
219		}
220

canax / controller

Push — master ( 932e32...be0a32 )

SampleAppController::defaultArgumentActionGet() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like