Completed
Push — master ( e48769...237d1b )
by Mahmoud
03:04
created

Controller   A

Complexity

Total Complexity 2

Size/Duplication

Total Lines 33
Duplicated Lines 0 %

Coupling/Cohesion

Components 0
Dependencies 4

Importance

Changes 0
Metric Value
wmc 2
c 0
b 0
f 0
lcom 0
cbo 4
dl 0
loc 33
rs 10

2 Methods

Rating   Name   Duplication   Size   Complexity  
A setUserEmailController() 0 8 1
A setVisitorEmailController() 0 8 1
1
<?php
2
3
namespace App\Containers\Email\UI\API\Controllers;
4
5
use App\Containers\Email\Actions\SetUserEmailWithConfirmationAction;
6
use App\Containers\Email\Actions\SetVisitorEmailAction;
7
use App\Containers\Email\UI\API\Requests\SetUserEmailRequest;
8
use App\Containers\Email\UI\API\Requests\SetVisitorEmailRequest;
9
use App\Port\Controller\Abstracts\PortApiController;
10
11
/**
12
 * Class Controller.
13
 *
14
 * @author Mahmoud Zalt <[email protected]>
15
 */
16
class Controller extends PortApiController
17
{
18
19
    /**
20
     * @param \App\Containers\Email\UI\API\Requests\SetEmailRequest $request
21
     * @param \App\Containers\Email\Actions\SetUserEmailWithConfirmationAction   $action
22
     *
23
     * @return  \Dingo\Api\Http\Response
24
     */
25
    public function setUserEmailController(SetUserEmailRequest $request, SetUserEmailWithConfirmationAction $action)
26
    {
27
        $action->run($request->email);
0 ignored issues
show
Documentation introduced by
The property email does not exist on object<App\Containers\Em...ts\SetUserEmailRequest>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
28
29
        return $this->response->accepted(null, [
30
            'message' => 'User Email Saved Successfully.',
31
        ]);
32
    }
33
34
    /**
35
     * @param \App\Containers\Email\UI\API\Requests\SetVisitorEmailRequest $request
36
     * @param \App\Containers\Email\Actions\SetVisitorEmailAction          $action
37
     *
38
     * @return  \Dingo\Api\Http\Response
39
     */
40
    public function setVisitorEmailController(SetVisitorEmailRequest $request, SetVisitorEmailAction $action)
41
    {
42
        $action->run($request->header('visitor-id'), $request->email);
0 ignored issues
show
Documentation introduced by
The property email does not exist on object<App\Containers\Em...SetVisitorEmailRequest>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
43
44
        return $this->response->accepted(null, [
45
            'message' => 'Visitor Email Saved Successfully.',
46
        ]);
47
    }
48
}
49