ImagineBlock::getImage() - Code Metrics - Inspection of "Implement ImagineBlock" - Lakion/CmsPlugin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#70)

unknown

created 2018-02-01 23:20 UTC

ImagineBlock::getImage() A

↳ Parent: ImagineBlock

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
dl	0
loc	4
rs	10
c	1
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?php

/*
 * This file is part of the Symfony CMF package.
 *
 * (c) 2011-2017 Symfony CMF
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Lakion\CmsPlugin\Document;

use PHPCR\NodeInterface;
use Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\AbstractBlock;
use Symfony\Cmf\Bundle\MediaBundle\Doctrine\Phpcr\Image;
use Symfony\Cmf\Bundle\MediaBundle\ImageInterface;
use Symfony\Cmf\Bundle\CoreBundle\Translatable\TranslatableInterface;
use Symfony\Component\HttpFoundation\File\UploadedFile;

/**
 * Block to hold an image.
 */
class ImagineBlock extends AbstractBlock implements TranslatableInterface
{
    /**
     * @var Image
     */
    protected $image;

    /**
     * @var string
     */
    protected $label;

    /**
     * Optional link url to use on the image.
     *
     * @var string
     */
    protected $linkUrl;

    /**
     * @var string
     */
    protected $filter;

    /**
     * @var \PHPCR\NodeInterface
     */
    protected $node;

    /**
     * {@inheritdoc}
     */
    public function getType()
    {
        return 'cmf.block.imagine';
    }

    /**
     * Set label.
     *
     * @param string $label
     *
     * @return $this
     */
    public function setLabel($label)
    {
        $this->label = $label;

        return $this;
    }

    /**
     * Get label.
     *
     * @return string
     */
    public function getLabel()
    {
        return $this->label;
    }

    /**
     * Set link url.
     *
     * @param string $url
     *
     * @return $this
     */
    public function setLinkUrl($url)
    {
        $this->linkUrl = $url;

        return $this;
    }

    /**
     * Get link url.
     *
     * @return string
     */
    public function getLinkUrl()
    {
        return $this->linkUrl;
    }

    /**
     * Sets the Imagine filter which is going to be used.
     *
     * @param string $filter
     *
     * @return $this
     */
    public function setFilter($filter)
    {
        $this->filter = $filter;

        return $this;
    }

    /**
     * Get the Imagine filter.
     *
     * @return string
     */
    public function getFilter()
    {
        return $this->filter;
    }

    /**
     * Set the image for this block.
     *
     * Setting null will do nothing, as this is what happens when you edit this
     * block in a form without uploading a replacement file.
     *
     * If you need to delete the Image, you can use getImage and delete it with
     * the document manager. Note that this block does not make much sense
     * without an image, though.
     *
     * @param ImageInterface|UploadedFile|null $image optional the image to update
     *
     * @return $this
     *
     * @throws \InvalidArgumentException if the $image parameter can not be handled
     */
    public function setImage($image = null)
    {
        if (!$image) {
            return $this;
        }

        if (!$image instanceof ImageInterface && !$image instanceof UploadedFile) {
            $type = is_object($image) ? get_class($image) : gettype($image);

            throw new \InvalidArgumentException(sprintf(
                'Image is not a valid type, "%s" given.',
                $type
            ));
        }

        if ($this->image) {
            // existing image, only update content
            // TODO: https://github.com/doctrine/phpcr-odm/pull/262
            $this->image->copyContentFromFile($image);
        } elseif ($image instanceof ImageInterface) {
            $image->setName('image'); // ensure document has right name
            $this->image = $image;
class Alien {}

class Dalek extends Alien {}

class Plot
{
    /** @var  Dalek */
    public $villain;
}

$alien = new Alien();
$plot = new Plot();
if ($alien instanceof Dalek) {
    $plot->villain = $alien;
}
        } else {
            $this->image = new Image();
            $this->image->copyContentFromFile($image);
        }

        return $this;
    }

    /**
     * Get image.
     *
     * @return Image
     */
    public function getImage()
    {
        return $this->image;
    }

    /**
     * Get node.
     *
     * @return NodeInterface
     */
    public function getNode()
    {
        return $this->node;
    }
}


