SampleAppController::argumentActionGet() - Code Metrics - Inspection of "Add test cases." - canax/controller - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2e7054...27b789 )

by Mikael

created 2019-04-24 18:12 UTC

SampleAppController::argumentActionGet() A

↳ Parent: SampleAppController

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?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.
 *
 * @SuppressWarnings(PHPMD.TooManyPublicMethods)
 */
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		* @SuppressWarnings(PHPMD.TooManyPublicMethods)
20		*/
21		class SampleAppController implements AppInjectableInterface
22		{
23		use AppInjectableTrait;
24
25
26
27		/**
28		* @var string $db a sample member variable that gets initialised
29		*/
30		private $db = "not active";
31
32
33
34		/**
35		* The initialize method is optional and will always be called before the
36		* target method/action. This is a convienient method where you could
37		* setup internal properties that are commonly used by several methods.
38		*
39		* @return void
40		*/
41	10	public function initialize() : void
42		{
43		// Use to initialise member variables.
44	10	$this->db = "active";
45
46		// Use $this->app to access the framework services.
47	10	}
48
49
50
51		/**
52		* This is the index method action, it handles:
53		* ANY METHOD mountpoint
54		* ANY METHOD mountpoint/
55		* ANY METHOD mountpoint/index
56		*
57		* @return string
58		*/
59	1	public function indexAction() : string
60		{
61		// Deal with the action and return a response.
62	1	return __METHOD__ . ", \$db is {$this->db}";
63		}
64
65
66
67		/**
68		* This sample method dumps the content of $app.
69		* GET mountpoint/dump-app
70		*
71		* @return string
72		*/
73	1	public function dumpAppActionGet() : string
74		{
75		// Deal with the action and return a response.
76	1	$services = implode(", ", $this->app->getServices());
77	1	return __METHOD__ . "<p>\$app contains: $services";
78		}
79
80
81
82		/**
83		* Add the request method to the method name to limit what request methods
84		* the handler supports.
85		* GET mountpoint/info
86		*
87		* @return string
88		*/
89	1	public function infoActionGet() : string
90		{
91		// Deal with the action and return a response.
92	1	return __METHOD__ . ", \$db is {$this->db}";
93		}
94
95
96
97		/**
98		* This sample method action it the handler for route:
99		* GET mountpoint/create
100		*
101		* @return string
102		*/
103	1	public function createActionGet() : string
104		{
105		// Deal with the action and return a response.
106	1	return __METHOD__ . ", \$db is {$this->db}";
107		}
108
109
110
111		/**
112		* This sample method action it the handler for route:
113		* POST mountpoint/create
114		*
115		* @return string
116		*/
117	1	public function createActionPost() : string
118		{
119		// Deal with the action and return a response.
120	1	return __METHOD__ . ", \$db is {$this->db}";
121		}
122
123
124
125		/**
126		* This sample method action takes one argument:
127		* GET mountpoint/argument/<value>
128		*
129		* @param mixed $value
130		*
131		* @return string
132		*/
133	1	public function argumentActionGet($value) : string
134		{
135		// Deal with the action and return a response.
136	1	return __METHOD__ . ", \$db is {$this->db}, got argument '$value'";
137		}
138
139
140
141		/**
142		* This sample method action takes zero or one argument and you can use - as a separator which will then be removed:
143		* GET mountpoint/defaultargument/
144		* GET mountpoint/defaultargument/<value>
145		* GET mountpoint/default-argument/
146		* GET mountpoint/default-argument/<value>
147		*
148		* @param mixed $value with a default string.
149		*
150		* @return string
151		*/
152	1	public function defaultArgumentActionGet($value = "default") : string
153		{
154		// Deal with the action and return a response.
155	1	return __METHOD__ . ", \$db is {$this->db}, got argument '$value'";
156		}
157
158
159
160		/**
161		* This sample method action takes two typed arguments:
162		* GET mountpoint/typed-argument/<string>/<int>
163		*
164		* NOTE. Its recommended to not use int as type since it will still
165		* accept numbers such as 2hundred givving a PHP NOTICE. So, its better to
166		* deal with type check within the action method and throuw exceptions
167		* when the expected type is not met.
168		*
169		* @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...
170		*
171		* @return string
172		*/
173	1	public function typedArgumentActionGet(string $str, int $int) : string
174		{
175		// Deal with the action and return a response.
176	1	return __METHOD__ . ", \$db is {$this->db}, got string argument '$str' and int argument '$int'.";
177		}
178
179
180
181		/**
182		* This sample method action takes a variadic list of arguments:
183		* GET mountpoint/variadic/
184		* GET mountpoint/variadic/<value>
185		* GET mountpoint/variadic/<value>/<value>
186		* GET mountpoint/variadic/<value>/<value>/<value>
187		* etc.
188		*
189		* @param array $value as a variadic parameter.
190		*
191		* @return string
192		*/
193	1	public function variadicActionGet(...$value) : string
194		{
195		// Deal with the action and return a response.
196	1	return __METHOD__ . ", \$db is {$this->db}, got '" . count($value) . "' arguments: " . implode(", ", $value);
197		}
198
199
200
201		/**
202		* Adding an optional catchAll() method will catch all actions sent to the
203		* router. You can then reply with an actual response or return void to
204		* allow for the router to move on to next handler.
205		* A catchAll() handles the following, if a specific action method is not
206		* created:
207		* ANY METHOD mountpoint/**
208		*
209		* @param array $args as a variadic parameter.
210		*
211		* @return mixed
212		*
213		* @SuppressWarnings(PHPMD.UnusedFormalParameter)
214		*/
215	1	public function catchAll(...$args)
		0 ignored issues – show Unused Code introduced 2018-08-15 09:46 UTC by Report Bug Copy Issue Report The parameter `$args` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
216		{
217		// Deal with the request and send an actual response, or not.
218		//return __METHOD__ . ", \$db is {$this->db}, got '" . count($args) . "' arguments: " . implode(", ", $args);
219	1	return;
220		}
221		}
222

canax / controller

Push — master ( 2e7054...27b789 )

SampleAppController::argumentActionGet() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like