ClientRemote - Code Metrics - Inspection of "fix getMessages" - directus/directus-sdk-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — d64 ( a462d8...ba0200 )

by Welling

created 2016-12-09 05:27 UTC

ClientRemote B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	474
Duplicated Lines	7.81 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

25.81%

Importance

Changes

Metric	Value
dl	37
loc	474
ccs	40
cts	155
cp	0.2581
rs	8.4864
c	0
b	0
f	0
wmc	48
lcom	1
cbo	4

44 Methods

Rating	Name	Duplication	Size	Complexity
A	getTables()	0	4	1
A	getTable()	0	6	1
A	getColumns()	0	6	1
A	getColumn()	0	6	1
A	getUsers()	0	4	1
A	getUser()	0	4	1
A	getGroups()	0	4	1
A	getGroup()	0	6	1
A	getGroupPrivileges()	0	6	1
A	getFiles()	0	4	1
A	getFile()	0	6	1
A	getSettings()	0	4	1
A	getSettingsByCollection()	0	6	1
A	getItems()	0	6	1
A	getItem()	0	6	1
A	updateSettings()	0	8	1
A	getMessages()	10	10	2
A	getMessage()	0	6	1
A	createItem()	7	7	1
A	updateItem()	7	7	1
A	deleteItem()	0	6	1
A	createUser()	0	4	1
A	updateUser()	0	4	1
A	deleteUser()	0	4	1
A	createFile()	0	6	1
A	updateFile()	0	12	2
A	deleteFile()	0	4	1
A	createPreferences()	0	10	1
A	createBookmark()	0	19	1
A	getBookmark()	0	6	1
A	getBookmarks()	10	10	2
A	createColumn()	0	8	1
A	createGroup()	0	6	1
A	createMessage()	0	12	1
A	sendMessage()	0	4	1
A	createPrivileges()	0	8	1
A	createTable()	0	11	1
A	createColumnUIOptions()	0	16	1
A	getPreferences()	0	4	1
A	deleteBookmark()	0	4	1
A	deleteColumn()	0	6	1
A	deleteGroup()	0	4	1
A	deleteTable()	0	6	1
A	getActivity()	3	12	2

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like ClientRemote often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use ClientRemote, and based on these observations, apply Extract Interface, too.

<?php

/**
 * Directus – <http://getdirectus.com>
 *
 * @link      The canonical repository – <https://github.com/directus/directus>
 * @copyright Copyright 2006-2016 RANGER Studio, LLC – <http://rangerstudio.com>
 * @license   GNU General Public License (v3) – <http://www.gnu.org/copyleft/gpl.html>
 */

namespace Directus\SDK;
use Directus\Util\ArrayUtils;
use Directus\Util\DateUtils;

/**
 * Client Remote
 *
 * @author Welling Guzmán <[email protected]>
 */
class ClientRemote extends BaseClientRemote
{
    /**
     * @inheritdoc
     */
    public function getTables(array $params = [])
    {
        return $this->performRequest('GET', static::TABLE_LIST_ENDPOINT);

    }

    /**
     * @inheritdoc
     */
    public function getTable($tableName)
    {
        $path = $this->buildPath(static::TABLE_INFORMATION_ENDPOINT, $tableName);

        return $this->performRequest('GET', $path);

    }

    /**
     * @inheritdoc
     */
    public function getColumns($tableName, array $params = [])
    {
        $path = $this->buildPath(static::COLUMN_LIST_ENDPOINT, $tableName);

        return $this->performRequest('GET', $path);

    }

    /**
     * @inheritdoc
     */
    public function getColumn($tableName, $columnName)
    {
        $path = $this->buildPath(static::COLUMN_INFORMATION_ENDPOINT, [$tableName, $columnName]);

        return $this->performRequest('GET', $path);

    }

    /**
     * @inheritdoc
     */
    public function getItems($tableName, array $options = [])
    {
        $path = $this->buildPath(static::TABLE_ENTRIES_ENDPOINT, $tableName);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        return $this->performRequest('GET', $path, ['query' => $options]);

    }

