Jetpack_Simple_Payments - Code Metrics - Inspection of "Merge pull request #7409, introduce simple payment..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/simple-payments ( acd858...d88e95 )

unknown

created 2017-07-21 11:58 UTC

Jetpack_Simple_Payments A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	220
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	1

Importance

Changes

Metric	Value
dl	0
loc	220
rs	10
c	0
b	0
f	0
wmc	20
lcom	2
cbo	1

12 Methods

Rating	Name	Size	Complexity
A	__construct()	1	1
A	getInstance()	7	2
A	register_scripts()	8	1
A	register_init_hook()	3	1
A	register_shortcode()	3	1
A	init_hook_action()	7	1
A	output_shortcode()	18	2
A	format_price()	4	1
A	allow_rest_api_types()	5	1
A	allow_sync_post_meta()	14	1
B	setup_cpts()	86	1
C	parse_shortcode()	36	7

<?php
/*
 * Simple Payments lets users embed a PayPal button fully integrated with wpcom to sell products on the site.
 * This is not a proper module yet, because not all the pieces are in place. Until everything is shipped, it can be turned
 * into module that can be enabled/disabled.
 * TODO: Once the feature is fully shipped, create a file modules/simple-payments.php with a proper header to turn module on/off.

*/
class Jetpack_Simple_Payments {
	// These have to be under 20 chars because that is CPT limit.
	static $post_type_order = 'jp_pay_order';
class A {
    var $property;
}
	static $post_type_product = 'jp_pay_product';
class A {
    var $property;
}

	static $shortcode = 'simple-payment';
class A {
    var $property;
}

	// Classic singleton pattern:
	private static $instance;
	private function __construct() {}
	static function getInstance() {
		if ( ! self::$instance ) {
			self::$instance = new self();
			self::$instance->register_init_hook();
		}
		return self::$instance;
	}

	private function register_scripts() {
		/**
		 * Paypal heavily discourages putting that script in your own server:
		 * @see https://developer.paypal.com/docs/integration/direct/express-checkout/integration-jsv4/add-paypal-button/
		 */
		wp_register_script( 'paypal-checkout-js', 'https://www.paypalobjects.com/api/checkout.js' );
		wp_register_script( 'paypal-express-checkout', plugins_url( '/paypal-express-checkout.js', __FILE__ ) , array( 'paypal-checkout-js' ), '0.21' );
	}
	private function register_init_hook() {
		add_action( 'init', array( $this, 'init_hook_action' ) );
	}
	private function register_shortcode() {
		add_shortcode( self::$shortcode, array( $this, 'parse_shortcode' ) );
	}

	public function init_hook_action() {
		add_filter( 'rest_api_allowed_post_types', array( $this, 'allow_rest_api_types' ) );
		add_filter( 'jetpack_sync_post_meta_whitelist', array( $this, 'allow_sync_post_meta' ) );
		$this->register_scripts();
		$this->register_shortcode();
		$this->setup_cpts();
	}

	function parse_shortcode( $attrs, $content = false ) {
		if ( empty( $attrs['id'] ) ) {
			return;
		}
		$product = get_post( $attrs['id'] );
		if ( ! $product || is_wp_error( $product ) ) {
			return;
		}
		if ( $product->post_type !== self::$post_type_product ) {
			return;
		}

		// We allow for overriding the presentation labels
		$data = shortcode_atts( array(
			'blog_id' => Jetpack_Options::get_option( 'id' ),
			'dom_id' => uniqid( 'jetpack-simple-payments-' . $product->ID . '_', true ),
			'class' => 'jetpack-simple-payments-' . $product->ID,
			'title' => get_the_title( $product ),
			'description' => $product->post_content,
			'cta' => get_post_meta( $product->ID, 'spay_cta', true ),
			'multiple' => get_post_meta( $product->ID, 'spay_multiple', true ) || '0'
		), $attrs );
		$data['price'] = $this->format_price(
			get_post_meta( $product->ID, 'spay_price', true ),
			get_post_meta( $product->ID, 'spay_currency', true ),
			$data
		);

		if ( ! wp_script_is( 'paypal-express-checkout','enqueued' ) ) {
			wp_enqueue_script( 'paypal-express-checkout' );
		}

		wp_add_inline_script( 'paypal-express-checkout', "try{PaypalExpressCheckout.renderButton( '{$data['blog_id']}', '{$attrs['id']}', '{$data['dom_id']}', '{$data['multiple']}' );}catch(e){}" );

		return $this->output_shortcode( $data );
	}

