ApiUpdateActionTrait::configureParams() - Code Metrics - Inspection of "run `keeko magic`" - keeko/core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d6a6e9...1d4c8e )

by Thomas

created 2016-03-07 17:09 UTC

ApiUpdateActionTrait::configureParams() A

↳ Parent: ApiUpdateActionTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php
namespace keeko\core\action\base;

use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\OptionsResolver\OptionsResolver;
use phootwork\json\Json;
use keeko\core\model\Api;
use keeko\core\model\ApiQuery;
use keeko\framework\exceptions\ValidationException;
use Symfony\Component\Routing\Exception\ResourceNotFoundException;

/**
 * Base methods for keeko\core\action\ApiUpdateAction
 * 
 * This code is automatically created. Modifications will probably be overwritten.
 * 
 * @author gossi
 */
trait ApiUpdateActionTrait {

	/**
	 * @param OptionsResolver $resolver
	 */
	public function configureParams(OptionsResolver $resolver) {
		$resolver->setRequired(['id']);
	}

	/**
	 * Automatically generated run method
	 * 
	 * @param Request $request
	 * @return Response
	 */
	public function run(Request $request) {
		// read
		$id = $this->getParam('id');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
		$api = ApiQuery::create()->findOneById($id);

		// check existence
		if ($api === null) {
			throw new ResourceNotFoundException('Api not found.');
		}

		// hydrate
		$data = Json::decode($request->getContent());

		$serializer = Api::getSerializer();
		$api = $serializer->hydrate($api, $data);

		// validate
		if (!$api->validate()) {
			throw new ValidationException($api->getValidationFailures());
		} else {
			$api->save();
			return $this->response->run($request, $api);
class MyClass { }

$x = new MyClass();
$x->foo = true;
		}
	}
}


1			<?php
2			namespace keeko\core\action\base;
3
4			use Symfony\Component\HttpFoundation\Request;
5			use Symfony\Component\HttpFoundation\Response;
6			use Symfony\Component\OptionsResolver\OptionsResolver;
7			use phootwork\json\Json;
8			use keeko\core\model\Api;
9			use keeko\core\model\ApiQuery;
10			use keeko\framework\exceptions\ValidationException;
11			use Symfony\Component\Routing\Exception\ResourceNotFoundException;
12
13			/**
14			* Base methods for keeko\core\action\ApiUpdateAction
15			*
16			* This code is automatically created. Modifications will probably be overwritten.
17			*
18			* @author gossi
19			*/
20			trait ApiUpdateActionTrait {
21
22			/**
23			* @param OptionsResolver $resolver
24			*/
25			public function configureParams(OptionsResolver $resolver) {
26			$resolver->setRequired(['id']);
27			}
28
29			/**
30			* Automatically generated run method
31			*
32			* @param Request $request
33			* @return Response
34			*/
35			public function run(Request $request) {
36			// read
37			$id = $this->getParam('id');
			0 ignored issues – show Bug introduced 2016-03-07 17:19 UTC by Report Bug Copy Issue Report It seems like `getParam()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
38			$api = ApiQuery::create()->findOneById($id);
39
40			// check existence
41			if ($api === null) {
42			throw new ResourceNotFoundException('Api not found.');
43			}
44
45			// hydrate
46			$data = Json::decode($request->getContent());
			1 ignored issue – show Bug introduced 2016-03-07 17:19 UTC by Report Bug Copy Issue Report It seems like `$request->getContent()` targeting `Symfony\Component\HttpFo...n\Request::getContent()` can also be of type `resource`; however, `phootwork\json\Json::decode()` does only seem to accept `string`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
47			$serializer = Api::getSerializer();
48			$api = $serializer->hydrate($api, $data);
49
50			// validate
51			if (!$api->validate()) {
52			throw new ValidationException($api->getValidationFailures());
53			} else {
54			$api->save();
55			return $this->response->run($request, $api);
			0 ignored issues – show Bug introduced 2016-03-07 17:19 UTC by Report Bug Copy Issue Report The property `response` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
56			}
57			}
58			}
59

keeko / core

Push — master ( d6a6e9...1d4c8e )

ApiUpdateActionTrait::configureParams() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like