    /**
     * @inheritdoc
     */
    public function getItem($tableName, $id, array $options = [])
    {
        $path = $this->buildPath(static::TABLE_ENTRY_ENDPOINT, [$tableName, $id]);

        return $this->performRequest('GET', $path, ['query' => $options]);

    }

    /**
     * @inheritdoc
     */
    public function getUsers(array $params = [])
    {
        return $this->getItems('directus_users', $params);
    }

    /**
     * @inheritdoc
     */
    public function getUser($id, array $params = [])
    {
        return $this->getItem($id, 'directus_users', $params);
    }

    /**
     * @inheritdoc
     */
    public function getGroups()
    {
        return $this->performRequest('GET', static::GROUP_LIST_ENDPOINT);

    }

    /**
     * @inheritdoc
     */
    public function getGroup($groupID)
    {
        $path = $this->buildPath(static::GROUP_INFORMATION_ENDPOINT, $groupID);

        return $this->performRequest('GET', $path);

    }

    /**
     * @inheritdoc
     */
    public function getGroupPrivileges($groupID)
    {
        $path = $this->buildPath(static::GROUP_PRIVILEGES_ENDPOINT, $groupID);

        return $this->performRequest('GET', $path);

    }

    /**
     * @inheritdoc
     */
    public function getFiles()
    {
        return $this->performRequest('GET', static::FILE_LIST_ENDPOINT);

    }

    /**
     * @inheritdoc
     */
    public function getFile($fileID)
    {
        $path = $this->buildPath(static::FILE_INFORMATION_ENDPOINT, $fileID);

        return $this->performRequest('GET', $path);

    }

    /**
     * @inheritdoc
     */
    public function getSettings()
    {
        return $this->performRequest('GET', static::SETTING_LIST_ENDPOINT);
    }

    /**
     * @inheritdoc
     */
    public function getSettingsByCollection($collectionName)
    {
        $path = $this->buildPath(static::SETTING_COLLECTION_GET_ENDPOINT, $collectionName);

        return $this->performRequest('GET', $path);

    }

    /**
     * @inheritdoc
     */
    public function updateSettings($collection, array $data)
    {
        $path = $this->buildPath(static::SETTING_COLLECTION_UPDATE_ENDPOINT, $collection);

        return $this->performRequest('PUT', $path, [

            'body' => $data
        ]);
    }

    /**
     * @inheritdoc
     */
    public function getMessages($userId = null)

    {
        if ($userId !== null) {
            $path = $this->buildPath(static::MESSAGES_USER_LIST_ENDPOINT, $userId);
        } else {
            $path = $this->buildPath(static::MESSAGES_LIST_ENDPOINT);
        }

        return $this->performRequest('GET', $path);

    }

    /**
     * @inheritdoc
     */
    public function getMessage($id)
    {
        $path = $this->buildPath(static::MESSAGES_GET_ENDPOINT, $id);

        return $this->performRequest('GET', $path);

    }

    /**
     * @inheritdoc
     */
    public function createItem($tableName, array $data)

    {
        $path = $this->buildPath(static::TABLE_ENTRY_CREATE_ENDPOINT, $tableName);
        $data = $this->processData($tableName, $data);

        return $this->performRequest('POST', $path, ['body' => $data]);

    }

    /**
     * @inheritdoc
     */
    public function updateItem($tableName, $id, array $data)

    {
        $path = $this->buildPath(static::TABLE_ENTRY_UPDATE_ENDPOINT, [$tableName, $id]);
        $data = $this->processData($tableName, $data);

        return $this->performRequest('PUT', $path, ['body' => $data]);
    }

