FS_Security::get_context_params() - Code Metrics - fooplugins/foogallery - Measure and Improve Code Quality continuously with Scrutinizer

FS_Security::get_context_params() A
last analyzed 2019-02-27 17:41 UTC

↳ Parent: FS_Security

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
nc	2
nop	3
dl	0
loc	12
rs	9.8666
c	0
b	0
f	0

<?php

	/**
	 * @package     Freemius
	 * @copyright   Copyright (c) 2015, Freemius, Inc.
	 * @license     https://www.gnu.org/licenses/gpl-3.0.html GNU General Public License Version 3
	 * @since       1.0.3
	 */

	if ( ! defined( 'ABSPATH' ) ) {
		exit;
	}

	define( 'WP_FS__SECURITY_PARAMS_PREFIX', 's_' );

	/**
	 * Class FS_Security
	 */
	class FS_Security {
namespace YourVendor;

class YourClass { }
		/**
		 * @var FS_Security
		 * @since 1.0.3
		 */
		private static $_instance;
		/**
		 * @var FS_Logger
		 * @since 1.0.3
		 */
		private static $_logger;

		/**
		 * @return \FS_Security
		 */
		public static function instance() {
			if ( ! isset( self::$_instance ) ) {
				self::$_instance = new FS_Security();
				self::$_logger   = FS_Logger::get_logger(
					WP_FS__SLUG,
					WP_FS__DEBUG_SDK,
					WP_FS__ECHO_DEBUG_SDK
				);
			}

			return self::$_instance;
		}

		private function __construct() {
		}

		/**
		 * @param \FS_Scope_Entity $entity
		 * @param int              $timestamp
		 * @param string           $action
		 *
		 * @return string
		 */
		function get_secure_token( FS_Scope_Entity $entity, $timestamp, $action = '' ) {

			return md5(
				$timestamp .
				$entity->id .
				$entity->secret_key .
				$entity->public_key .
				$action
			);
		}

		/**
		 * @param \FS_Scope_Entity $entity
		 * @param int|bool         $timestamp
		 * @param string           $action
		 *
		 * @return array
		 */
		function get_context_params( FS_Scope_Entity $entity, $timestamp = false, $action = '' ) {

			if ( false === $timestamp ) {
				$timestamp = time();
			}

			return array(
				's_ctx_type'   => $entity->get_type(),
				's_ctx_id'     => $entity->id,
				's_ctx_ts'     => $timestamp,
				's_ctx_secure' => $this->get_secure_token( $entity, $timestamp, $action ),

			);
		}
	}


1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2017-06-04 19:22 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 13 and the first side effect is on line 10. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2			/**
3			* @package Freemius
4			* @copyright Copyright (c) 2015, Freemius, Inc.
5			* @license https://www.gnu.org/licenses/gpl-3.0.html GNU General Public License Version 3
6			* @since 1.0.3
7			*/
8
9			if ( ! defined( 'ABSPATH' ) ) {
10			exit;
11			}
12
13			define( 'WP_FS__SECURITY_PARAMS_PREFIX', 's_' );
14
15			/**
16			* Class FS_Security
17			*/
18			class FS_Security {
			0 ignored issues – show Coding Style introduced 2017-06-04 19:22 UTC by Report Bug Copy Issue Report Since you have declared the constructor as private, maybe you should also declare the class as final. Loading history... Coding Style Compatibility introduced 2017-06-04 19:22 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
19			/**
20			* @var FS_Security
21			* @since 1.0.3
22			*/
23			private static $_instance;
24			/**
25			* @var FS_Logger
26			* @since 1.0.3
27			*/
28			private static $_logger;
29
30			/**
31			* @return \FS_Security
32			*/
33			public static function instance() {
34			if ( ! isset( self::$_instance ) ) {
35			self::$_instance = new FS_Security();
36			self::$_logger = FS_Logger::get_logger(
37			WP_FS__SLUG,
38			WP_FS__DEBUG_SDK,
39			WP_FS__ECHO_DEBUG_SDK
40			);
41			}
42
43			return self::$_instance;
44			}
45
46			private function __construct() {
47			}
48
49			/**
50			* @param \FS_Scope_Entity $entity
51			* @param int $timestamp
52			* @param string $action
53			*
54			* @return string
55			*/
56			function get_secure_token( FS_Scope_Entity $entity, $timestamp, $action = '' ) {
			0 ignored issues – show Best Practice introduced 2017-06-04 19:22 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
57			return md5(
58			$timestamp .
59			$entity->id .
60			$entity->secret_key .
61			$entity->public_key .
62			$action
63			);
64			}
65
66			/**
67			* @param \FS_Scope_Entity $entity
68			* @param int\|bool $timestamp
69			* @param string $action
70			*
71			* @return array
72			*/
73			function get_context_params( FS_Scope_Entity $entity, $timestamp = false, $action = '' ) {
			0 ignored issues – show Best Practice introduced 2017-06-04 19:22 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
74			if ( false === $timestamp ) {
75			$timestamp = time();
76			}
77
78			return array(
79			's_ctx_type' => $entity->get_type(),
80			's_ctx_id' => $entity->id,
81			's_ctx_ts' => $timestamp,
82			's_ctx_secure' => $this->get_secure_token( $entity, $timestamp, $action ),
			0 ignored issues – show Bug introduced 2017-06-04 19:22 UTC by Report Bug Copy Issue Report It seems like `$timestamp` defined by parameter `$timestamp` on line 73 can also be of type `boolean`; however, `FS_Security::get_secure_token()` does only seem to accept `integer`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
83			);
84			}
85			}
86

fooplugins / foogallery

GitHub Access Token became invalid

FS_Security::get_context_params() A last analyzed 2019-02-27 17:41 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

FS_Security::get_context_params() A
last analyzed 2019-02-27 17:41 UTC