1			<?php
2
3			/*
4			* This file is part of the Symfony CMF package.
5			*
6			* (c) 2011-2017 Symfony CMF
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 Lakion\CmsPlugin\Document;
13
14			use PHPCR\NodeInterface;
15			use Symfony\Cmf\Bundle\BlockBundle\Doctrine\Phpcr\AbstractBlock;
16			use Symfony\Cmf\Bundle\MediaBundle\Doctrine\Phpcr\Image;
17			use Symfony\Cmf\Bundle\MediaBundle\ImageInterface;
18			use Symfony\Cmf\Bundle\CoreBundle\Translatable\TranslatableInterface;
19			use Symfony\Component\HttpFoundation\File\UploadedFile;
20
21			/**
22			* Block to hold an image.
23			*/
24			class ImagineBlock extends AbstractBlock implements TranslatableInterface
25			{
26			/**
27			* @var Image
28			*/
29			protected $image;
30
31			/**
32			* @var string
33			*/
34			protected $label;
35
36			/**
37			* Optional link url to use on the image.
38			*
39			* @var string
40			*/
41			protected $linkUrl;
42
43			/**
44			* @var string
45			*/
46			protected $filter;
47
48			/**
49			* @var \PHPCR\NodeInterface
50			*/
51			protected $node;
52
53			/**
54			* {@inheritdoc}
55			*/
56			public function getType()
57			{
58			return 'cmf.block.imagine';
59			}
60
61			/**
62			* Set label.
63			*
64			* @param string $label
65			*
66			* @return $this
67			*/
68			public function setLabel($label)
69			{
70			$this->label = $label;
71
72			return $this;
73			}
74
75			/**
76			* Get label.
77			*
78			* @return string
79			*/
80			public function getLabel()
81			{
82			return $this->label;
83			}
84
85			/**
86			* Set link url.
87			*
88			* @param string $url
89			*
90			* @return $this
91			*/
92			public function setLinkUrl($url)
93			{
94			$this->linkUrl = $url;
95
96			return $this;
97			}
98
99			/**
100			* Get link url.
101			*
102			* @return string
103			*/
104			public function getLinkUrl()
105			{
106			return $this->linkUrl;
107			}
108
109			/**
110			* Sets the Imagine filter which is going to be used.
111			*
112			* @param string $filter
113			*
114			* @return $this
115			*/
116			public function setFilter($filter)
117			{
118			$this->filter = $filter;
119
120			return $this;
121			}
122
123			/**
124			* Get the Imagine filter.
125			*
126			* @return string
127			*/
128			public function getFilter()
129			{
130			return $this->filter;
131			}
132
133			/**
134			* Set the image for this block.
135			*
136			* Setting null will do nothing, as this is what happens when you edit this
137			* block in a form without uploading a replacement file.
138			*
139			* If you need to delete the Image, you can use getImage and delete it with
140			* the document manager. Note that this block does not make much sense
141			* without an image, though.
142			*
143			* @param ImageInterface\|UploadedFile\|null $image optional the image to update
144			*
145			* @return $this
146			*
147			* @throws \InvalidArgumentException if the $image parameter can not be handled
148			*/
149			public function setImage($image = null)
150			{
151			if (!$image) {
152			return $this;
153			}
154
155			if (!$image instanceof ImageInterface && !$image instanceof UploadedFile) {
156			$type = is_object($image) ? get_class($image) : gettype($image);
157
158			throw new \InvalidArgumentException(sprintf(
159			'Image is not a valid type, "%s" given.',
160			$type
161			));
162			}
163
164			if ($this->image) {
165			// existing image, only update content
166			// TODO: https://github.com/doctrine/phpcr-odm/pull/262
167			$this->image->copyContentFromFile($image);
168			} elseif ($image instanceof ImageInterface) {
169			$image->setName('image'); // ensure document has right name
170			$this->image = $image;
			0 ignored issues – show Documentation Bug introduced 2018-02-01 23:22 UTC by Report Bug Copy Issue Report `$image` is of type `object<Symfony\Cmf\Bundl...aBundle\ImageInterface>`, but the property `$image` was declared to be of type `object<Symfony\Cmf\Bundl...e\Doctrine\Phpcr\Image>`. Are you sure that you always receive this specific sub-class here, or does it make sense to add an `instanceof` check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a given class or a super-class is assigned to a property that is type hinted more strictly. Either this assignment is in error or an instanceof check should be added for that assignment. class Alien {} class Dalek extends Alien {} class Plot { /** @var Dalek */ public $villain; } $alien = new Alien(); $plot = new Plot(); if ($alien instanceof Dalek) { $plot->villain = $alien; } Loading history...
171			} else {
172			$this->image = new Image();
173			$this->image->copyContentFromFile($image);
174			}
175
176			return $this;
177			}
178
179			/**
180			* Get image.
181			*
182			* @return Image
183			*/
184			public function getImage()
185			{
186			return $this->image;
187			}
188
189			/**
190			* Get node.
191			*
192			* @return NodeInterface
193			*/
194			public function getNode()
195			{
196			return $this->node;
197			}
198			}
199

Lakion / CmsPlugin

Pull Request — master (#70)

ImagineBlock::getImage() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like