AvatarHelper::currentUserSmall()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 6
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 3
nc 1
nop 1
dl 0
loc 6
rs 9.4285
c 0
b 0
f 0
1
<?php
2
3
/*
4
 * This file is part of Jitamin.
5
 *
6
 * Copyright (C) Jitamin Team
7
 *
8
 * For the full copyright and license information, please view the LICENSE
9
 * file that was distributed with this source code.
10
 */
11
12
namespace Jitamin\Helper;
13
14
use Jitamin\Foundation\Base;
15
16
/**
17
 * Avatar Helper.
18
 */
19
class AvatarHelper extends Base
20
{
21
    /**
22
     * Render user avatar.
23
     *
24
     * @param string $user_id
25
     * @param string $username
26
     * @param string $name
27
     * @param string $email
28
     * @param string $avatar_path
29
     * @param string $css
30
     * @param int    $size
31
     *
32
     * @return string
33
     */
34
    public function render($user_id, $username, $name, $email, $avatar_path, $css = 'avatar-left', $size = 48)
35
    {
36
        if (empty($user_id) && empty($username)) {
37
            $html = $this->avatarManager->renderDefault($size);
0 ignored issues
show
Documentation introduced by
The property avatarManager does not exist on object<Jitamin\Helper\AvatarHelper>. 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...
38
        } else {
39
            $html = $this->avatarManager->render($user_id, $username, $name, $email, $avatar_path, $size);
0 ignored issues
show
Documentation introduced by
The property avatarManager does not exist on object<Jitamin\Helper\AvatarHelper>. 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...
40
        }
41
42
        return '<div class="avatar avatar-'.$size.' '.$css.'">'.$html.'</div>';
43
    }
44
45
    /**
46
     * Render small user avatar.
47
     *
48
     * @param string $user_id
49
     * @param string $username
50
     * @param string $name
51
     * @param string $email
52
     * @param string $avatar_path
53
     * @param string $css
54
     *
55
     * @return string
56
     */
57
    public function small($user_id, $username, $name, $email, $avatar_path, $css = '')
58
    {
59
        return $this->render($user_id, $username, $name, $email, $avatar_path, $css, 20);
60
    }
61
62
    /**
63
     * Get a small avatar for the current user.
64
     *
65
     * @param string $css
66
     *
67
     * @return string
68
     */
69
    public function currentUserSmall($css = '')
70
    {
71
        $user = $this->userSession->getAll();
0 ignored issues
show
Documentation introduced by
The property userSession does not exist on object<Jitamin\Helper\AvatarHelper>. 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...
72
73
        return $this->small($user['id'], $user['username'], $user['name'], $user['email'], $user['avatar_path'], $css);
74
    }
75
}
76