Usher::getPlace() - Code Metrics - sixty-nine/php-cloud-lib - Measure and Improve Code Quality continuously with Scrutinizer

Usher::getPlace() A
last analyzed 2018-12-13 06:45 UTC

↳ Parent: Usher

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	13
CRAP Score	3.0032

Importance

Changes

Metric	Value
dl	0
loc	33
rs	9.392
c	0
b	0
f	0
ccs	13
cts	14
cp	0.9286
cc	3
nc	3
nop	4
crap	3.0032

<?php

namespace SixtyNine\Cloud\Usher;

use Imagine\Image\Point;
use SixtyNine\Cloud\Drawer\Drawer;
use SixtyNine\Cloud\Factory\Logger;
use SixtyNine\Cloud\FontMetrics;
use SixtyNine\DataTypes\Box;
use SixtyNine\Cloud\Placer\PlacerInterface;

/**
 * Responsible to find a place for the word in the cloud
 */

class Usher
{
    const DEFAULT_MAX_TRIES = 100000;

    /** @var int */
    protected $maxTries;

    /** @var \SixtyNine\Cloud\Usher\MaskInterface */
    protected $mask;

    /** @var \SixtyNine\Cloud\Placer\PlacerInterface */
    protected $placer;

    /** @var \SixtyNine\Cloud\FontMetrics */
    protected $metrics;

    /** @var int */
    protected $precise;

    /** @var Logger */
    protected $logger;

    /**
     * @param int $imgWidth
     * @param int $imgHeight
     * @param PlacerInterface $placer
     * @param FontMetrics $metrics
     * @param bool $precise
     * @param int $maxTries
     */
    public function __construct(
        $imgWidth,
        $imgHeight,
        PlacerInterface $placer,
        FontMetrics $metrics,
        $precise = false,
        $maxTries = self::DEFAULT_MAX_TRIES
    ) {
        $this->metrics = $metrics;
        $this->imgHeight = $imgHeight;
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $this->imgWidth = $imgWidth;
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $this->maxTries = $maxTries;
        $this->placer = $placer;
        $this->logger = Logger::getInstance();
        $this->precise = $precise;
$answer = 42;

$correct = false;

$correct = (bool) $answer;

        $this->mask = $precise
            ? new PreciseMask($imgWidth, $imgHeight, $this->metrics)
            : new QuadTreeMask($imgWidth, $imgHeight)
        ;
    }

    /**
     * @param string $word
     * @param string $font
     * @param int $fontSize
     * @param int $angle
     * @return bool|Box
     */
    public function getPlace($word, $font, $fontSize, $angle)
    {
        $this->logger->log(
            sprintf(
                'Search place for "%s", font = %s(%s), angle = %s',
                $word,
                str_replace('.ttf', '', $font),
                $fontSize,
                $angle
            ),
            Logger::DEBUG
        );

        $bounds = new Box(0, 0, $this->imgWidth, $this->imgHeight);
        $size = $this->metrics->calculateSize($word, $font, $fontSize);
        $box = Drawer::getBoxForText(0, 0, $size->getWidth(), $size->getHeight(), $angle);

        $this->logger->log('  Text dimensions: ' . $size->getDimensions(), Logger::DEBUG);

        $place = $this->searchPlace($bounds, $box);

        if (!$place) {
            return false;
        }

        if ($this->precise) {
            $this->mask->addWordToMask($word, $place, $font, $fontSize, $angle);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            return $place;
        }

        $this->mask->add(new Point(0, 0), $place);
        return $place;
    }

    /**
     * Search a free place for a new box.
     * @param \SixtyNine\DataTypes\Box $bounds
     * @param \SixtyNine\DataTypes\Box $box
     * @return bool|Box
     */
    protected function searchPlace(Box $bounds, Box $box)
    {

        $this->logger->log('  Search place for ' . $box, Logger::DEBUG);

        $placeFound = false;
        $current = $this->placer->getFirstPlaceToTry();
        $curTry = 1;
        $currentBox = null;

        while (!$placeFound) {

            if (!$current) {
                return false;
            }

            if ($curTry > $this->maxTries) {
                return false;
            }

            $currentBox = $box->move($current->getX(), $current->getY());

            $outOfBounds = !$currentBox->inside($bounds);

            if (!$outOfBounds) {
                $placeFound = !$this->mask->overlaps($currentBox);
                $placeFound = $placeFound && !$outOfBounds;
            }

            $this->logger->log(sprintf(
                '  Trying %s --> %s',
                $currentBox,
                $outOfBounds ? 'Out of bounds' : ($placeFound ? 'OK' : 'Collision')
            ), Logger::DEBUG);

            if ($placeFound) {
                break;
            }

            $current = $this->placer->getNextPlaceToTry($current);
            $curTry++;
        }

        return $currentBox->inside($bounds) ? $currentBox : false;
    }

    /**
     * @return MaskInterface
     */
    public function getMask()
    {
        return $this->mask;
    }
}


