PrivacyPolicyManager::addPrivacyPolicy() - Code Metrics - Inspection of "Daily Inspection: merge master into GDPR/user-data..." - eventespresso/event-espresso-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — GDPR/user-data-export (1838dd)

unknown

created 2018-05-11 21:51 UTC

PrivacyPolicyManager::addPrivacyPolicy() A

↳ Parent: PrivacyPolicyManager

Complexity

Conditions	3
Paths	3

Size

Total Lines	12
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	6
nc	3
nop	0
dl	0
loc	12
rs	9.4285
c	0
b	0
f	0

<?php

namespace EventEspresso\core\services\privacy\policy;

use EventEspresso\core\exceptions\InvalidClassException;
use EventEspresso\core\exceptions\InvalidDataTypeException;
use EventEspresso\core\exceptions\InvalidEntityException;
use EventEspresso\core\exceptions\InvalidFilePathException;
use EventEspresso\core\exceptions\InvalidIdentifierException;
use EventEspresso\core\exceptions\InvalidInterfaceException;
use EventEspresso\core\services\collections\CollectionDetails;
use EventEspresso\core\services\collections\CollectionInterface;
use EventEspresso\core\services\collections\CollectionLoader;
use WP_Post;

/**
 * Class PrivacyPolicyManager
 * Manages setting up the hooks to add the EE core and add-ons' privacy policies
 *
 * @package        Event Espresso
 * @author         Mike Nelson
 * @since          $VID:$
 */
class PrivacyPolicyManager
{

    public function __construct()
    {
        add_action('admin_init', array($this, 'addPrivacyPolicy'), 9);
    }


    /**
     * For all the registered `PrivacyPolicyInterface`s, add their privacy policy content
     *
     * @param WP_Post $post
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     */
    public function addPrivacyPolicy()
    {
        $policy_page_id = (int) get_option('wp_page_for_privacy_policy');
        if (! $policy_page_id) {
            return;
        }
        // load all the privacy policy stuff
        // add post policy text
        foreach ($this->loadPrivacyPolicyCollection() as $privacy_policy) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            wp_add_privacy_policy_content($privacy_policy->getName(), $privacy_policy->getContent());
        }
    }


    /**
     * @return CollectionInterface|PrivacyPolicyInterface[]
     * @throws InvalidIdentifierException
     * @throws InvalidInterfaceException
     * @throws InvalidFilePathException
     * @throws InvalidEntityException
     * @throws InvalidDataTypeException
     * @throws InvalidClassException
     */
    protected function loadPrivacyPolicyCollection()
    {
        $loader = new CollectionLoader(
            new CollectionDetails(
                // collection name
                'privacy_policies',
                // collection interface
                'EventEspresso\core\services\privacy\policy\PrivacyPolicyInterface',
                // FQCNs for classes to add (all classes within that namespace will be loaded)
                apply_filters(
                    'FHEE__EventEspresso_core_services_privacy_policy_PrivacyPolicyManager__privacy_policies',
                    array('EventEspresso\core\domain\services\admin\privacy\policy\PrivacyPolicy')
                ),
                // filepaths to classes to add
                array(),
                // file mask to use if parsing folder for files to add
                '',
                // what to use as identifier for collection entities
                // using CLASS NAME prevents duplicates (works like a singleton)
                CollectionDetails::ID_CLASS_NAME
            )
        );
        return $loader->getCollection();
    }
}
// End of file PrivacyPolicyManager.php
// Location: EventEspresso\core\domain\services\admin/PrivacyPolicyManager.php


1		<?php
2
3		namespace EventEspresso\core\services\privacy\policy;
4
5		use EventEspresso\core\exceptions\InvalidClassException;
6		use EventEspresso\core\exceptions\InvalidDataTypeException;
7		use EventEspresso\core\exceptions\InvalidEntityException;
8		use EventEspresso\core\exceptions\InvalidFilePathException;
9		use EventEspresso\core\exceptions\InvalidIdentifierException;
10		use EventEspresso\core\exceptions\InvalidInterfaceException;
11		use EventEspresso\core\services\collections\CollectionDetails;
12		use EventEspresso\core\services\collections\CollectionInterface;
13		use EventEspresso\core\services\collections\CollectionLoader;
14		use WP_Post;
15
16		/**
17		* Class PrivacyPolicyManager
18		* Manages setting up the hooks to add the EE core and add-ons' privacy policies
19		*
20		* @package Event Espresso
21		* @author Mike Nelson
22		* @since $VID:$
23		*/
24		class PrivacyPolicyManager
25		{
26
27		public function __construct()
28		{
29		add_action('admin_init', array($this, 'addPrivacyPolicy'), 9);
30		}
31
32
33		/**
34		* For all the registered `PrivacyPolicyInterface`s, add their privacy policy content
35		*
36		* @param WP_Post $post
		0 ignored issues – show Bug introduced 2018-05-10 20:29 UTC by Report Bug Copy Issue Report There is no parameter named `$post`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
37		*/
38		public function addPrivacyPolicy()
39		{
40		$policy_page_id = (int) get_option('wp_page_for_privacy_policy');
41		if (! $policy_page_id) {
42		return;
43		}
44		// load all the privacy policy stuff
45		// add post policy text
46		foreach ($this->loadPrivacyPolicyCollection() as $privacy_policy) {
		0 ignored issues – show Bug introduced 2018-05-03 18:12 UTC by Report Bug Copy Issue Report The expression `$this->loadPrivacyPolicyCollection()` of type `object<EventEspresso\cor...rivacyPolicyInterface>>` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
47		wp_add_privacy_policy_content($privacy_policy->getName(), $privacy_policy->getContent());
48		}
49		}
50
51
52		/**
53		* @return CollectionInterface\|PrivacyPolicyInterface[]
54		* @throws InvalidIdentifierException
55		* @throws InvalidInterfaceException
56		* @throws InvalidFilePathException
57		* @throws InvalidEntityException
58		* @throws InvalidDataTypeException
59		* @throws InvalidClassException
60		*/
61	View Code Duplication	protected function loadPrivacyPolicyCollection()
62		{
63		$loader = new CollectionLoader(
64		new CollectionDetails(
65		// collection name
66		'privacy_policies',
67		// collection interface
68		'EventEspresso\core\services\privacy\policy\PrivacyPolicyInterface',
69		// FQCNs for classes to add (all classes within that namespace will be loaded)
70		apply_filters(
71		'FHEE__EventEspresso_core_services_privacy_policy_PrivacyPolicyManager__privacy_policies',
72		array('EventEspresso\core\domain\services\admin\privacy\policy\PrivacyPolicy')
73		),
74		// filepaths to classes to add
75		array(),
76		// file mask to use if parsing folder for files to add
77		'',
78		// what to use as identifier for collection entities
79		// using CLASS NAME prevents duplicates (works like a singleton)
80		CollectionDetails::ID_CLASS_NAME
81		)
82		);
83		return $loader->getCollection();
84		}
85		}
86		// End of file PrivacyPolicyManager.php
87		// Location: EventEspresso\core\domain\services\admin/PrivacyPolicyManager.php
88

eventespresso / event-espresso-core

Branch — GDPR/user-data-export (1838dd)

PrivacyPolicyManager::addPrivacyPolicy() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like