VKGroups - Code Metrics - darki73/FreedomCoreVKAPI - Measure and Improve Code Quality continuously with Scrutinizer

VKGroups B
last analyzed 2016-04-03 02:56 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	376
Duplicated Lines	3.99 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes	3
Bugs	1	Features	0

Metric	Value
wmc	50
c	3
b	1
f	0
lcom	0
cbo	1
dl	15
loc	376
rs	8.6206

21 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	isMember()	0	9	3
A	getMembers()	8	8	1
A	leave()	0	5	1
A	getInvites()	0	4	3
A	getInvitedUsers()	7	7	1
A	banUser()	0	12	4
A	unbanUser()	0	7	1
A	getBanned()	0	3	1
B	edit()	0	12	5
A	getSettings()	0	3	1
A	getRequests()	0	12	2
A	invite()	0	7	1
A	removeUser()	0	7	1
A	approveRequest()	0	7	1
B	getAllowedFields()	0	36	3
A	getById()	0	13	2
B	get()	0	13	5
A	join()	0	10	4
A	search()	0	8	3
B	create()	0	15	6

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 VKGroups 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 VKGroups, and based on these observations, apply Extract Interface, too.

<?php

namespace FreedomCore\VK\API;

use FreedomCore\VK\VKBase;

class VKGroups extends VKAPI {

    /**
     * API Method for this class
     * @var string
     */
    protected $apiMethod = 'groups.';

    /**
     * Permission Required To Work With This Extension
     * @var int
     */
    protected $requiredPermission = parent::PERMISSION_GROUPS;

    /**
     * Default Fields For Selection
     */
    const defaultFields = [ 'description', 'members_count', 'status', 'contacts' ];

