Drupal7Placeholder::injectCustomJavascript() - Code Metrics - Inspection of "Add Drupal 8 support" - BR0kEN-/TqExtension - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#16)

by Sergii

created 2017-01-02 05:56 UTC

Drupal7Placeholder::injectCustomJavascript() B

↳ Parent: Drupal7Placeholder

Complexity

Conditions	2
Paths	2

Size

Total Lines	25
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	25
rs	8.8571
cc	2
eloc	17
nc	2
nop	2

<?php
/**
 * @author Sergii Bondarenko, <[email protected]>
 */
namespace Drupal\TqExtension\Cores;

use Behat\Behat\Hook\Scope\BeforeFeatureScope;
use Drupal\TqExtension\Utils\Database\FetchField;

final class Drupal7Placeholder extends DrupalKernelPlaceholder
{
    /**
     * {@inheritdoc}
     */
    public static function beforeFeature(BeforeFeatureScope $scope)
    {
        // Set to "false", because the administration menu will not be rendered.
        // @see https://www.drupal.org/node/2023625#comment-8607207
        variable_set('admin_menu_cache_client', false);
    }

    /**
     * {@inheritdoc}
     */
    public static function t($string, array $arguments = [], array $options = [])
    {
        return t($string, $arguments, $options);
    }

    /**
     * {@inheritdoc}
     */
    public static function formatString($string, array $arguments = [])
    {
        return format_string($string, $arguments);
    }

    /**
     * {@inheritdoc}
     */
    public static function arg()
    {
        return arg();
    }

    /**
     * {@inheritdoc}
     */
    public static function tokenReplace($text, array $data = [], array $options = [])
    {
        return token_replace($text, $data, $options);
    }

    /**
     * {@inheritdoc}
     */
    public static function sitePath()
    {
        return conf_path();
    }

    /**
     * {@inheritdoc}
     */
    public static function jsonEncode($data)
    {
        return drupal_json_encode($data);
    }

