UpdaterRepository::changeUpdatedBy() - Code Metrics - Inspection of "In progress" - satrun77/tinyissue - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — develop-3.0 (4fe777)

by Mohamed

created 2016-09-11 10:54 UTC

UpdaterRepository::changeUpdatedBy() A

↳ Parent: UpdaterRepository

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	7
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	4
nc	1
nop	1

<?php

/*
 * This file is part of the Tinyissue package.
 *
 * (c) Mohamed Alsharaf <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Tinyissue\Repository\Project\Issue;

use Tinyissue\Contracts\Repository\Project\Issue\UpdaterRepository as IssueUpdater;
use Tinyissue\Model\Project;
use Tinyissue\Model\User;
use Tinyissue\Repository\RepositoryUpdater;

class UpdaterRepository extends RepositoryUpdater implements IssueUpdater
{
    public function __construct(Project\Issue $model)
    {
        $this->model = $model;
    }

    /**
     * Set the issue is updated by a user.
     *
     * @param int $userId
     *
     * @return Eloquent\Model
     */
    public function changeUpdatedBy($userId)
    {
        $this->model->updated_by = $userId;
        $this->model->touch();

        return $this->save();
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());
}
    }

    /**
     * Reassign the issue to a new user.
     *
     * @param int|UserInterface $assignTo
     * @param UserInterface     $user
     *
     * @return Eloquent\Model
     */
    public function reassign($assignTo, UserInterface $user)
    {
        $assignToId               = !$assignTo instanceof UserInterface ? $assignTo : $assignTo->id;
if ($x instanceof DoesNotExist) {
    // Do something.
}
        $this->model->assigned_to = $assignToId;

        // Add event on successful save
        static::saved(function (Project\Issue $issue) use ($user) {

            $this->queueAssign($issue, $user);

        });

        $this->save();

        return $this->model->activities()->save(new User\Activity([
            'type_id'   => Activity::TYPE_REASSIGN_ISSUE,
            'parent_id' => $this->model->project->id,
            'user_id'   => $user->id,
            'action_id' => $this->model->assigned_to,
        ]));
    }

    /**
     * Update the given issue.
     *
     * @param array $input
     *
     * @return Eloquent\Model
     */
    public function update(array $input)
    {
        $fill = array_only($input, [
            'title', 'body', 'assigned_to',
        ]);
        $fill['updated_by'] = $this->model->updatedBy->id;

        if (isset($input['time_quote']['lock'])) {

            $fill['lock_quote'] = $input['time_quote']['lock'];
        }

        // Only save quote if not locked or locked & user allowed to modify it
        if (array_key_exists('time_quote', $input) &&

            (!$this->model->isQuoteLocked() || $this->model->user->permission(Model\Permission::PERM_ISSUE_LOCK_QUOTE))
        ) {
            $fill['time_quote'] = $input['time_quote'];
        }

        /* Add to activity log for assignment if changed */
        $assignToId = (int) array_get($input, 'assigned_to');
        if ($assignToId > 0 && $assignToId !== (int) $this->assigned_to) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
            $this->model->activities()->save(new User\Activity([
                'type_id'   => Activity::TYPE_REASSIGN_ISSUE,
                'parent_id' => $this->model->project->id,
                'user_id'   => $this->model->updatedBy->id,
                'action_id' => $this->model->assigned_to,
            ]));
        }

        $this->model->fill($fill);

        $this->syncTags($input, $this->model->tags()->with('parent')->get());

        // Add event on successful save
        static::saved(function (Project\Issue $issue) {

            $this->queueUpdate($issue, $issue->updatedBy);

        });

        return $this->save();
    }

    /**
     * Create a new issue.
     *
     * @param array $input
     *
     * @return static
     */
    public function create(array $input)
    {
        $input['project'] = Project::find((int) $input['project_id']);
        $this->model->setRelations($input);

        $fill = [
            'created_by'  => $this->model->user->id,
            'project_id'  => $this->model->project->id,
            'title'       => $input['title'],
            'body'        => $input['body'],
            'assigned_to' => (int) $this->model->project->default_assignee,
        ];

        if ($this->model->user->permission('issue-modify')) {

            $fill['assigned_to'] = $input['assigned_to'];
            $fill['time_quote']  = $input['time_quote'];
        }

        $this->model->fill($fill)->save();

        // Add issue to messages queue
        $this->queueAdd($this, $this->user);
class MyClass { }

$x = new MyClass();
$x->foo = true;

        /* Add to user's activity log */
        $this->model->activities()->save(new User\Activity([
            'type_id'   => Activity::TYPE_CREATE_ISSUE,
            'parent_id' => $this->model->project->id,
            'user_id'   => $this->model->user->id,
        ]));

        /* Add attachments to issue */
        Attachment::where('upload_token', '=', $input['upload_token'])
            ->where('uploaded_by', '=', $this->model->user->id)
            ->update(['issue_id' => $this->model->id]);

        // Add default tag to newly created issue
        $defaultTag = app('tinyissue.settings')->getFirstStatusTagId();
        if ($defaultTag > 0 && empty($input['tag_status'])) {
            $input['tag_status'] = $defaultTag;
        }

        $this->syncTags($input);

        return $this;
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());
}
    }

    /**
     * Move the issue (comments & activities) to another project.
     *
     * @param int $projectId
     *
     * @return $this
     */
    public function changeProject($projectId)
    {
        $this->project_id = $projectId;
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $this->save();
        $comments = $this->model->comments()->get();
        foreach ($comments as $comment) {
            $comment->model->project_id = $projectId;
            $comment->save();
        }

        $activities = $this->model->activities()->get();
        foreach ($activities as $activity) {
            $activity->model->parent_id = $projectId;
            $activity->save();
        }

        return $this;
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());
}
    }

    /**
     * Delete an issue.
     *
     * @return bool
     *
     * @throws \Exception
     */
    public function delete()
    {
        return $this->transaction('deleteIssue');
    }

    protected function deleteIssue()
    {
        $id          = $this->model->id;
        $projectId   = $this->model->project_id;
        $comments    = $this->model->comments;
        $attachments = $this->model->attachments;

        $status = $this->model->delete();

        if ($status) {

            $attachments->each(function (Attachment $attachment) use ($projectId) {
                $path = config('filesystems.disks.local.root')
                    . '/' . config('tinyissue.uploads_dir')
                    . '/' . $projectId
                    . '/' . $attachment->upload_token;
                $attachment->deleteFile($path, $attachment->filename);
                $attachment->delete();
            });
            $comments->each(function (Project\Issue\Comment $comment) {
                $comment->deleteComment($this->getLoggedUser()->user());
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            });
            User\Activity::where('parent_id', '=', $projectId)->where('item_id', '=', $id)->delete();
            \DB::table('projects_issues_tags')->where('issue_id', '=', $id)->delete();
        }

        return $status;
    }

    /**
     * Change the status of an issue.
     *
     * @param int           $status
     * @param UserInterface $user
     *
     * @return Eloquent\Model
     */
    public function changeStatus($status, UserInterface $user)

    {
        if ($status == 0) {
            $this->closed_by = $user->id;
class MyClass { }

$x = new MyClass();
$x->foo = true;
            $this->closed_at = (new \DateTime())->format('Y-m-d H:i:s');
class MyClass { }

$x = new MyClass();
$x->foo = true;
            $activityType    = Activity::TYPE_CLOSE_ISSUE;
        } else {
            $this->closed_by = 0;
            $this->closed_at = null;
            $activityType    = Activity::TYPE_REOPEN_ISSUE;
        }

        /* Add to activity log */
        $this->activities()->save(new User\Activity([

            'type_id'   => $activityType,
            'parent_id' => $this->project->id,

            'user_id'   => $user->id,
        ]));

        $this->status = $status;
class MyClass { }

$x = new MyClass();
$x->foo = true;

        // Add event on successful save
        static::saved(function (Project\Issue $issue) use ($user) {

            $this->queueUpdate($issue, $user);

        });

        return $this->save();
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());
}
    }

    /**
     * Sync the issue tags.
     *
     * @param array      $input
     * @param Collection $currentTags
     *
     * @return bool
     */
    public function syncTags(array $input, Collection $currentTags = null)
    {
        $tagIds = array_only($input, [
            'tag_type', 'tag_status', 'tag_resolution',
        ]);

        // User can edit their own role and can only change issue type
        if ($this->updatedBy instanceof UserInterface && $this->updatedBy->isUser()) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
            $currentTagIds            = $currentTags->pluck('id', 'parent.name')->toArray();
            $tagIds['tag_status']     = array_key_exists('status', $currentTagIds) ? $currentTagIds['status'] : 0;
            $tagIds['tag_resolution'] = array_key_exists('resolution', $currentTagIds) ? $currentTagIds['resolution'] : 0;
        }

        $tags = (new Tag())->whereIn('id', $tagIds)->get();

        $removedTags = [];
        if (null === $currentTags) {

            // Add the following tags except for open status
            $addedTags = $tags
                ->map(function (Tag $tag) {
                    return $tag->toShortArray();
                })
                ->toArray();
        } else {
            // Tags remove from the issue
            $removedTags = $currentTags
                ->diff($tags)
                ->map(function (Tag $tag) {
                    return $tag->toShortArray();
                })
                ->toArray();

            // Check if we are adding new tags
            $addedTags = $tags
                ->filter(function (Tag $tag) use ($currentTags) {
                    return $currentTags->where('id', $tag->id)->count() === 0;
                })
                ->map(function (Tag $tag) {
                    return $tag->toShortArray();
                })
                ->toArray();

            // No new tags to add or remove
            if (empty($removedTags) && empty($addedTags)) {
                return true;
            }
        }

        // Save relation
        $this->tags()->sync($tags->pluck('id')->all());


        // Activity is added when new issue create with tags or updated with tags excluding the open status tag
        if (!empty($removedTags) || !empty($addedTags)) {

            // Add this change to messages queue
            $this->queueChangeTags($this, $addedTags, $removedTags, $this->user);


            // Add to activity log for tags if changed
            $this->activities()->save(new User\Activity([

                'type_id'   => Activity::TYPE_ISSUE_TAG,
                'parent_id' => $this->project->id,

                'user_id'   => $this->user->id,
                'data'      => ['added_tags' => $addedTags, 'removed_tags' => $removedTags],
            ]));
        }

        return true;
    }

    /**
     * Add tag to the issue & close issue if added tag is Closed.
     *
     * @param Tag $newTag
     * @param Tag $oldTag
     *
     * @return $this
     */
    public function changeKanbanTag(Tag $newTag, Tag $oldTag)

    {
        //  skip if there is no change in status tags
        if ($oldTag->name === $newTag->name) {
            return $this;
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());
}
        }

        // Open issue
        $data = ['added_tags' => [], 'removed_tags' => []];

        // Remove previous status tag
        $this->tags()->detach($oldTag);

        $data['removed_tags'][] = $oldTag->toShortArray();

        // Add new tag
        if (!$this->tags->contains($newTag)) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
            $this->tags()->attach($newTag);


            $data['added_tags'][] = $newTag->toShortArray();
        }

        if (!empty($data)) {
            // Add this change to messages queue
            $this->queueChangeTags($this, $data['added_tags'], $data['removed_tags'], $this->user);


            // Add to activity log for tags if changed
            $this->activities()->save(new User\Activity([

                'type_id'   => Activity::TYPE_ISSUE_TAG,
                'parent_id' => $this->project->id,

                'user_id'   => $this->user->id,
                'data'      => $data,
            ]));
        }

        return $this;
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());
}
    }
}