    /**
     * @inheritdoc
     */
    public function deleteItem($tableName, $id)
    {
        $path = $this->buildPath(static::TABLE_ENTRY_DELETE_ENDPOINT, [$tableName, $id]);

        return $this->performRequest('DELETE', $path);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * @inheritdoc
     */
    public function createUser(array $data)
    {
        return $this->createItem('directus_users', $data);
    }

    /**
     * @inheritdoc
     */
    public function updateUser($id, array $data)
    {
        return $this->updateItem('directus_users', $id, $data);
    }

    /**
     * @inheritdoc
     */
    public function deleteUser($ids)
    {
        return $this->deleteItem('directus_users', $ids);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * @inheritdoc
     */
    public function createFile(File $file)
    {
        $data = $this->processFile($file);

        return $this->performRequest('POST', static::FILE_CREATE_ENDPOINT, ['body' => $data]);

    }

    /**
     * @inheritdoc
     */
    public function updateFile($id, $data)
    {
        if ($data instanceof File) {
            $data = $data->toArray();
        }

        $data['id'] = $id;
        $path = $this->buildPath(static::FILE_UPDATE_ENDPOINT, $id);
        $data = $this->processData('directus_files', $data);

        return $this->performRequest('POST', $path, ['body' => $data]);
    }

    /**
     * @inheritdoc
     */
    public function deleteFile($id)
    {
        return $this->deleteItem('directus_files', $id);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    public function createPreferences($data)
    {
        $this->requiredAttributes(['title', 'table_name'], $data);

        $tableName = ArrayUtils::get($data, 'table_name');
        $path = $this->buildPath(static::TABLE_PREFERENCES_ENDPOINT, $tableName);
        $data = $this->processData($tableName, $data);

        return $this->performRequest('POST', $path, ['body' => $data]);

    }

    /**
     * @inheritdoc
     */
    public function createBookmark($data)
    {
        $preferences = $this->createPreferences(ArrayUtils::pick($data, [
            'title', 'table_name', 'sort', 'status', 'search_string', 'sort_order', 'columns_visible'
        ]));

        $title = $preferences->title;
<?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.");
        }
    }

}
        $tableName = $preferences->table_name;
<?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.");
        }
    }

}
        $bookmarkData = [
            'section' => 'search',
            'title' => $title,
            'url' => 'tables/' . $tableName . '/pref/' . $title
        ];

        $path = $this->buildPath(static::BOOKMARKS_CREATE_ENDPOINT);
        $bookmarkData = $this->processData($tableName, $bookmarkData);

        return $this->performRequest('POST', $path, ['body' => $bookmarkData]);

    }

    /**
     * @inheritdoc
     */
    public function getBookmark($id)
    {
        $path = $this->buildPath(static::BOOKMARKS_READ_ENDPOINT, $id);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        return $this->performRequest('GET', $path);

    }

    /**
     * @inheritdoc
     */
    public function getBookmarks($userId = null)

    {
        if ($userId !== null) {
            $path = $this->buildPath(static::BOOKMARKS_USER_ENDPOINT, $userId);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        } else {
            $path = $this->buildPath(static::BOOKMARKS_ALL_ENDPOINT);
        }

        return $this->performRequest('GET', $path);

    }

    /**
     * @inheritdoc
     */
    public function createColumn($data)
    {
        $data = $this->parseColumnData($data);

        return $this->performRequest('POST', $this->buildPath(static::COLUMN_CREATE_ENDPOINT, $data['table_name']), [

            'body' => $data
        ]);
    }

    /**
     * @inheritdoc
     */
    public function createGroup(array $data)
    {
        return $this->performRequest('POST', static::GROUP_CREATE_ENDPOINT, [

            'body' => $data
        ]);
    }

    /**
     * @inheritdoc
     */
    public function createMessage(array $data)
    {
        $this->requiredAttributes(['from', 'message', 'subject'], $data);
        $this->requiredOneAttribute(['to', 'toGroup'], $data);

        $data['recipients'] = $this->getMessagesTo($data);
        ArrayUtils::remove($data, ['to', 'toGroup']);

        return $this->performRequest('POST', static::MESSAGES_CREATE_ENDPOINT, [

            'body' => $data
        ]);
    }

    /**
     * @inheritdoc
     */
    public function sendMessage(array $data)
    {
        return $this->createMessage($data);
    }

    /**
     * @inheritdoc
     */
    public function createPrivileges(array $data)
    {
        $this->requiredAttributes(['group_id', 'table_name'], $data);

        return $this->performRequest('POST', static::GROUP_PRIVILEGES_CREATE_ENDPOINT, [

            'body' => $data
        ]);
    }

    public function createTable($name, array $params = [])
    {
        $data = [
            'addTable' => true,
            'table_name' => $name
        ];

        return $this->performRequest('POST', static::TABLE_CREATE_ENDPOINT, [

            'body' => $data
        ]);
    }

    /**
     * @inheritdoc
     */
    public function createColumnUIOptions(array $data)
    {
        $this->requiredAttributes(['table', 'column', 'ui', 'options'], $data);

        $path = $this->buildPath(static::COLUMN_OPTIONS_CREATE_ENDPOINT, [
            $data['table'],
            $data['column'],
            $data['ui']
        ]);

        $data = ArrayUtils::get($data, 'options');

        return $this->performRequest('POST', $path, [

            'body' => $data
        ]);
    }

    /**
     * @inheritdoc
     */
    public function getPreferences($table, $user = null)
    {
        return $this->performRequest('POST', $this->buildPath(static::TABLE_PREFERENCES_ENDPOINT, $table));

    }

    /**
     * @inheritdoc
     */
    public function deleteBookmark($id)
    {
        return $this->deleteItem('directus_bookmarks', $id);

    }

    /**
     * @inheritdoc
     */
    public function deleteColumn($name, $table)
    {
        $path = $this->buildPath(static::COLUMN_DELETE_ENDPOINT, [$name, $table]);

        return $this->performRequest('DELETE', $path);

    }

    /**
     * @inheritdoc
     */
    public function deleteGroup($id)
    {
        return $this->deleteItem('directus_groups', $id);

    }

    /**
     * @inheritdoc
     */
    public function deleteTable($name)
    {
        $path = $this->buildPath(static::TABLE_DELETE_ENDPOINT, $name);

        return $this->performRequest('DELETE', $path);

    }

    /**
     * @inheritdoc
     */
    public function getActivity(array $params = [])
    {
        if (!ArrayUtils::has($params, 'filters.datetime')) {

            $params['filters']['datetime'] = ['>=' => DateUtils::daysAgo(30)];
        }

        $path = $this->buildPath(static::ACTIVITY_GET_ENDPOINT);

        return $this->performRequest('GET', $path, [

            'query' => $params
        ]);
    }
}