    /**
     * {@inheritdoc}
     *
     * @return \stdClass
     */
    public static function getCurrentUser()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        return $GLOBALS['user'];
    }

    /**
     * {@inheritdoc}
     *
     * @param \stdClass $user
     */
    public static function setCurrentUser($user)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $GLOBALS['user'] = $user;
    }

    /**
     * {@inheritdoc}
     */
    public static function setCurrentPath($path)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $_GET['q'] = $path;
    }

    /**
     * {@inheritdoc}
     */
    public static function getUidByName($username)
    {
        return (int) (new FetchField('users', 'uid'))
            ->condition('name', $username)
            ->execute();
    }

    /**
     * {@inheritdoc}
     */
    public static function deleteUser($user_id)
    {
        user_delete($user_id);
    }

    /**
     * {@inheritdoc}
     *
     * @return \SelectQuery
     */
    public static function selectQuery($table, $alias = null, array $options = [])
    {
        return db_select($table, $alias, $options);
    }

    /**
     * {@inheritdoc}
     */
    public static function getFieldDefinitions($entityType, $bundle)
    {
        // Load entity properties because in Drupal 8 they are assumed as regular fields.
        $entityProperties = entity_get_property_info($entityType);
        $fieldInstances = field_info_instances($entityType, $bundle);
        $definitions = [];

        if (!empty($entityProperties['properties'])) {
            $fieldInstances += $entityProperties['properties'];
        }

        foreach ($fieldInstances as $name => $definition) {
            $definitions[$name] = [
                'label' => $definition['label'],
                'required' => !empty($definition['required']),
            ];
        }

        return $definitions;
    }

    /**
     * {@inheritdoc}
     */
    public static function getDatabaseConnectionInfo($connection)
    {
        return \Database::getConnectionInfo($connection);
    }

    /**
     * {@inheritdoc}
     */
    public static function entityCreate($entityType, array $values)
    {
        $entity = entity_create($entityType, $values);

        entity_save($entityType, $entity);
        list($entityId, , $bundle) = entity_extract_ids($entityType, $entity);

        return [$entityId, $entityType, $bundle];
    }

    /**
     * {@inheritdoc}
     */
    public static function entityLoad($entityType, $id)
    {
        $entities = entity_load($entityType, [$id]);

        return empty($entities) ? null : reset($entities);
    }

    /**
     * {@inheritdoc}
     */
    public static function entityHasField($entity, $fieldName)
    {
        return isset($entity->{$fieldName});
    }

    /**
     * {@inheritdoc}
     *
     * @param \EntityDrupalWrapper $entity
     */
    public static function entityFieldValue($entity, $fieldName)
    {
        if ($entity instanceof \EntityDrupalWrapper) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            return $entity->{$fieldName}->value();
        }

        throw new \InvalidArgumentException(sprintf(
            'First argument for "%s" method must be of "%s" type.',
            __METHOD__,
            \EntityDrupalWrapper::class
        ));
    }

    /**
     * {@inheritdoc}
     */
    public static function switchMailSystem($useTesting)
    {
        static $original = [
            'default-system' => 'DefaultMailSystem',
        ];

        if ($useTesting) {
            // Store original mail system to restore it after scenario.
            $original = variable_get('mail_system', $original);
            // Set the mail system for testing. It will store an emails in
            // "drupal_test_email_collector" Drupal variable instead of sending.
            $value = array_merge($original, [
                'default-system' => 'TestingMailSystem',
            ]);
        } else {
            // Bring back the original mail system.
            $value = $original;
            // Flush the email buffer to be able to reuse it from scratch.
            // @see \TestingMailSystem
            variable_set('drupal_test_email_collector', []);
        }

        variable_set('mail_system', $value);
    }

    /**
     * {@inheritdoc}
     */
    public static function getEmailMessages()
    {
        // We can't use variable_get() because Behat has another bootstrapped
        // variable $conf that is not updated from cURL bootstrapped Drupal instance.
        $result = (new FetchField('variable', 'value'))
            ->condition('name', 'drupal_test_email_collector')
            ->execute();

        return empty($result) ? [] : unserialize($result);
    }

    /**
     * {@inheritdoc}
     */
    public static function getContentTypeName($contentType)
    {
        if (isset(node_type_get_types()[$contentType])) {
            return $contentType;
        }

        return (string) (new FetchField('node_type', 'type'))
            ->condition('name', $contentType)
            ->execute();
    }

    /**
     * {@inheritdoc}
     */
    public static function injectCustomJavascript($file, $delete = false)
    {
        $file .= '.js';
        $modulePath = static::drupalGetFilename('module', 'system');
        $destination = dirname($modulePath) . '/' . $file;
        $injection = "\ndrupal_add_js('$destination', array('every_page' => TRUE));";

        if ($delete) {
            static::fileUnmanagedDelete($destination);

            $search = $injection;
            $replace = '';
        } else {
            static::fileUnmanagedCopy(
                str_replace('Context', 'JavaScript', __DIR__) . '/' . $file,
                $destination,
                FILE_EXISTS_REPLACE
            );

            $search = 'system_add_module_assets();';
            $replace = $search . $injection;
        }

        file_put_contents($modulePath, str_replace($search, $replace, file_get_contents($modulePath)));
    }
}


