Completed
Push — master ( b1f2d3...564d61 )
by Portey
03:39
created

FieldConfig::getArguments()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 2

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 4
ccs 2
cts 2
cp 1
rs 10
cc 2
eloc 2
nc 2
nop 0
crap 2
1
<?php
2
/*
3
* This file is a part of graphql-youshido project.
4
*
5
* @author Alexandr Viniychuk <[email protected]>
6
* created: 11/30/15 1:30 AM
7
*/
8
9
namespace Youshido\GraphQL\Type\Config\Field;
10
11
use Youshido\GraphQL\Type\Config\Config;
12
use Youshido\GraphQL\Type\Config\Traits\ArgumentsAwareTrait;
13
use Youshido\GraphQL\Type\Object\AbstractObjectType;
14
use Youshido\GraphQL\Type\TypeInterface;
15
use Youshido\GraphQL\Type\TypeMap;
16
17
class FieldConfig extends Config
18
{
19
20
    use ArgumentsAwareTrait {
21
        getArguments as traitGetArguments;
22
        getArgument as traitGetArgument;
23
    }
24
25 22
    public function getRules()
26
    {
27
        return [
28 22
            'name'              => ['type' => TypeMap::TYPE_STRING, 'required' => true],
29 22
            'type'              => ['type' => TypeMap::TYPE_ANY, 'required' => true],
30 22
            'args'              => ['type' => TypeMap::TYPE_ARRAY],
31 22
            'required'          => ['type' => TypeMap::TYPE_BOOLEAN],
32 22
            'description'       => ['type' => TypeMap::TYPE_STRING],
33 22
            'resolve'           => ['type' => TypeMap::TYPE_FUNCTION],
34 22
            'isDeprecated'      => ['type' => TypeMap::TYPE_BOOLEAN],
35 22
            'deprecationReason' => ['type' => TypeMap::TYPE_STRING],
36 22
        ];
37 1
    }
38
39 22
    protected function build()
40
    {
41 22
        $this->buildArguments();
42 22
    }
43
44 17
    public function resolve($value = null, $args = [])
45
    {
46 17
        if ($this->issetResolve()) {
47 11
            $resolveFunc = $this->getResolveFunction();
48
49 11
            return $resolveFunc($value, $args);
50
        }
51
52 9
        return $this->getType()->resolve($value, $args);
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Youshido\GraphQL\Type\TypeInterface as the method resolve() does only exist in the following implementations of said interface: Youshido\GraphQL\Introspection\DirectiveListType, Youshido\GraphQL\Introspection\DirectiveType, Youshido\GraphQL\Introspection\EnumValueListType, Youshido\GraphQL\Introspection\EnumValueType, Youshido\GraphQL\Introspection\FieldListType, Youshido\GraphQL\Introspection\FieldType, Youshido\GraphQL\Introspection\InputValueListType, Youshido\GraphQL\Introspection\InputValueType, Youshido\GraphQL\Introspection\InterfaceListType, Youshido\GraphQL\Introspection\MutationType, Youshido\GraphQL\Introspection\QueryListType, Youshido\GraphQL\Introspection\QueryType, Youshido\GraphQL\Introspection\SchemaType, Youshido\GraphQL\Introspection\TypeDefinitionType, Youshido\GraphQL\Type\ListType\AbstractListType, Youshido\GraphQL\Type\ListType\ListType, Youshido\GraphQL\Type\Object\AbstractEnumType, Youshido\GraphQL\Type\Ob...AbstractInputObjectType, Youshido\GraphQL\Type\Object\AbstractMutationType, Youshido\GraphQL\Type\Object\AbstractObjectType, Youshido\GraphQL\Type\Object\AbstractUnionType, Youshido\GraphQL\Type\Object\EnumType, Youshido\GraphQL\Type\Object\InputObjectType, Youshido\GraphQL\Type\Object\ObjectType, Youshido\Tests\DataProvider\UserType, Youshido\Tests\StarWars\Schema\DroidType, Youshido\Tests\StarWars\Schema\EpisodeEnum, Youshido\Tests\StarWars\Schema\HumanType, Youshido\Tests\StarWars\Schema\QueryType, Youshido\Tests\Type\Union\Schema\FirstType, Youshido\Tests\Type\Union\Schema\QueryType, Youshido\Tests\Type\Union\Schema\SecondType, Youshido\Tests\Type\Union\Schema\TestUnionType.

Let’s take a look at an example:

interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
53
    }
54
55
    /**
56
     * @return null|callable
57
     */
58 17
    public function getResolveFunction()
59
    {
60 17
        return $this->get('resolve', null);
61
    }
62
63 17
    public function issetResolve()
64
    {
65 17
        $resolveFunction = $this->getResolveFunction();
66
67 17
        return $resolveFunction && is_callable($resolveFunction);
68
    }
69
70
    /**
71
     * @return TypeInterface|AbstractObjectType
72
     */
73 21
    public function getType()
74
    {
75 21
        return $this->data['type'];
76
    }
77
78 6
    public function getArgument($name)
79
    {
80 6
        return $this->traitGetArgument($name) ?: $this->getType()->getConfig()->getArgument($name);
81
    }
82
83
    /**
84
     * @return \Youshido\GraphQL\Type\Field\InputField[]
85
     */
86 19
    public function getArguments()
87
    {
88 19
        return $this->traitGetArguments() ?: $this->getType()->getConfig()->getArguments();
89
    }
90
91
}