    /**
     * VKGroups constructor.
     * @param VKBase $vkObject
     */
    public function __construct(VKBase $vkObject) {
        parent::__construct($vkObject);
        parent::isAllowed($this->requiredPermission);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    /**
     * Returns information specifying whether a user is a member of a community
     * @param int | string $groupID
     * @param int $userID
     * @param int $isExtended
     * @return mixed
     */
    public function isMember($groupID, $userID, $isExtended = 0) {
        $requestParameters = [
            'group_id'      =>  $groupID,
            'user_id'       =>  $userID,
            'extended'      =>  ($isExtended > 1 || $isExtended < 0) ? 0 : $isExtended
        ];

        return parent::executeQuery(__FUNCTION__, $requestParameters);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    /**
     * Returns information about communities by their ID (IDs)
     * @param int | string $groupID
     * @param array $requestFields
     * @return mixed
     */
    public function getById($groupID, $requestFields = self::defaultFields) {
        $requestParameters = [
            'fields'    => $this->getAllowedFields($requestFields)
        ];

        if (is_array($groupID)) {
            $requestParameters[ 'group_ids' ] = implode(',', $groupID);
        } else {
            $requestParameters[ 'group_id' ] = $groupID;
        }

        return parent::executeQuery(__FUNCTION__, $requestParameters);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    /**
     * Returns a list of the communities to which a user belongs
     * @param int $userID
     * @param int $isExtended
     * @param string $setFilter
     * @param array $requestFields
     * @return mixed
     */
    public function get($userID, $isExtended = 0, $setFilter = null, $requestFields = self::defaultFields) {
        $allowedFilterTypes = [ 'admin', 'editor', 'moder', 'groups', 'publics', 'events' ];
        $requestParameters = [
            'user_id'   =>  $userID,
            'extended'  =>  ($isExtended > 1 || $isExtended < 0) ? 0 : $isExtended,
            'fields'    =>  $this->getAllowedFields($requestFields)
        ];
        if ($setFilter != null && in_array($setFilter, $allowedFilterTypes)) { 

            $requestParameters[ 'filter' ] = $setFilter; 
        }

        return parent::executeQuery(__FUNCTION__, $requestParameters);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    /**
     * Returns a list of community members
     * @param int | string $groupID
     * @param array $requestFields
     * @return mixed
     */
    public function getMembers($groupID, $requestFields = VKUsers::standardFields) {

        $requestParameters = [
            'group_id'  =>  $groupID,
            'fields'    =>  $requestFields
        ];

        return parent::executeQuery(__FUNCTION__, $requestParameters);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    /**
     * With this method you can join the group or public page, and also confirm your participation in an event.
     * @param int $groupID
     * @param null $ifMeeting
     * @return mixed
     */
    public function join($groupID, $ifMeeting = null) {
        $requestParameters[ 'group_id' ] = $groupID;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        if ($ifMeeting != null){ 
            if ($ifMeeting == 1 || $ifMeeting == 0) { 
                $requestParameters[ 'not_sure' ]  =   $ifMeeting; 
            } 
        }

        return parent::executeQuery(__FUNCTION__, $requestParameters);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    /**
     * With this method you can leave a group, public page, or event.
     * @param int $groupID
     * @return mixed
     */
    public function leave($groupID) {
        $requestParameters[ 'group_id' ] = $groupID;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

        return parent::executeQuery(__FUNCTION__, $requestParameters);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    /**
     * Searches for communities by substring.
     * @param string $searchQuery
     * @param string $groupType
     * @return mixed
     */
    public function search($searchQuery, $groupType = null) {
        $requestParameters[ 'q' ] = $searchQuery;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        if ($groupType != null && in_array($groupType, [ 'group', 'page', 'event' ])) { 

            $requestParameters[ 'type' ] = $groupType; 
        }

        return parent::executeQuery(__FUNCTION__, $requestParameters);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    /**
     * Returns a list of invitations to join communities and events.
     * @param int $isExtended
     * @return mixed
     */
    public function getInvites($isExtended = 0) {
        $requestParameters[ 'extended' ] = ($isExtended > 1 || $isExtended < 0) ? 0 : $isExtended;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        return parent::executeQuery(__FUNCTION__, $requestParameters);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    /**
     * Returns invited users list of a community
     * @param int $groupID
     * @param array $requestFields
     * @return mixed
     */
    public function getInvitedUsers($groupID, $requestFields = VKUsers::standardFields) {

        $requestParameters = [
            'group_id'  => $groupID,
            'fields ' => $requestFields
        ];
        return parent::executeQuery(__FUNCTION__, $requestParameters);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    /**
     * Adds a user to a community blacklist
     * @param int $groupID
     * @param int $userID
     * @param int $banReason -  1 — spam 2 — verbal abuse 3 — strong language 4 — irrelevant messages 0 — other (default)
     * @param string $banComment - Comment of ban action
     * @param int $endDateTimeStamp - Unix Time
     * @param int $commentVisible - Show Comment To User (1 - Yes | 0 - No)
     */
    public function banUser($groupID, $userID, $banReason = 0, $banComment = '', $endDateTimeStamp = null, $commentVisible = 1) {
        $requestParameters = [
            'group_id'          =>  $groupID,
            'user_id'           =>  $userID,
            'reason'            =>  ($banReason < 0 || $banReason > 4) ? 0 : $banReason,
            'comment'           =>  $banComment,
            'end_date'          =>  ($endDateTimeStamp == null) ? strtotime(date("Y-m-d", strtotime("+1 week"))) : $endDateTimeStamp,

            'comment_visible'   =>  $commentVisible
        ];

        parent::executeQuery(__FUNCTION__, $requestParameters);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    /**
     * Deletes a user from a community blacklist
     * @param int $groupID
     * @param int $userID
     * @return mixed
     */
    public function unbanUser($groupID, $userID) {
        $requestParameters = [
            'group_id'  => $groupID,
            'user_id'   => $userID
        ];
        return parent::executeQuery(__FUNCTION__, $requestParameters);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    /**
     * Returns a list of users on a community blacklist (Requires Moderator Status)
     * @param int $groupID
     * @return mixed
     */
    public function getBanned($groupID) {
        return parent::executeQuery(__FUNCTION__, [ 'group_id' => $groupID]);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    /**
     * Creates a new community
     * @param string $groupTitle
     * @param string $groupDescription
     * @param string $groupType
     * @param int $subType
     * @return mixed
     */
    public function create($groupTitle, $groupDescription, $groupType = 'group', $subType = null) {
        $allowedGroupTypes = [ 'group', 'event', 'public' ];
        $requestParameters = [
            'title'     =>  $groupTitle,
            'type'      =>  (in_array($groupType, $allowedGroupTypes)) ? $groupType : 'group'
        ];
        if ($groupType != 'public') { 
            $requestParameters[ 'description' ] = $groupDescription; 
        }
        if ($subType !== null) { 
            $requestParameters[ 'subtype' ] = ($subType > 4 || $subType < 1) ? 2 : $subType;
        }

        return parent::executeQuery(__FUNCTION__, $requestParameters);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    /**
     * Edits a community
     * @param int $groupID
     * @param string $groupTitle
     * @param string $groupDescription
     * @param string $groupScreenName
     * @param int $groupAccess
     * @param string $groupWebSite
     * @param int $groupSubject
     * @return array
     */
    public function edit($groupID, $groupTitle, $groupDescription, $groupScreenName, $groupAccess, $groupWebSite, $groupSubject) {
        $requestParameters = [
            'group_id'      =>  $groupID,
            'title'         =>  $groupTitle,
            'description'   =>  $groupDescription,
            'screen_name'   =>  $groupScreenName,
            'access'        =>  ($groupAccess > 2 || $groupAccess < 0) ? 1 : $groupAccess,
            'website'       =>  $groupWebSite,
            'subject'       =>  ($groupSubject < 1 || $groupSubject > 42) ? 26 : $groupSubject,
        ];
        return parent::executeQuery(__FUNCTION__, $requestParameters);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    /**
     * Get Group Settings
     * @param int $groupID
     * @return mixed
     */
    public function getSettings($groupID) {
        return parent::executeQuery(__FUNCTION__, [ 'group_id' => $groupID]);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    /**
     * Get Group Access Request
     * @param int $groupID
     * @param array $requestFields
     * @param int $setCount
     * @return array
     */
    public function getRequests($groupID, $requestFields = null, $setCount = 20) {
        if ($requestFields == null) {
            $requestFields = VKUsers::standardFields;
        }

        $requestParameters = [
            'group_id'  =>  $groupID,
            'fields'    =>  $requestFields,
            'count'     =>  $setCount
        ];
        return parent::executeQuery(__FUNCTION__, $requestParameters);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    /**
     * Invite User To Group
     * @param int $groupID
     * @param int $userID
     * @return mixed
     */
    public function invite($groupID, $userID) {
        $requestParameters = [
            'group_id'  =>  $groupID,
            'user_id'   =>  $userID
        ];
        return parent::executeQuery(__FUNCTION__, $requestParameters);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    /**
     * Remove User From Group
     * @param int $groupID
     * @param int $userID
     * @return mixed
     */
    public function removeUser($groupID, $userID) {
        $requestParameters = [
            'group_id'  =>  $groupID,
            'user_id'   =>  $userID
        ];
        return parent::executeQuery(__FUNCTION__, $requestParameters);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    /**
     * Approve User Request To Join Group
     * @param int $groupID
     * @param int $userID
     * @return mixed
     */
    public function approveRequest($groupID, $userID) {
        $requestParameters = [
            'group_id'  =>  $groupID,
            'user_id'   =>  $userID
        ];
        return parent::executeQuery(__FUNCTION__, $requestParameters);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }


    /**
     * Get Fields That Allowed To Be Used With Groups API
     * @param $fieldsArray
     * @return string
     */
    private function getAllowedFields($fieldsArray) {
        $groupsFields = [
            'group_id',
            'name',
            'screen_name',
            'is_closed',
            'is_admin',
            'admin_level',
            'is_member',
            'type',
            'photo',
            'photo_medium',
            'photo_big',
            'city',
            'country',
            'place',
            'description',
            'wiki_page',
            'members_count',
            'counters',
            'start_date ',
            'end_date',
            'can_post',
            'can_see_all_posts',
            'activity',
            'status',
            'contacts'
        ];

        foreach($fieldsArray as $fKey => $fValue) {
            if (!in_array($fValue, $groupsFields)) {
                unset($fieldsArray[$fKey]);
            }
        }
        return implode(',', $fieldsArray);
    }
}

darki73 / FreedomCoreVKAPI

VKGroups B last analyzed 2016-04-03 02:56 UTC