Lister - Code Metrics - cadmium-org/cadmium-cms - Measure and Improve Code Quality continuously with Scrutinizer

Lister B
last analyzed 2017-10-02 14:48 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	199
Duplicated Lines	1.51 %

Coupling/Cohesion

Components	1
Dependencies	12

Importance

Changes

Metric	Value
dl	3
loc	199
rs	8.3999
c	0
b	0
f	0
wmc	38
lcom	1
cbo	12

6 Methods

Rating	Name	Duplication	Size	Complexity
A	processParent()	3	22	3
C	processItems()	0	45	14
A	getPaginationBlock()	0	10	2
B	getContents()	0	24	6
C	handleAjax()	0	30	7
B	handle()	0	28	6

How to fix Duplicated Code

<?php

/**
 * @package Cadmium\System\Modules\Entitizer
 * @author Anton Romanov
 * @copyright Copyright (c) 2015-2017, Anton Romanov
 * @link http://cadmium-cms.com
 */

namespace Modules\Entitizer\Utils {

	use Frames, Modules\Entitizer, Modules\Settings, Utils\Pagination, Utils\View, Ajax, Number, Request, Template, Url;

	abstract class Lister extends Frames\Admin\Area\Panel {

		protected $parent = null, $entity = null, $path = [], $depth = 0, $index = 0;

		protected $items = ['list' => [], 'total' => 0];

		/**
		 * Process the parent block
		 */

		private function processParent(Template\Block $parent) {

			# Set parent id

			$parent->id = $this->parent->id;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

			# Set create button

			if (count($this->path) < CONFIG_ENTITIZER_MAX_DEPTH) $parent->getBlock('create')->id = $this->parent->id;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

			else { $parent->getBlock('create')->disable(); $parent->getBlock('create_disabled')->enable(); }

			# Set edit button

			if (0 !== $this->parent->id) $parent->getBlock('edit')->id = $this->parent->id;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

			else { $parent->getBlock('edit')->disable(); $parent->getBlock('edit_disabled')->enable(); }

			# Add parent additional data

			$this->processEntityParent($parent);
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
		}

		/**
		 * Process the items block
		 */

		private function processItems(Template\Block $items, bool $ajax = false) {

			foreach ($this->items['list'] as $item) {

				if ((null !== $this->entity) && ($item['dataset']->id === $this->entity->id)) continue;

				$items->addItem($view = View::get(!$ajax ? static::$view_item : static::$view_ajax_item));

				# Set data

				$view->id = $item['dataset']->id;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

				$view->set(static::$naming, $item['dataset']->get(static::$naming));

				# Set buttons

				if (!$ajax) {

					if (static::$nesting) {

						$fertile = ((count($this->path) + 1) < CONFIG_ENTITIZER_MAX_DEPTH);

						$view->getBlock('create')->class = ($fertile ? 'olive' : 'disabled');
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

						$view->getBlock('create')->id = $item['dataset']->id;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
					}

					$super = (static::$super && ($item['dataset']->id === 1));

					$has_children = (static::$nesting && ($item['children'] > 0));

					$view->getBlock('remove')->class = ((!$super && !$has_children) ? 'negative' : 'disabled');
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

				} else {

					$selectable = ((count($this->path) + $this->depth + 1) < CONFIG_ENTITIZER_MAX_DEPTH);

					$view->getBlock('select')->class = ($selectable ? 'grey' : 'disabled');
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
				}

				# Add item additional data

				$this->processItem($view, $item['dataset'], (static::$nesting ? $item['children'] : 0));

			}
		}

		/**
		 * Get the pagination block
		 *
		 * @return Template\Block|false : a block or false if there is only a single page
		 */

		private function getPaginationBlock() {

			$query = (static::$nesting ? ('?parent_id=' . $this->parent->id) : '');
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

			$url = new Url(INSTALL_PATH . static::$link . $query);

			# ------------------------

			return Pagination::getBlock($this->index, Settings::get('admin_display_entities'), $this->items['total'], $url);
		}

		/**
		 * Get the contents block
		 */