	function output_shortcode( $data ) {
		$items = '';
		if ( $data['multiple'] ) {
		       $items="<div class='jetpack-simple-payments-items'>
$a = "a";
$ab = "ab";
$abc = "abc";
		       <input class='jetpack-simple-payments-items-number' type='number' value='1' id='{$data['dom_id']}_number'>
		       </div>";
		}
		$output = "
<div class='{$data[ 'class' ]} jetpack-simple-payments-wrapper'>
	<div class='jetpack-simple-payments-title'>{$data['title']}</div>
	<div class='jetpack-simple-payments-description'>{$data['description']}</div>
	<div class='jetpack-simple-payments-price'>{$data['price']}</div>
	{$items}
	<div class='jetpack-simple-payments-button' id='{$data['dom_id']}_button'></div>
</div>
";
		return $output;
	}

	function format_price( $price, $currency, $all_data ) {
		// TODO: better price formatting logic. Extracting from woocmmerce is not a solution since its bound with woo site options.

		return "$price $currency";
	}

	/**
	 * Allows custom post types to be used by REST API.
	 * @param $post_types
	 * @see hook 'rest_api_allowed_post_types'
	 * @return array
	 */
	function allow_rest_api_types( $post_types ) {
		$post_types[] = self::$post_type_order;
		$post_types[] = self::$post_type_product;
		return $post_types;
	}

	function allow_sync_post_meta( $post_meta ) {
		return array_merge( $post_meta, array(
			'spay_paypal_id',
			'spay_status',
			'spay_product_id',
			'spay_quantity',
			'spay_price',
			'spay_customer_email',
			'spay_currency',
			'spay_cta',
			'spay_email',
			'spay_multiple'
		) );
	}

	/**
	 * Sets up the custom post types for the module.
	 */
	function setup_cpts() {

		/*
		 * ORDER data structure. holds:
		 * title = customer_name | 4xproduct_name
		 * excerpt = customer_name + customer contact info + customer notes from paypal form
		 * metadata:
		 * spay_paypal_id - paypal id of transaction
		 * spay_status
		 * spay_product_id - post_id of bought product
		 * spay_quantity - quantity of product
		 * spay_price - item price at the time of purchase
		 * spay_customer_email - customer email
		 * ... (WIP)
		 */
		$order_capabilities = array(
			'edit_post'             => 'edit_posts',
			'read_post'             => 'read_private_posts',
			'delete_post'           => 'delete_posts',
			'edit_posts'            => 'edit_posts',
			'edit_others_posts'     => 'edit_others_posts',
			'publish_posts'         => 'publish_posts',
			'read_private_posts'    => 'read_private_posts',
		);
		$order_args = array(
			'label'                 => esc_html__( 'Order', 'jetpack' ),
			'description'           => esc_html__( 'Simple Payments orders', 'jetpack' ),
			'supports'              => array( 'custom-fields', 'excerpt' ),
			'hierarchical'          => false,
			'public'                => false,
			'show_ui'               => false,
			'show_in_menu'          => false,
			'show_in_admin_bar'     => false,
			'show_in_nav_menus'     => false,
			'can_export'            => true,
			'has_archive'           => false,
			'exclude_from_search'   => true,
			'publicly_queryable'    => false,
			'rewrite'               => false,
			'capabilities'          => $order_capabilities,
			'show_in_rest'          => true,
		);
		register_post_type( self::$post_type_order, $order_args );

		/*
		 * PRODUCT data structure. Holds:
		 * title - title
		 * content - description
		 * thumbnail - image
		 * metadata:
		 * spay_price - price
		 * spay_currency - currency code
		 * spay_cta - text with "Buy" or other CTA
		 * spay_email - paypal email
		 * spay_multiple - allow for multiple items
		 * spay_status - status. { enabled | disabled }
		 */
		$product_capabilities = array(
			'edit_post'             => 'edit_posts',
			'read_post'             => 'read_private_posts',
			'delete_post'           => 'delete_posts',
			'edit_posts'            => 'edit_posts',
			'edit_others_posts'     => 'edit_others_posts',
			'publish_posts'         => 'publish_posts',
			'read_private_posts'    => 'read_private_posts',
		);
		$product_args = array(
			'label'                 => esc_html__( 'Product', 'jetpack' ),
			'description'           => esc_html__( 'Simple Payments products', 'jetpack' ),
			'supports'              => array( 'title', 'editor','thumbnail', 'custom-fields' ),
			'hierarchical'          => false,
			'public'                => false,
			'show_ui'               => false,
			'show_in_menu'          => false,
			'show_in_admin_bar'     => false,
			'show_in_nav_menus'     => false,
			'can_export'            => true,
			'has_archive'           => false,
			'exclude_from_search'   => true,
			'publicly_queryable'    => false,
			'rewrite'               => false,
			'capabilities'          => $product_capabilities,
			'show_in_rest'          => true,
		);
		register_post_type( self::$post_type_product, $product_args );
	}

}
Jetpack_Simple_Payments::getInstance();