Pull Request — master (#16)

Drupal7Placeholder::injectCustomJavascript() B

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

1			<?php
2			/**
3			* @author Sergii Bondarenko, <[email protected]>
4			*/
5			namespace Drupal\TqExtension\Cores;
6
7			use Behat\Behat\Hook\Scope\BeforeFeatureScope;
8			use Drupal\TqExtension\Utils\Database\FetchField;
9
10			final class Drupal7Placeholder extends DrupalKernelPlaceholder
11			{
12			/**
13			* {@inheritdoc}
14			*/
15			public static function beforeFeature(BeforeFeatureScope $scope)
16			{
17			// Set to "false", because the administration menu will not be rendered.
18			// @see https://www.drupal.org/node/2023625#comment-8607207
19			variable_set('admin_menu_cache_client', false);
20			}
21
22			/**
23			* {@inheritdoc}
24			*/
25			public static function t($string, array $arguments = [], array $options = [])
26			{
27			return t($string, $arguments, $options);
28			}
29
30			/**
31			* {@inheritdoc}
32			*/
33			public static function formatString($string, array $arguments = [])
34			{
35			return format_string($string, $arguments);
36			}
37
38			/**
39			* {@inheritdoc}
40			*/
41			public static function arg()
42			{
43			return arg();
44			}
45
46			/**
47			* {@inheritdoc}
48			*/
49			public static function tokenReplace($text, array $data = [], array $options = [])
50			{
51			return token_replace($text, $data, $options);
52			}
53
54			/**
55			* {@inheritdoc}
56			*/
57			public static function sitePath()
58			{
59			return conf_path();
60			}
61
62			/**
63			* {@inheritdoc}
64			*/
65			public static function jsonEncode($data)
66			{
67			return drupal_json_encode($data);
68			}
69
70			/**
71			* {@inheritdoc}
72			*
73			* @return \stdClass
74			*/
75			public static function getCurrentUser()
			1 ignored issue – show Coding Style introduced 2017-01-02 02:38 UTC by Report Bug Copy Issue Report `getCurrentUser` uses the super-global variable `$GLOBALS` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
76			{
77			return $GLOBALS['user'];
78			}
79
80			/**
81			* {@inheritdoc}
82			*
83			* @param \stdClass $user
84			*/
85			public static function setCurrentUser($user)
			1 ignored issue – show Coding Style introduced 2016-12-30 21:04 UTC by Report Bug Copy Issue Report `setCurrentUser` uses the super-global variable `$GLOBALS` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
86			{
87			$GLOBALS['user'] = $user;
88			}
89
90			/**
91			* {@inheritdoc}
92			*/
93			public static function setCurrentPath($path)
			1 ignored issue – show Coding Style introduced 2016-12-31 18:37 UTC by Report Bug Copy Issue Report `setCurrentPath` uses the super-global variable `$_GET` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
94			{
95			$_GET['q'] = $path;
96			}
97
98			/**
99			* {@inheritdoc}
100			*/
101			public static function getUidByName($username)
102			{
103			return (int) (new FetchField('users', 'uid'))
104			->condition('name', $username)
105			->execute();
106			}
107
108			/**
109			* {@inheritdoc}
110			*/
111			public static function deleteUser($user_id)
112			{
113			user_delete($user_id);
114			}
115
116			/**
117			* {@inheritdoc}
118			*
119			* @return \SelectQuery
120			*/
121			public static function selectQuery($table, $alias = null, array $options = [])
122			{
123			return db_select($table, $alias, $options);
124			}
125
126			/**
127			* {@inheritdoc}
128			*/
129			public static function getFieldDefinitions($entityType, $bundle)
130			{
131			// Load entity properties because in Drupal 8 they are assumed as regular fields.
132			$entityProperties = entity_get_property_info($entityType);
133			$fieldInstances = field_info_instances($entityType, $bundle);
134			$definitions = [];
135
136			if (!empty($entityProperties['properties'])) {
137			$fieldInstances += $entityProperties['properties'];
138			}
139
140			foreach ($fieldInstances as $name => $definition) {
141			$definitions[$name] = [
142			'label' => $definition['label'],
143			'required' => !empty($definition['required']),
144			];
145			}
146
147			return $definitions;
148			}
149
150			/**
151			* {@inheritdoc}
152			*/
153			public static function getDatabaseConnectionInfo($connection)
154			{
155			return \Database::getConnectionInfo($connection);
156			}
157
158			/**
159			* {@inheritdoc}
160			*/
161			public static function entityCreate($entityType, array $values)
162			{
163			$entity = entity_create($entityType, $values);
164
165			entity_save($entityType, $entity);
166			list($entityId, , $bundle) = entity_extract_ids($entityType, $entity);
167
168			return [$entityId, $entityType, $bundle];
169			}
170
171			/**
172			* {@inheritdoc}
173			*/
174			public static function entityLoad($entityType, $id)
175			{
176			$entities = entity_load($entityType, [$id]);
177
178			return empty($entities) ? null : reset($entities);
179			}
180
181			/**
182			* {@inheritdoc}
183			*/
184			public static function entityHasField($entity, $fieldName)
185			{
186			return isset($entity->{$fieldName});
187			}
188
189			/**
190			* {@inheritdoc}
191			*
192			* @param \EntityDrupalWrapper $entity
193			*/
194			public static function entityFieldValue($entity, $fieldName)
195			{
196			if ($entity instanceof \EntityDrupalWrapper) {
			1 ignored issue – show Bug introduced 2017-01-02 06:00 UTC by Report Bug Copy Issue Report The class `EntityDrupalWrapper` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
197			return $entity->{$fieldName}->value();
198			}
199
200			throw new \InvalidArgumentException(sprintf(
201			'First argument for "%s" method must be of "%s" type.',
202			__METHOD__,
203			\EntityDrupalWrapper::class
204			));
205			}
206
207			/**
208			* {@inheritdoc}
209			*/
210			public static function switchMailSystem($useTesting)
211			{
212			static $original = [
213			'default-system' => 'DefaultMailSystem',
214			];
215
216			if ($useTesting) {
217			// Store original mail system to restore it after scenario.
218			$original = variable_get('mail_system', $original);
219			// Set the mail system for testing. It will store an emails in
220			// "drupal_test_email_collector" Drupal variable instead of sending.
221			$value = array_merge($original, [
222			'default-system' => 'TestingMailSystem',
223			]);
224			} else {
225			// Bring back the original mail system.
226			$value = $original;
227			// Flush the email buffer to be able to reuse it from scratch.
228			// @see \TestingMailSystem
229			variable_set('drupal_test_email_collector', []);
230			}
231
232			variable_set('mail_system', $value);
233			}
234
235			/**
236			* {@inheritdoc}
237			*/
238			public static function getEmailMessages()
239			{
240			// We can't use variable_get() because Behat has another bootstrapped
241			// variable $conf that is not updated from cURL bootstrapped Drupal instance.
242			$result = (new FetchField('variable', 'value'))
243			->condition('name', 'drupal_test_email_collector')
244			->execute();
245
246			return empty($result) ? [] : unserialize($result);
247			}
248
249			/**
250			* {@inheritdoc}
251			*/
252			public static function getContentTypeName($contentType)
253			{
254			if (isset(node_type_get_types()[$contentType])) {
255			return $contentType;
256			}
257
258			return (string) (new FetchField('node_type', 'type'))
259			->condition('name', $contentType)
260			->execute();
261			}
262
263			/**
264			* {@inheritdoc}
265			*/
266			public static function injectCustomJavascript($file, $delete = false)
267			{
268			$file .= '.js';
269			$modulePath = static::drupalGetFilename('module', 'system');
270			$destination = dirname($modulePath) . '/' . $file;
271			$injection = "\ndrupal_add_js('$destination', array('every_page' => TRUE));";
272
273			if ($delete) {
274			static::fileUnmanagedDelete($destination);
275
276			$search = $injection;
277			$replace = '';
278			} else {
279			static::fileUnmanagedCopy(
280			str_replace('Context', 'JavaScript', __DIR__) . '/' . $file,
281			$destination,
282			FILE_EXISTS_REPLACE
283			);
284
285			$search = 'system_add_module_assets();';
286			$replace = $search . $injection;
287			}
288
289			file_put_contents($modulePath, str_replace($search, $replace, file_get_contents($modulePath)));
290			}
291			}
292

BR0kEN- / TqExtension

Pull Request — master (#16)

Drupal7Placeholder::injectCustomJavascript() B

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like