		private function getContents(bool $ajax = false) : Template\Block {

			$contents = View::get(!$ajax ? static::$view_main : static::$view_ajax_main);

			# Set path

			if (static::$nesting) $contents->path = $this->path;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

			# Process parent block

			if (static::$nesting && !$ajax) $this->processParent($contents->getBlock('parent'));

			# Process items block

			$this->processItems($contents->getBlock('items'), $ajax);

			# Set pagination

			if (!$ajax) $contents->pagination = $this->getPaginationBlock();
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

			# ------------------------

			return $contents;
		}

		/**
		 * Handle the ajax request
		 */

		private function handleAjax() : Ajax\Response {

			$ajax = Ajax::createResponse();

			# Create parent entity

			$parent_id = (static::$nesting ? Number::forceInt(Request::get('parent_id')) : 0);

			$this->parent = Entitizer::get(static::$table, $parent_id);

			# Create active entity

			$this->entity = Entitizer::get(static::$table, Number::forceInt(Request::post('id')));

			# Get path and depth

			if (false !== ($path = $this->parent->getPath())) $this->path = $path;

			if ((0 !== $this->entity->id) && (false !== ($depth = $this->entity->getSubtreeDepth()))) $this->depth = $depth;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

			# Get items list

			$lister = (static::$nesting ? 'getChildren' : 'getItems');

			if (false !== ($items = $this->parent->$lister())) $this->items = $items;

			# ------------------------

			return $ajax->set('contents', $this->getContents(true)->getContents());
		}

		/**
		 * Handle the request
		 *
		 * @return Template\Block|Ajax\Response : a block object if the ajax param was set to false, otherwise an ajax response
		 */

		protected function handle(bool $ajax = false) {

			if ($ajax) return $this->handleAjax();

			# Create parent entity

			$parent_id = (static::$nesting ? Number::forceInt(Request::get('parent_id')) : 0);

			$this->parent = Entitizer::get(static::$table, $parent_id);

			# Get path

			if (false !== ($path = $this->parent->getPath())) $this->path = $path;

			# Get index

			$this->index = Number::forceInt(Request::get('index'), 1, 999999);

			# Get items list

			$lister = (static::$nesting ? 'getChildren' : 'getItems'); $display = Settings::get('admin_display_entities');

			if (false !== ($items = $this->parent->$lister([], [], $this->index, $display))) $this->items = $items;

			# ------------------------

			return $this->getContents();
		}
	}
}


1		<?php
2
3		/**
4		* @package Cadmium\System\Modules\Entitizer
5		* @author Anton Romanov
6		* @copyright Copyright (c) 2015-2017, Anton Romanov
7		* @link http://cadmium-cms.com
8		*/
9
10		namespace Modules\Entitizer\Utils {
11
12		use Frames, Modules\Entitizer, Modules\Settings, Utils\Pagination, Utils\View, Ajax, Number, Request, Template, Url;
13
14		abstract class Lister extends Frames\Admin\Area\Panel {
15
16		protected $parent = null, $entity = null, $path = [], $depth = 0, $index = 0;
17
18		protected $items = ['list' => [], 'total' => 0];
19
20		/**
21		* Process the parent block
22		*/
23
24		private function processParent(Template\Block $parent) {
25
26		# Set parent id
27
28		$parent->id = $this->parent->id;
		0 ignored issues – show Documentation introduced 2016-11-14 22:52 UTC by Report Bug Copy Issue Report The property `id` does not exist on `object<Template\Block>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history... Bug introduced 2017-03-20 20:18 UTC by Report Bug Copy Issue Report The property `id` does not seem to exist in `Modules\Entitizer\Utils\Entity`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
29
30		# Set create button
31
32		if (count($this->path) < CONFIG_ENTITIZER_MAX_DEPTH) $parent->getBlock('create')->id = $this->parent->id;
		0 ignored issues – show Documentation introduced 2016-11-17 00:07 UTC by Report Bug Copy Issue Report The property `id` does not exist on `object<Template\Block>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
33
34		else { $parent->getBlock('create')->disable(); $parent->getBlock('create_disabled')->enable(); }
35
36		# Set edit button
37
38	View Code Duplication	if (0 !== $this->parent->id) $parent->getBlock('edit')->id = $this->parent->id;

cadmium-org / cadmium-cms

Lister B last analyzed 2017-10-02 14:48 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

6 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Duplication Side-by-Side

Filter issues like

Lister B
last analyzed 2017-10-02 14:48 UTC