1		<?php
2
3		namespace SixtyNine\Cloud\Usher;
4
5		use Imagine\Image\Point;
6		use SixtyNine\Cloud\Drawer\Drawer;
7		use SixtyNine\Cloud\Factory\Logger;
8		use SixtyNine\Cloud\FontMetrics;
9		use SixtyNine\DataTypes\Box;
10		use SixtyNine\Cloud\Placer\PlacerInterface;
11
12		/**
13		* Responsible to find a place for the word in the cloud
14		*/
15
16		class Usher
17		{
18		const DEFAULT_MAX_TRIES = 100000;
19
20		/** @var int */
21		protected $maxTries;
22
23		/** @var \SixtyNine\Cloud\Usher\MaskInterface */
24		protected $mask;
25
26		/** @var \SixtyNine\Cloud\Placer\PlacerInterface */
27		protected $placer;
28
29		/** @var \SixtyNine\Cloud\FontMetrics */
30		protected $metrics;
31
32		/** @var int */
33		protected $precise;
34
35		/** @var Logger */
36		protected $logger;
37
38		/**
39		* @param int $imgWidth
40		* @param int $imgHeight
41		* @param PlacerInterface $placer
42	6	* @param FontMetrics $metrics
43		* @param bool $precise
44		* @param int $maxTries
45		*/
46		public function __construct(
47		$imgWidth,
48		$imgHeight,
49	6	PlacerInterface $placer,
50	6	FontMetrics $metrics,
51	6	$precise = false,
52	6	$maxTries = self::DEFAULT_MAX_TRIES
53	6	) {
54	6	$this->metrics = $metrics;
55	6	$this->imgHeight = $imgHeight;
		0 ignored issues – show Bug introduced 2017-04-02 15:11 UTC by Report Bug Copy Issue Report The property `imgHeight` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
56	6	$this->imgWidth = $imgWidth;
		0 ignored issues – show Bug introduced 2017-04-02 15:11 UTC by Report Bug Copy Issue Report The property `imgWidth` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
57		$this->maxTries = $maxTries;
58		$this->placer = $placer;
59		$this->logger = Logger::getInstance();
60		$this->precise = $precise;
		0 ignored issues – show Documentation Bug introduced 2018-09-30 10:13 UTC by Report Bug Copy Issue Report The property `$precise` was declared of type `integer`, but `$precise` is of type `boolean`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
61
62		$this->mask = $precise
63		? new PreciseMask($imgWidth, $imgHeight, $this->metrics)
64		: new QuadTreeMask($imgWidth, $imgHeight)
65		;
66	6	}
67
68	6	/**
69	6	* @param string $word
70	6	* @param string $font
71	6	* @param int $fontSize
72	6	* @param int $angle
73	6	* @return bool\|Box
74	6	*/
75		public function getPlace($word, $font, $fontSize, $angle)
76	6	{
77		$this->logger->log(
78		sprintf(
79	6	'Search place for "%s", font = %s(%s), angle = %s',
80	6	$word,
81	6	str_replace('.ttf', '', $font),
82		$fontSize,
83	6	$angle
84		),
85	6	Logger::DEBUG
86		);
87	6
88		$bounds = new Box(0, 0, $this->imgWidth, $this->imgHeight);
89		$size = $this->metrics->calculateSize($word, $font, $fontSize);
90		$box = Drawer::getBoxForText(0, 0, $size->getWidth(), $size->getHeight(), $angle);
91	6
92	1	$this->logger->log(' Text dimensions: ' . $size->getDimensions(), Logger::DEBUG);
93	1
94		$place = $this->searchPlace($bounds, $box);
95
96	5	if (!$place) {
97	5	return false;
98		}
99
100		if ($this->precise) {
101		$this->mask->addWordToMask($word, $place, $font, $fontSize, $angle);
		0 ignored issues – show Bug introduced 2018-09-30 10:13 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `SixtyNine\Cloud\Usher\MaskInterface` as the method `addWordToMask()` does only exist in the following implementations of said interface: `SixtyNine\Cloud\Usher\PreciseMask`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
102		return $place;
103		}
104
105		$this->mask->add(new Point(0, 0), $place);
106		return $place;
107	1	}
108
109	1	/**
110	1	* Search a free place for a new box.
111	1	* @param \SixtyNine\DataTypes\Box $bounds
112		* @param \SixtyNine\DataTypes\Box $box
113	1	* @return bool\|Box
114	1	*/
115	1	protected function searchPlace(Box $bounds, Box $box)
116	1	{
117	1
118		$this->logger->log(' Search place for ' . $box, Logger::DEBUG);
119
120		$placeFound = false;
121	1	$current = $this->placer->getFirstPlaceToTry();
122		$curTry = 1;
123	1	$currentBox = null;
124
125		while (!$placeFound) {
126
127	1	if (!$current) {
128		return false;
129		}
130
131	1	if ($curTry > $this->maxTries) {
132	1	return false;
133	1	}
134
135	1	$currentBox = $box->move($current->getX(), $current->getY());
136	1
137		$outOfBounds = !$currentBox->inside($bounds);
138	1
139		if (!$outOfBounds) {
140		$placeFound = !$this->mask->overlaps($currentBox);
141		$placeFound = $placeFound && !$outOfBounds;
142		}
143
144		$this->logger->log(sprintf(
145		' Trying %s --> %s',
146	6	$currentBox,
147		$outOfBounds ? 'Out of bounds' : ($placeFound ? 'OK' : 'Collision')
148		), Logger::DEBUG);
149	6
150		if ($placeFound) {
151	6	break;
152	6	}
153	6
154	6	$current = $this->placer->getNextPlaceToTry($current);
155		$curTry++;
156	6	}
157
158	6	return $currentBox->inside($bounds) ? $currentBox : false;
159		}
160
161		/**
162	6	* @return MaskInterface
163		*/
164		public function getMask()
165		{
166	6	return $this->mask;
167		}
168		}
169

sixty-nine / php-cloud-lib

Usher::getPlace() A last analyzed 2018-12-13 06:45 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

Usher::getPlace() A
last analyzed 2018-12-13 06:45 UTC