ProjectGroupRoleModel::getUserRole()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 10
Code Lines 7

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 7
nc 1
nop 2
dl 0
loc 10
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\Model;
13
14
use Jitamin\Foundation\Database\Model;
15
use Jitamin\Foundation\Security\Role;
16
17
/**
18
 * Project Group Role.
19
 */
20
class ProjectGroupRoleModel extends Model
21
{
22
    /**
23
     * SQL table name.
24
     *
25
     * @var string
26
     */
27
    const TABLE = 'project_has_groups';
28
29
    /**
30
     * Get the list of project visible by the given user according to groups.
31
     *
32
     * @param int   $user_id
33
     * @param array $status
34
     *
35
     * @return array
36
     */
37
    public function getProjectsByUser($user_id, $status = [ProjectModel::ACTIVE, ProjectModel::INACTIVE])
38
    {
39
        return $this->db
0 ignored issues
show
Documentation introduced by
The property db does not exist on object<Jitamin\Model\ProjectGroupRoleModel>. 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
            ->hashtable(ProjectModel::TABLE)
41
            ->join(self::TABLE, 'project_id', 'id')
42
            ->join(GroupMemberModel::TABLE, 'group_id', 'group_id', self::TABLE)
43
            ->eq(GroupMemberModel::TABLE.'.user_id', $user_id)
44
            ->in(ProjectModel::TABLE.'.is_active', $status)
45
            ->getAll(ProjectModel::TABLE.'.id', ProjectModel::TABLE.'.name');
46
    }
47
48
    /**
49
     * For a given project get the role of the specified user.
50
     *
51
     * @param int $project_id
52
     * @param int $user_id
53
     *
54
     * @return string
55
     */
56
    public function getUserRole($project_id, $user_id)
57
    {
58
        $roles = $this->db->table(self::TABLE)
0 ignored issues
show
Documentation introduced by
The property db does not exist on object<Jitamin\Model\ProjectGroupRoleModel>. 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...
59
            ->join(GroupMemberModel::TABLE, 'group_id', 'group_id', self::TABLE)
60
            ->eq(GroupMemberModel::TABLE.'.user_id', $user_id)
61
            ->eq(self::TABLE.'.project_id', $project_id)
62
            ->findAllByColumn('role');
63
64
        return $this->projectAccessMap->getHighestRole($roles);
0 ignored issues
show
Documentation introduced by
The property projectAccessMap does not exist on object<Jitamin\Model\ProjectGroupRoleModel>. 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...
65
    }
66
67
    /**
68
     * Get all groups associated directly to the project.
69
     *
70
     * @param int $project_id
71
     *
72
     * @return array
73
     */
74
    public function getGroups($project_id)
75
    {
76
        return $this->db->table(self::TABLE)
0 ignored issues
show
Documentation introduced by
The property db does not exist on object<Jitamin\Model\ProjectGroupRoleModel>. 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...
77
            ->columns(GroupModel::TABLE.'.id', GroupModel::TABLE.'.name', self::TABLE.'.role')
78
            ->join(GroupModel::TABLE, 'id', 'group_id')
79
            ->eq('project_id', $project_id)
80
            ->asc('name')
81
            ->findAll();
82
    }
83
84
    /**
85
     * From groups get all users associated to the project.
86
     *
87
     * @param int $project_id
88
     *
89
     * @return array
90
     */
91
    public function getUsers($project_id)
92
    {
93
        return $this->db->table(self::TABLE)
0 ignored issues
show
Documentation introduced by
The property db does not exist on object<Jitamin\Model\ProjectGroupRoleModel>. 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...
94
            ->columns(UserModel::TABLE.'.id', UserModel::TABLE.'.username', UserModel::TABLE.'.name', self::TABLE.'.role')
95
            ->join(GroupMemberModel::TABLE, 'group_id', 'group_id', self::TABLE)
96
            ->join(UserModel::TABLE, 'id', 'user_id', GroupMemberModel::TABLE)
97
            ->eq(self::TABLE.'.project_id', $project_id)
98
            ->asc(UserModel::TABLE.'.username')
99
            ->findAll();
100
    }
101
102
    /**
103
     * From groups get all users assignable to tasks.
104
     *
105
     * @param int $project_id
106
     *
107
     * @return array
108
     */
109
    public function getAssignableUsers($project_id)
110
    {
111
        return $this->db->table(UserModel::TABLE)
0 ignored issues
show
Documentation introduced by
The property db does not exist on object<Jitamin\Model\ProjectGroupRoleModel>. 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...
112
            ->columns(UserModel::TABLE.'.id', UserModel::TABLE.'.username', UserModel::TABLE.'.name')
113
            ->join(GroupMemberModel::TABLE, 'user_id', 'id', UserModel::TABLE)
114
            ->join(self::TABLE, 'group_id', 'group_id', GroupMemberModel::TABLE)
115
            ->eq(self::TABLE.'.project_id', $project_id)
116
            ->eq(UserModel::TABLE.'.is_active', 1)
117
            ->in(self::TABLE.'.role', [Role::PROJECT_MANAGER, Role::PROJECT_MEMBER])
118
            ->asc(UserModel::TABLE.'.username')
119
            ->findAll();
120
    }
121
122
    /**
123
     * Add a group to the project.
124
     *
125
     * @param int    $project_id
126
     * @param int    $group_id
127
     * @param string $role
128
     *
129
     * @return bool
130
     */
131 View Code Duplication
    public function addGroup($project_id, $group_id, $role)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
132
    {
133
        return $this->db->table(self::TABLE)->insert([
0 ignored issues
show
Documentation introduced by
The property db does not exist on object<Jitamin\Model\ProjectGroupRoleModel>. 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...
134
            'group_id'   => $group_id,
135
            'project_id' => $project_id,
136
            'role'       => $role,
137
        ]);
138
    }
139
140
    /**
141
     * Remove a group from the project.
142
     *
143
     * @param int $project_id
144
     * @param int $group_id
145
     *
146
     * @return bool
147
     */
148
    public function removeGroup($project_id, $group_id)
149
    {
150
        return $this->db->table(self::TABLE)->eq('group_id', $group_id)->eq('project_id', $project_id)->remove();
0 ignored issues
show
Documentation introduced by
The property db does not exist on object<Jitamin\Model\ProjectGroupRoleModel>. 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...
151
    }
152
153
    /**
154
     * Change a group role for the project.
155
     *
156
     * @param int    $project_id
157
     * @param int    $group_id
158
     * @param string $role
159
     *
160
     * @return bool
161
     */
162 View Code Duplication
    public function changeGroupRole($project_id, $group_id, $role)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
163
    {
164
        return $this->db->table(self::TABLE)
0 ignored issues
show
Documentation introduced by
The property db does not exist on object<Jitamin\Model\ProjectGroupRoleModel>. 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...
165
            ->eq('group_id', $group_id)
166
            ->eq('project_id', $project_id)
167
            ->update([
168
                'role' => $role,
169
            ]);
170
    }
171
172
    /**
173
     * Copy group access from a project to another one.
174
     *
175
     * @param int $project_src_id Project Template
176
     * @param int $project_dst_id Project that receives the copy
177
     *
178
     * @return bool
179
     */
180 View Code Duplication
    public function duplicate($project_src_id, $project_dst_id)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
181
    {
182
        $rows = $this->db->table(self::TABLE)->eq('project_id', $project_src_id)->findAll();
0 ignored issues
show
Documentation introduced by
The property db does not exist on object<Jitamin\Model\ProjectGroupRoleModel>. 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...
183
184
        foreach ($rows as $row) {
185
            $result = $this->db->table(self::TABLE)->save([
0 ignored issues
show
Documentation introduced by
The property db does not exist on object<Jitamin\Model\ProjectGroupRoleModel>. 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...
186
                'project_id' => $project_dst_id,
187
                'group_id'   => $row['group_id'],
188
                'role'       => $row['role'],
189
            ]);
190
191
            if (!$result) {
192
                return false;
193
            }
194
        }
195
196
        return true;
197
    }
198
}
199