Branch — develop-3.0 (4fe777)

UpdaterRepository::changeUpdatedBy() A

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1			<?php
2
3			/*
4			* This file is part of the Tinyissue package.
5			*
6			* (c) Mohamed Alsharaf <[email protected]>
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 Tinyissue\Repository\Project\Issue;
13
14			use Tinyissue\Contracts\Repository\Project\Issue\UpdaterRepository as IssueUpdater;
15			use Tinyissue\Model\Project;
16			use Tinyissue\Model\User;
17			use Tinyissue\Repository\RepositoryUpdater;
18
19			class UpdaterRepository extends RepositoryUpdater implements IssueUpdater
20			{
21			public function __construct(Project\Issue $model)
22			{
23			$this->model = $model;
24			}
25
26			/**
27			* Set the issue is updated by a user.
28			*
29			* @param int $userId
30			*
31			* @return Eloquent\Model
32			*/
33			public function changeUpdatedBy($userId)
34			{
35			$this->model->updated_by = $userId;
36			$this->model->touch();
37
38			return $this->save();
			0 ignored issues – show Bug Best Practice introduced 2016-09-11 11:05 UTC by Report Bug Copy Issue Report The return type of `return $this->save();` (`boolean`) is incompatible with the return type declared by the interface `Tinyissue\Contracts\Repo...sitory::changeUpdatedBy` of type `Tinyissue\Model\Project\Issue`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: 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()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
39			}

satrun77 / tinyissue

Branch — develop-3.0 (4fe777)

UpdaterRepository::changeUpdatedBy() A

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like