HasComments::commentAsUser() - Code Metrics - beyondcode/laravel-comments - Measure and Improve Code Quality continuously with Scrutinizer

HasComments::commentAsUser() A
last analyzed 2021-04-22 21:17 UTC

↳ Parent: HasComments

Complexity

Conditions	3
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	14
rs	9.7998
c	0
b	0
f	0
cc	3
nc	1
nop	2

<?php

namespace BeyondCode\Comments\Traits;


use Illuminate\Database\Eloquent\Model;
use BeyondCode\Comments\Contracts\Commentator;
use Illuminate\Database\Eloquent\Relations\MorphMany;

trait HasComments
{
    /**
     * Return all comments for this model.
     *
     * @return MorphMany
     */
    public function comments()
    {
        return $this->morphMany(config('comments.comment_class'), 'commentable');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Attach a comment to this model.
     *
     * @param string $comment
     * @return \Illuminate\Database\Eloquent\Model
     */
    public function comment(string $comment)
    {
        return $this->commentAsUser(auth()->user(), $comment);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
    }

    /**
     * Attach a comment to this model as a specific user.
     *
     * @param Model|null $user
     * @param string $comment
     * @return \Illuminate\Database\Eloquent\Model
     */
    public function commentAsUser(?Model $user, string $comment)
    {
        $commentClass = config('comments.comment_class');

        $comment = new $commentClass([
            'comment' => $comment,
            'is_approved' => ($user instanceof Commentator) ? ! $user->needsCommentApproval($this) : false,
            'user_id' => is_null($user) ? null : $user->getKey(),
            'commentable_id' => $this->getKey(),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            'commentable_type' => get_class(),
        ]);

        return $this->comments()->save($comment);
    }

}

1			<?php
2
3			namespace BeyondCode\Comments\Traits;
4
5
6			use Illuminate\Database\Eloquent\Model;
7			use BeyondCode\Comments\Contracts\Commentator;
8			use Illuminate\Database\Eloquent\Relations\MorphMany;
9
10			trait HasComments
11			{
12			/**
13			* Return all comments for this model.
14			*
15			* @return MorphMany
16			*/
17			public function comments()
18			{
19			return $this->morphMany(config('comments.comment_class'), 'commentable');
			0 ignored issues – show Bug introduced 2018-09-03 11:27 UTC by Report Bug Copy Issue Report It seems like `morphMany()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
20			}
21
22			/**
23			* Attach a comment to this model.
24			*
25			* @param string $comment
26			* @return \Illuminate\Database\Eloquent\Model
27			*/
28			public function comment(string $comment)
29			{
30			return $this->commentAsUser(auth()->user(), $comment);
			0 ignored issues – show Bug introduced 2018-09-03 11:27 UTC by Report Bug Copy Issue Report The method `user` does only exist in `Illuminate\Contracts\Auth\Guard`, but not in `Illuminate\Contracts\Auth\Factory`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
31			}
32
33			/**
34			* Attach a comment to this model as a specific user.
35			*
36			* @param Model\|null $user
37			* @param string $comment
38			* @return \Illuminate\Database\Eloquent\Model
39			*/
40			public function commentAsUser(?Model $user, string $comment)
41			{
42			$commentClass = config('comments.comment_class');
43
44			$comment = new $commentClass([
45			'comment' => $comment,
46			'is_approved' => ($user instanceof Commentator) ? ! $user->needsCommentApproval($this) : false,
47			'user_id' => is_null($user) ? null : $user->getKey(),
48			'commentable_id' => $this->getKey(),
			0 ignored issues – show Bug introduced 2018-09-03 11:27 UTC by Report Bug Copy Issue Report It seems like `getKey()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
49			'commentable_type' => get_class(),
50			]);
51
52			return $this->comments()->save($comment);
53			}
54
55			}

beyondcode / laravel-comments

HasComments::commentAsUser() A last analyzed 2021-04-22 21:17 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

HasComments::commentAsUser() A
last analyzed 2021-04-22 21:17 UTC