Completed
Push — master ( de2193...addab9 )
by André
68:04 queued 44:50
created

CreateUserSlot::extractContentId()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 1
eloc 2
c 1
b 0
f 0
nc 1
nop 1
dl 0
loc 4
rs 10
1
<?php
2
3
/**
4
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
5
 * @license For full copyright and license information view LICENSE file distributed with this source code.
6
 */
7
namespace eZ\Publish\Core\MVC\Symfony\Cache\Http\SignalSlot;
8
9
use eZ\Publish\Core\SignalSlot\Signal;
10
11
/**
12
 * A slot handling CreateUserSignal.
13
 */
14
class CreateUserSlot extends PurgeForContentHttpCacheSlot
0 ignored issues
show
Deprecated Code introduced by
The class eZ\Publish\Core\MVC\Symf...ForContentHttpCacheSlot has been deprecated with message: since 6.8. The platform-http-cache package defines slots for http-cache multi-tagging.

This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead.

Loading history...
15
{
16
    /**
17
     * @param \eZ\Publish\Core\SignalSlot\Signal\UserService\CreateUserSignal $signal
18
     */
19
    protected function extractContentId(Signal $signal)
20
    {
21
        return $signal->userId;
0 ignored issues
show
Documentation introduced by
The property userId does not exist on object<eZ\Publish\Core\SignalSlot\Signal>. 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...
22
    }
23
24
    protected function supports(Signal $signal)
25
    {
26
        return $signal instanceof Signal\UserService\CreateUserSignal;
27
    }
28
}
29