HashIdTrait::decode() - Code Metrics - Inspection of "hide real ID in the messages after a delete operat..." - Porto-SAP/Hello-API - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6a0d35...e50528 )

by Mahmoud

created 2017-03-02 15:30 UTC

HashIdTrait::decode() A

↳ Parent: HashIdTrait

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace App\Ship\Engine\Traits;

use App\Ship\Features\Exceptions\IncorrectIdException;
use Illuminate\Support\Facades\Config;
use Route;
use Vinkla\Hashids\Facades\Hashids;

/**
 * Class HashIdTrait.
 *
 * @author  Mahmoud Zalt <[email protected]>
 */
trait HashIdTrait
{

    /**
     * endpoint to be skipped from decoding their ID's (example for external ID's)
     * @var  array
     */
    private $skippedEndpoints = [
//        'orders/{id}/external',
    ];

    /**
     * All ID's passed with all endpoints will be decoded before entering the Application
     */
    public function runEndpointsHashedIdsDecoder()
    {
        if (Config::get('hello.hash-id')) {
            Route::bind('id', function ($id, $route) {
                // skip decoding some endpoints
                if (!in_array($route->uri(), $this->skippedEndpoints)) {

                    // decode the ID in the URL
                    $decoded = $this->decoder($id);

                    if (empty($decoded)) {
                        throw new IncorrectIdException('ID (' . $id . ') is incorrect, consider using the hashed ID 
                        instead of the numeric ID.');
                    }

                    return $decoded[0];
                }
            });
        }
    }

    /**
     * Will be used by the Eloquent Models (since it's used as trait there).
     *
     * @param null $key
     *
     * @return  mixed
     */
    public function getHashedKey($key = null)
    {
        // hash the ID only if hash-id enabled in the config
        if (Config::get('hello.hash-id')) {
            return $this->encoder(($key) ? : $this->getKey());
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }

        return $this->getKey();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }


    /**
     * without decoding the encoded ID's you won't be able to use
     * validation features like `exists:table,id`
     *
     * @param array $requestData
     *
     * @return  array
     */
    protected function decodeHashedIdsBeforeApplyingValidationRules(Array $requestData)
    {
        // the hash ID feature must be enabled to use this decoder feature.
        if (Config::get('hello.hash-id') && isset($this->decode) && !empty($this->decode)) {

            foreach ($this->decode as $id) {
class MyClass { }

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

                if (isset($requestData[$id])) {
                    // validate the user is not trying to pass real ID
                    if (is_numeric($requestData[$id])) {
                        throw new IncorrectIdException('Only Hashed ID\'s allowed to be passed.');
                    }

                    $requestData[$id] = is_array($requestData[$id]) ?
                        $this->decodeArray($requestData[$id]) : $this->decode($requestData[$id]);

                } // do nothing if the input is incorrect, because what if it's not required!
            }
        }

        return $requestData;
    }

    /**
     * @param array $ids
     *
     * @return  array
     */
    public function decodeArray(array $ids)
    {
        $result = [];
        foreach ($ids as $id) {
            $result[] = $this->decode($id);
        }

        return $result;
    }

    /**
     * @param $id
     *
     * @return  mixed
     */
    public function decode($id)
    {
        $decoded = $this->decoder($id);

        return is_array($decoded) ? $decoded[0] : $decoded;
    }

    /**
     * @param $id
     *
     * @return  mixed
     */
    public function encode($id)
    {
        return $this->encoder($id);
    }

    /**
     * @param $id
     *
     * @return  mixed
     */
    private function decoder($id)
    {
        return Hashids::decode($id);
    }

    /**
     * @param $id
     *
     * @return  mixed
     */
    public function encoder($id)
    {
        return Hashids::encode($id);
    }

}


1			<?php
2
3			namespace App\Ship\Engine\Traits;
4
5			use App\Ship\Features\Exceptions\IncorrectIdException;
6			use Illuminate\Support\Facades\Config;
7			use Route;
8			use Vinkla\Hashids\Facades\Hashids;
9
10			/**
11			* Class HashIdTrait.
12			*
13			* @author Mahmoud Zalt <[email protected]>
14			*/
15			trait HashIdTrait
16			{
17
18			/**
19			* endpoint to be skipped from decoding their ID's (example for external ID's)
20			* @var array
21			*/
22			private $skippedEndpoints = [
23			// 'orders/{id}/external',
24			];
25
26			/**
27			* All ID's passed with all endpoints will be decoded before entering the Application
28			*/
29			public function runEndpointsHashedIdsDecoder()
30			{
31			if (Config::get('hello.hash-id')) {
32			Route::bind('id', function ($id, $route) {
33			// skip decoding some endpoints
34			if (!in_array($route->uri(), $this->skippedEndpoints)) {
35
36			// decode the ID in the URL
37			$decoded = $this->decoder($id);
38
39			if (empty($decoded)) {
40			throw new IncorrectIdException('ID (' . $id . ') is incorrect, consider using the hashed ID
41			instead of the numeric ID.');
42			}
43
44			return $decoded[0];
45			}
46			});
47			}
48			}
49
50			/**
51			* Will be used by the Eloquent Models (since it's used as trait there).
52			*
53			* @param null $key
54			*
55			* @return mixed
56			*/
57			public function getHashedKey($key = null)
58			{
59			// hash the ID only if hash-id enabled in the config
60			if (Config::get('hello.hash-id')) {
61			return $this->encoder(($key) ? : $this->getKey());
			0 ignored issues – show Bug introduced 2016-12-01 19:55 UTC by Report Bug Copy Issue Report It seems like `getKey()` 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...
62			}
63
64			return $this->getKey();
			0 ignored issues – show Bug introduced 2016-12-01 19:55 UTC by Report Bug Copy Issue Report It seems like `getKey()` 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...
65			}
66
67
68			/**
69			* without decoding the encoded ID's you won't be able to use
70			* validation features like `exists:table,id`
71			*
72			* @param array $requestData
73			*
74			* @return array
75			*/
76			protected function decodeHashedIdsBeforeApplyingValidationRules(Array $requestData)
77			{
78			// the hash ID feature must be enabled to use this decoder feature.
79			if (Config::get('hello.hash-id') && isset($this->decode) && !empty($this->decode)) {
80
81			foreach ($this->decode as $id) {
			0 ignored issues – show Bug introduced 2017-02-09 23:45 UTC by Report Bug Copy Issue Report The property `decode` 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...
82
83			if (isset($requestData[$id])) {
84			// validate the user is not trying to pass real ID
85			if (is_numeric($requestData[$id])) {
86			throw new IncorrectIdException('Only Hashed ID\'s allowed to be passed.');
87			}
88
89			$requestData[$id] = is_array($requestData[$id]) ?
90			$this->decodeArray($requestData[$id]) : $this->decode($requestData[$id]);
91
92			} // do nothing if the input is incorrect, because what if it's not required!
93			}
94			}
95
96			return $requestData;
97			}
98
99			/**
100			* @param array $ids
101			*
102			* @return array
103			*/
104			public function decodeArray(array $ids)
105			{
106			$result = [];
107			foreach ($ids as $id) {
108			$result[] = $this->decode($id);
109			}
110
111			return $result;
112			}
113
114			/**
115			* @param $id
116			*
117			* @return mixed
118			*/
119			public function decode($id)
120			{
121			$decoded = $this->decoder($id);
122
123			return is_array($decoded) ? $decoded[0] : $decoded;
124			}
125
126			/**
127			* @param $id
128			*
129			* @return mixed
130			*/
131			public function encode($id)
132			{
133			return $this->encoder($id);
134			}
135
136			/**
137			* @param $id
138			*
139			* @return mixed
140			*/
141			private function decoder($id)
142			{
143			return Hashids::decode($id);
144			}
145
146			/**
147			* @param $id
148			*
149			* @return mixed
150			*/
151			public function encoder($id)
152			{
153			return Hashids::encode($id);
154			}
155
156			}
157

Porto-SAP / Hello-API

Push — master ( 6a0d35...e50528 )

HashIdTrait::decode() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like