HookAdminBlock::notifyAdminBlock() - Code Metrics - Inspection of "WebServices: set visibility to student work" - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — 1.11.x ( bce6cd...c146d9 )

by Angel Fernando Quiroz

created 2021-08-24 22:43 UTC

HookAdminBlock::notifyAdminBlock() A

↳ Parent: HookAdminBlock

Complexity

Conditions	4
Paths	4

Size

Total Lines	19
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php
/* For licensing terms, see /license.txt */

/**
 * This file contains a Hook Event class for Admin Block.
 *
 * @package chamilo.library.hook
 */

/**
 * Class HookAdminBlock
 * This class is a Hook event implementing Admin Block Event interface.
 * This class is used to modify admin block by notifying Hook Observer for Admin Block.
 */
class HookAdminBlock extends HookEvent implements HookAdminBlockEventInterface
{
    /**
     * Constructor.
     */
    protected function __construct()
    {
        parent::__construct('HookAdminBlock');
    }

    /**
     * Notify Hook observers for Admin Block event.
     *
     * @param int $type Set the type of hook event called.
     *                  0: HOOK_EVENT_TYPE_PRE, 1: HOOK_EVENT_TYPE_POST
     *
     * @return array|int
     */
    public function notifyAdminBlock($type)
    {
        /** @var \HookAdminBlockObserverInterface $observer */
        // Save data
        if (isset($this->eventData['blocks'])) {
            $this->eventData['type'] = $type;
            // Call all registered hook observers for admin block
            foreach ($this->observers as $observer) {
                $data = $observer->hookAdminBlock($this);
                if (isset($data['blocks'])) {
                    // Get modified data
                    $this->eventData['blocks'] = $data['blocks'];
                }
            }

            return $this->eventData;
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
        }

        return 0;
    }
}


1			<?php
2			/* For licensing terms, see /license.txt */
3
4			/**
5			* This file contains a Hook Event class for Admin Block.
6			*
7			* @package chamilo.library.hook
8			*/
9
10			/**
11			* Class HookAdminBlock
12			* This class is a Hook event implementing Admin Block Event interface.
13			* This class is used to modify admin block by notifying Hook Observer for Admin Block.
14			*/
15			class HookAdminBlock extends HookEvent implements HookAdminBlockEventInterface
16			{
17			/**
18			* Constructor.
19			*/
20			protected function __construct()
21			{
22			parent::__construct('HookAdminBlock');
23			}
24
25			/**
26			* Notify Hook observers for Admin Block event.
27			*
28			* @param int $type Set the type of hook event called.
29			* 0: HOOK_EVENT_TYPE_PRE, 1: HOOK_EVENT_TYPE_POST
30			*
31			* @return array\|int
32			*/
33			public function notifyAdminBlock($type)
34			{
35			/** @var \HookAdminBlockObserverInterface $observer */
36			// Save data
37			if (isset($this->eventData['blocks'])) {
38			$this->eventData['type'] = $type;
39			// Call all registered hook observers for admin block
40			foreach ($this->observers as $observer) {
41			$data = $observer->hookAdminBlock($this);
42			if (isset($data['blocks'])) {
43			// Get modified data
44			$this->eventData['blocks'] = $data['blocks'];
45			}
46			}
47
48			return $this->eventData;
			0 ignored issues – show Bug Best Practice introduced 2018-04-12 22:57 UTC by Report Bug Copy Issue Report The expression `return $this->eventData` returns the type `array` which is incompatible with the return type mandated by `HookAdminBlockEventInterface::notifyAdminBlock()` of `integer`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
49			}
50
51			return 0;
52			}
53			}
54

chamilo / chamilo-lms

Push — 1.11.x ( bce6cd...c146d9 )

HookAdminBlock::notifyAdminBlock() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like