1			<?php
2			/*
3			* Simple Payments lets users embed a PayPal button fully integrated with wpcom to sell products on the site.
4			* This is not a proper module yet, because not all the pieces are in place. Until everything is shipped, it can be turned
5			* into module that can be enabled/disabled.
6			* TODO: Once the feature is fully shipped, create a file modules/simple-payments.php with a proper header to turn module on/off.
			0 ignored issues – show Coding Style Best Practice introduced 2017-07-10 15:20 UTC by Report Bug Copy Issue Report Comments for TODO tasks are often forgotten in the code; it might be better to use a dedicated issue tracker. Loading history...
7			*/
8			class Jetpack_Simple_Payments {
9			// These have to be under 20 chars because that is CPT limit.
10			static $post_type_order = 'jp_pay_order';
			0 ignored issues – show Coding Style introduced 2017-06-30 07:21 UTC by Report Bug Copy Issue Report The visibility should be declared for property `$post_type_order`. The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using class A { var $property; } the property is implicitly global. To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2. Loading history...
11			static $post_type_product = 'jp_pay_product';
			0 ignored issues – show Coding Style introduced 2017-06-30 07:21 UTC by Report Bug Copy Issue Report The visibility should be declared for property `$post_type_product`. The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using class A { var $property; } the property is implicitly global. To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2. Loading history...
12
13			static $shortcode = 'simple-payment';
			0 ignored issues – show Coding Style introduced 2017-07-03 10:21 UTC by Report Bug Copy Issue Report The visibility should be declared for property `$shortcode`. The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using class A { var $property; } the property is implicitly global. To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2. Loading history...
14
15			// Classic singleton pattern:
16			private static $instance;
17			private function __construct() {}
18			static function getInstance() {
19			if ( ! self::$instance ) {
20			self::$instance = new self();
21			self::$instance->register_init_hook();
22			}
23			return self::$instance;
24			}
25
26			private function register_scripts() {
27			/**
28			* Paypal heavily discourages putting that script in your own server:
29			* @see https://developer.paypal.com/docs/integration/direct/express-checkout/integration-jsv4/add-paypal-button/
30			*/
31			wp_register_script( 'paypal-checkout-js', 'https://www.paypalobjects.com/api/checkout.js' );
32			wp_register_script( 'paypal-express-checkout', plugins_url( '/paypal-express-checkout.js', __FILE__ ) , array( 'paypal-checkout-js' ), '0.21' );
33			}
34			private function register_init_hook() {
35			add_action( 'init', array( $this, 'init_hook_action' ) );
36			}
37			private function register_shortcode() {
38			add_shortcode( self::$shortcode, array( $this, 'parse_shortcode' ) );
39			}
40
41			public function init_hook_action() {
42			add_filter( 'rest_api_allowed_post_types', array( $this, 'allow_rest_api_types' ) );
43			add_filter( 'jetpack_sync_post_meta_whitelist', array( $this, 'allow_sync_post_meta' ) );
44			$this->register_scripts();
45			$this->register_shortcode();
46			$this->setup_cpts();
47			}
48
49			function parse_shortcode( $attrs, $content = false ) {
50			if ( empty( $attrs['id'] ) ) {
51			return;
52			}
53			$product = get_post( $attrs['id'] );
54			if ( ! $product \|\| is_wp_error( $product ) ) {
55			return;
56			}
57			if ( $product->post_type !== self::$post_type_product ) {
58			return;
59			}
60
61			// We allow for overriding the presentation labels
62			$data = shortcode_atts( array(
63			'blog_id' => Jetpack_Options::get_option( 'id' ),
64			'dom_id' => uniqid( 'jetpack-simple-payments-' . $product->ID . '_', true ),
65			'class' => 'jetpack-simple-payments-' . $product->ID,
66			'title' => get_the_title( $product ),
67			'description' => $product->post_content,
68			'cta' => get_post_meta( $product->ID, 'spay_cta', true ),
69			'multiple' => get_post_meta( $product->ID, 'spay_multiple', true ) \|\| '0'
70			), $attrs );
71			$data['price'] = $this->format_price(
72			get_post_meta( $product->ID, 'spay_price', true ),
73			get_post_meta( $product->ID, 'spay_currency', true ),
74			$data
75			);
76
77			if ( ! wp_script_is( 'paypal-express-checkout','enqueued' ) ) {
78			wp_enqueue_script( 'paypal-express-checkout' );
79			}
80
81			wp_add_inline_script( 'paypal-express-checkout', "try{PaypalExpressCheckout.renderButton( '{$data['blog_id']}', '{$attrs['id']}', '{$data['dom_id']}', '{$data['multiple']}' );}catch(e){}" );
82
83			return $this->output_shortcode( $data );
84			}
85
86			function output_shortcode( $data ) {
87			$items = '';
88			if ( $data['multiple'] ) {
89			$items="<div class='jetpack-simple-payments-items'>
			0 ignored issues – show Coding Style introduced 2017-07-10 15:35 UTC by Report Bug Copy Issue Report Equals sign not aligned correctly; expected 1 space but found 0 spaces This check looks for improperly formatted assignments. Every assignment must have exactly one space before and one space after the equals operator. To illustrate: $a = "a"; $ab = "ab"; $abc = "abc"; will have no issues, while $a = "a"; $ab = "ab"; $abc = "abc"; will report issues in lines 1 and 2. Loading history...
90			<input class='jetpack-simple-payments-items-number' type='number' value='1' id='{$data['dom_id']}_number'>
91			</div>";
92			}
93			$output = "
94			<div class='{$data[ 'class' ]} jetpack-simple-payments-wrapper'>
95			<div class='jetpack-simple-payments-title'>{$data['title']}</div>
96			<div class='jetpack-simple-payments-description'>{$data['description']}</div>
97			<div class='jetpack-simple-payments-price'>{$data['price']}</div>
98			{$items}
99			<div class='jetpack-simple-payments-button' id='{$data['dom_id']}_button'></div>
100			</div>
101			";
102			return $output;
103			}
104
105			function format_price( $price, $currency, $all_data ) {
106			// TODO: better price formatting logic. Extracting from woocmmerce is not a solution since its bound with woo site options.
			0 ignored issues – show Coding Style Best Practice introduced 2017-07-10 15:20 UTC by Report Bug Copy Issue Report Comments for TODO tasks are often forgotten in the code; it might be better to use a dedicated issue tracker. Loading history...
107			return "$price $currency";
108			}
109
110			/**
111			* Allows custom post types to be used by REST API.
112			* @param $post_types
113			* @see hook 'rest_api_allowed_post_types'
114			* @return array
115			*/
116			function allow_rest_api_types( $post_types ) {
117			$post_types[] = self::$post_type_order;
118			$post_types[] = self::$post_type_product;
119			return $post_types;
120			}
121
122			function allow_sync_post_meta( $post_meta ) {
123			return array_merge( $post_meta, array(
124			'spay_paypal_id',
125			'spay_status',
126			'spay_product_id',
127			'spay_quantity',
128			'spay_price',
129			'spay_customer_email',
130			'spay_currency',
131			'spay_cta',
132			'spay_email',
133			'spay_multiple'
134			) );
135			}
136
137			/**
138			* Sets up the custom post types for the module.
139			*/
140			function setup_cpts() {
141
142			/*
143			* ORDER data structure. holds:
144			* title = customer_name \| 4xproduct_name
145			* excerpt = customer_name + customer contact info + customer notes from paypal form
146			* metadata:
147			* spay_paypal_id - paypal id of transaction
148			* spay_status
149			* spay_product_id - post_id of bought product
150			* spay_quantity - quantity of product
151			* spay_price - item price at the time of purchase
152			* spay_customer_email - customer email
153			* ... (WIP)
154			*/
155			$order_capabilities = array(
156			'edit_post' => 'edit_posts',
157			'read_post' => 'read_private_posts',
158			'delete_post' => 'delete_posts',
159			'edit_posts' => 'edit_posts',
160			'edit_others_posts' => 'edit_others_posts',
161			'publish_posts' => 'publish_posts',
162			'read_private_posts' => 'read_private_posts',
163			);
164			$order_args = array(
165			'label' => esc_html__( 'Order', 'jetpack' ),
166			'description' => esc_html__( 'Simple Payments orders', 'jetpack' ),
167			'supports' => array( 'custom-fields', 'excerpt' ),
168			'hierarchical' => false,
169			'public' => false,
170			'show_ui' => false,
171			'show_in_menu' => false,
172			'show_in_admin_bar' => false,
173			'show_in_nav_menus' => false,
174			'can_export' => true,
175			'has_archive' => false,
176			'exclude_from_search' => true,
177			'publicly_queryable' => false,
178			'rewrite' => false,
179			'capabilities' => $order_capabilities,
180			'show_in_rest' => true,
181			);
182			register_post_type( self::$post_type_order, $order_args );
183
184			/*
185			* PRODUCT data structure. Holds:
186			* title - title
187			* content - description
188			* thumbnail - image
189			* metadata:
190			* spay_price - price
191			* spay_currency - currency code
192			* spay_cta - text with "Buy" or other CTA
193			* spay_email - paypal email
194			* spay_multiple - allow for multiple items
195			* spay_status - status. { enabled \| disabled }
196			*/
197			$product_capabilities = array(
198			'edit_post' => 'edit_posts',
199			'read_post' => 'read_private_posts',
200			'delete_post' => 'delete_posts',
201			'edit_posts' => 'edit_posts',
202			'edit_others_posts' => 'edit_others_posts',
203			'publish_posts' => 'publish_posts',
204			'read_private_posts' => 'read_private_posts',
205			);
206			$product_args = array(
207			'label' => esc_html__( 'Product', 'jetpack' ),
208			'description' => esc_html__( 'Simple Payments products', 'jetpack' ),
209			'supports' => array( 'title', 'editor','thumbnail', 'custom-fields' ),
210			'hierarchical' => false,
211			'public' => false,
212			'show_ui' => false,
213			'show_in_menu' => false,
214			'show_in_admin_bar' => false,
215			'show_in_nav_menus' => false,
216			'can_export' => true,
217			'has_archive' => false,
218			'exclude_from_search' => true,
219			'publicly_queryable' => false,
220			'rewrite' => false,
221			'capabilities' => $product_capabilities,
222			'show_in_rest' => true,
223			);
224			register_post_type( self::$post_type_product, $product_args );
225			}
226
227			}
228			Jetpack_Simple_Payments::getInstance();
229

Automattic / jetpack

Push — feature/simple-payments ( acd858...d88e95 )

Jetpack_Simple_Payments A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

12 Methods

Duplication Side-by-Side

Filter issues like