OfferEditingTrait::removeImage() - Code Metrics - Inspection of "III-611: Remove images" - cultuurnet/udb3-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#121)

by Kristof

created 2016-02-05 18:13 UTC

OfferEditingTrait::removeImage() A

↳ Parent: OfferEditingTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	11
rs	9.4285
cc	1
eloc	5
nc	1
nop	2

<?php

/**
 * @file
 * Contains CultuurNet\UDB3\OfferEditingTrait.
 */

namespace CultuurNet\UDB3;

use CultuurNet\UDB3\Media\Image;
use CultuurNet\UDB3\Media\MediaObject;
use ValueObjects\String\String;

/**
 * Trait that contains all major editing methods for Offers.
 */
trait OfferEditingTrait
{

    /**
     * Get the namespaced classname of the command to create.
     * @param type $className
     *   Name of the class
     * @return string
     */
    private function getCommandClass($className)
    {
        $reflection = new \ReflectionObject($this);
        return $reflection->getNamespaceName() . '\\Commands\\' . $className;
    }

    /**
     * {@inheritdoc}
     */
    public function updateDescription($id, $description)

    {

        $this->guardId($id);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        $commandClass = $this->getCommandClass('UpdateDescription');
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        return $this->commandBus->dispatch(
class MyClass { }

$x = new MyClass();
$x->foo = true;
            new $commandClass($id, $description)
        );
    }

    /**
     * {@inheritdoc}
     */
    public function updateTypicalAgeRange($id, $ageRange)

    {

        $this->guardId($id);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        $commandClass = $this->getCommandClass('UpdateTypicalAgeRange');
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        return $this->commandBus->dispatch(
            new $commandClass($id, $ageRange)
        );
    }

    /**
     * {@inheritdoc}
     */
    public function deleteTypicalAgeRange($id)
    {

        $this->guardId($id);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        $commandClass = $this->getCommandClass('DeleteTypicalAgeRange');
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        return $this->commandBus->dispatch(
            new $commandClass($id)
        );

    }

    /**
     * {@inheritdoc}
     */
    public function updateOrganizer($id, $organizerId)

    {

        $this->guardId($id);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        $commandClass = $this->getCommandClass('UpdateOrganizer');
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        return $this->commandBus->dispatch(
            new $commandClass($id, $organizerId)
        );
    }

    /**
     * {@inheritdoc}
     */
    public function deleteOrganizer($id, $organizerId)

    {

        $this->guardId($id);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        $commandClass = $this->getCommandClass('DeleteOrganizer');
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        return $this->commandBus->dispatch(
            new $commandClass($id, $organizerId)
        );
    }

    /**
     * {@inheritdoc}
     */
    public function updateContactPoint($id, ContactPoint $contactPoint)

    {

        $this->guardId($id);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        $commandClass = $this->getCommandClass('UpdateContactPoint');
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        return $this->commandBus->dispatch(
            new $commandClass($id, $contactPoint)
        );

    }

    /**
     * {@inheritdoc}
     */
    public function updateBookingInfo($id, BookingInfo $bookingInfo)

    {

        $this->guardId($id);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        $commandClass = $this->getCommandClass('UpdateBookingInfo');
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        return $this->commandBus->dispatch(
            new $commandClass($id, $bookingInfo)
        );

    }

    /**
     * {@inheritdoc}
     */
    public function addImage($id, Image $image)

    {
        $this->guardId($id);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        $commandClass = $this->getCommandClass('AddImage');
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        return $this->commandBus->dispatch(
            new $commandClass($id, $image)
        );
    }

    /**
     * {@inheritdoc}
     */
    public function updateImage(

        $id,
        Image $image,
        String $description,
        String $copyrightHolder
    ) {
        $this->guardId($id);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        $commandClass = $this->getCommandClass('UpdateImage');
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        return $this->commandBus->dispatch(
            new $commandClass(
                $id,
                $image->getMediaObjectId(),
                $description,
                $copyrightHolder
            )
        );
    }

    /**
     * @param $id
     *  Id of the offer to remove the image from.
     *
     * @param Image $image
     *  The image that should be removed.
     *
     * @return mixed
     */
    public function removeImage($id, Image $image)
    {
        $this->guardId($id);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        $commandClass = $this->getCommandClass('RemoveImage');
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        return $this->commandBus->dispatch(
            new $commandClass($id, $image)
        );

    }
}


1		<?php
2
3		/**
4		* @file
5		* Contains CultuurNet\UDB3\OfferEditingTrait.
6		*/
7
8		namespace CultuurNet\UDB3;
9
10		use CultuurNet\UDB3\Media\Image;
11		use CultuurNet\UDB3\Media\MediaObject;
12		use ValueObjects\String\String;
13
14		/**
15		* Trait that contains all major editing methods for Offers.
16		*/
17		trait OfferEditingTrait
18		{
19
20		/**
21		* Get the namespaced classname of the command to create.
22		* @param type $className
23		* Name of the class
24		* @return string
25		*/
26		private function getCommandClass($className)
27		{
28		$reflection = new \ReflectionObject($this);
29		return $reflection->getNamespaceName() . '\\Commands\\' . $className;
30		}
31
32		/**
33		* {@inheritdoc}
34		*/
35	View Code Duplication	public function updateDescription($id, $description)
		0 ignored issues – show Duplication introduced 2015-11-24 14:43 UTC by Report Bug Copy Issue Report 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...
36		{
37
38		$this->guardId($id);
		0 ignored issues – show Bug introduced 2016-01-26 17:10 UTC by Report Bug Copy Issue Report It seems like `guardId()` 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...

cultuurnet / udb3-php

Pull Request — master (#121)

OfferEditingTrait::removeImage() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like