1		<?php
2
3		/**
4		* Directus – <http://getdirectus.com>
5		*
6		* @link The canonical repository – <https://github.com/directus/directus>
7		* @copyright Copyright 2006-2016 RANGER Studio, LLC – <http://rangerstudio.com>
8		* @license GNU General Public License (v3) – <http://www.gnu.org/copyleft/gpl.html>
9		*/
10
11		namespace Directus\SDK;
12		use Directus\Util\ArrayUtils;
13		use Directus\Util\DateUtils;
14
15		/**
16		* Client Remote
17		*
18		* @author Welling Guzmán <[email protected]>
19		*/
20		class ClientRemote extends BaseClientRemote
21		{
22		/**
23		* @inheritdoc
24		*/
25		public function getTables(array $params = [])
26	2	{
27		return $this->performRequest('GET', static::TABLE_LIST_ENDPOINT);
		1 ignored issue – show Bug Compatibility introduced 2016-11-16 18:40 UTC by Report Bug Copy Issue Report The expression `$this->performRequest('G...::TABLE_LIST_ENDPOINT);` of type `Directus\SDK\Response\En...ctus\SDK\Response\Entry` adds the type `Directus\SDK\Response\Entry` to the return on line 27 which is incompatible with the return type declared by the interface `Directus\SDK\RequestsInterface::getTables` of type `Directus\SDK\Response\EntryCollection`. Loading history...
28	2	}
29
30		/**
31		* @inheritdoc
32		*/
33		public function getTable($tableName)
34	4	{
35		$path = $this->buildPath(static::TABLE_INFORMATION_ENDPOINT, $tableName);
36	4
37		return $this->performRequest('GET', $path);
		1 ignored issue – show Bug Compatibility introduced 2016-11-20 07:42 UTC by Report Bug Copy Issue Report The expression `$this->performRequest('GET', $path);` of type `Directus\SDK\Response\En...ctus\SDK\Response\Entry` adds the type `Directus\SDK\Response\EntryCollection` to the return on line 37 which is incompatible with the return type declared by the interface `Directus\SDK\RequestsInterface::getTable` of type `Directus\SDK\Response\Entry`. Loading history...
38	4	}

directus / directus-sdk-php