insideout10 / wordlift-plugin

src/wordlift.php

Indentation +120 added lines, -120 removed lines

@@ -26,7 +26,7 @@ 
 
 // If this file is called directly, abort.
 if ( ! defined( 'WPINC' ) ) {
-	die;
+    die;
 }
 
 // Include WordLift constants.
@@ -46,7 +46,7 @@ 
  */
 function wl_write_log( $log ) {
 
-	Wordlift_Log_Service::get_instance()->debug( $log );
+    Wordlift_Log_Service::get_instance()->debug( $log );
 
 }
 
@@ -63,7 +63,7 @@ 
  */
 function wl_write_log_hide_key( $text ) {
 
-	return str_ireplace( wl_configuration_get_key(), '<hidden>', $text );
+    return str_ireplace( wl_configuration_get_key(), '<hidden>', $text );
 }
 
 /**
@@ -71,21 +71,21 @@ 
  * see http://vip.wordpress.com/documentation/register-additional-html-attributes-for-tinymce-and-wp-kses/
  */
 function wordlift_allowed_post_tags() {
-	global $allowedposttags;
-
-	$tags           = array( 'span' );
-	$new_attributes = array(
-		'itemscope' => array(),
-		'itemtype'  => array(),
-		'itemprop'  => array(),
-		'itemid'    => array(),
-	);
-
-	foreach ( $tags as $tag ) {
-		if ( isset( $allowedposttags[ $tag ] ) && is_array( $allowedposttags[ $tag ] ) ) {
-			$allowedposttags[ $tag ] = array_merge( $allowedposttags[ $tag ], $new_attributes );
-		}
-	}
+    global $allowedposttags;
+
+    $tags           = array( 'span' );
+    $new_attributes = array(
+        'itemscope' => array(),
+        'itemtype'  => array(),
+        'itemprop'  => array(),
+        'itemid'    => array(),
+    );
+
+    foreach ( $tags as $tag ) {
+        if ( isset( $allowedposttags[ $tag ] ) && is_array( $allowedposttags[ $tag ] ) ) {
+            $allowedposttags[ $tag ] = array_merge( $allowedposttags[ $tag ], $new_attributes );
+        }
+    }
 }
 
 // add allowed post tags.
@@ -96,15 +96,15 @@ 
  */
 function wordlift_admin_enqueue_scripts() {
 
-	// Added for compatibility with WordPress 3.9 (see http://make.wordpress.org/core/2014/04/16/jquery-ui-and-wpdialogs-in-wordpress-3-9/)
-	wp_enqueue_script( 'wpdialogs' );
-	wp_enqueue_style( 'wp-jquery-ui-dialog' );
+    // Added for compatibility with WordPress 3.9 (see http://make.wordpress.org/core/2014/04/16/jquery-ui-and-wpdialogs-in-wordpress-3-9/)
+    wp_enqueue_script( 'wpdialogs' );
+    wp_enqueue_style( 'wp-jquery-ui-dialog' );
 
-	wp_enqueue_style( 'wordlift-reloaded', plugin_dir_url( __FILE__ ) . 'css/wordlift-reloaded.min.css' );
+    wp_enqueue_style( 'wordlift-reloaded', plugin_dir_url( __FILE__ ) . 'css/wordlift-reloaded.min.css' );
 
-	wp_enqueue_script( 'jquery-ui-autocomplete' );
+    wp_enqueue_script( 'jquery-ui-autocomplete' );
 
-	/*
+    /*
 	 * Angular isn't loaded anymore separately, it is embedded in wordlift-reloaded.js.
 	 *
 	 * See https://github.com/insideout10/wordlift-plugin/issues/865.
@@ -125,10 +125,10 @@ 
 //
 //	$log->debug( 'Registering angular scripts was ' . ( $result ? 'successful.' : 'unsuccessful.' ) );
 
-	// Disable auto-save for custom entity posts only
-	if ( Wordlift_Entity_Service::TYPE_NAME === get_post_type() ) {
-		wp_dequeue_script( 'autosave' );
-	}
+    // Disable auto-save for custom entity posts only
+    if ( Wordlift_Entity_Service::TYPE_NAME === get_post_type() ) {
+        wp_dequeue_script( 'autosave' );
+    }
 
 }
 
@@ -153,18 +153,18 @@ 
  */
 function wordlift_allowed_html( $allowedtags, $context ) {
 
-	if ( 'post' !== $context ) {
-		return $allowedtags;
-	}
-
-	return array_merge_recursive( $allowedtags, array(
-		'span' => array(
-			'itemscope' => true,
-			'itemtype'  => true,
-			'itemid'    => true,
-			'itemprop'  => true,
-		),
-	) );
+    if ( 'post' !== $context ) {
+        return $allowedtags;
+    }
+
+    return array_merge_recursive( $allowedtags, array(
+        'span' => array(
+            'itemscope' => true,
+            'itemtype'  => true,
+            'itemid'    => true,
+            'itemprop'  => true,
+        ),
+    ) );
 }
 
 add_filter( 'wp_kses_allowed_html', 'wordlift_allowed_html', 10, 2 );
@@ -178,16 +178,16 @@ 
  */
 function wl_get_coordinates( $post_id ) {
 
-	$latitude  = wl_schema_get_value( $post_id, 'latitude' );
-	$longitude = wl_schema_get_value( $post_id, 'longitude' );
+    $latitude  = wl_schema_get_value( $post_id, 'latitude' );
+    $longitude = wl_schema_get_value( $post_id, 'longitude' );
 
-	// DO NOT set latitude/longitude to 0/0 as default values. It's a specific
-	// place on the globe:"The zero/zero point of this system is located in the
-	// Gulf of Guinea about 625 km (390 mi) south of Tema, Ghana."
-	return array(
-		'latitude'  => isset( $latitude[0] ) && is_numeric( $latitude[0] ) ? $latitude[0] : '',
-		'longitude' => isset( $longitude[0] ) && is_numeric( $longitude[0] ) ? $longitude[0] : '',
-	);
+    // DO NOT set latitude/longitude to 0/0 as default values. It's a specific
+    // place on the globe:"The zero/zero point of this system is located in the
+    // Gulf of Guinea about 625 km (390 mi) south of Tema, Ghana."
+    return array(
+        'latitude'  => isset( $latitude[0] ) && is_numeric( $latitude[0] ) ? $latitude[0] : '',
+        'longitude' => isset( $longitude[0] ) && is_numeric( $longitude[0] ) ? $longitude[0] : '',
+    );
 }
 
 /**
@@ -201,9 +201,9 @@ 
  */
 function wl_get_image_urls( $post_id ) {
 
-	return Wordlift_Storage_Factory::get_instance()
-	                               ->post_images()
-	                               ->get( $post_id );
+    return Wordlift_Storage_Factory::get_instance()
+                                    ->post_images()
+                                    ->get( $post_id );
 
 //	// If there is a featured image it has the priority.
 //	$featured_image_id = get_post_thumbnail_id( $post_id );
@@ -251,24 +251,24 @@ 
  */
 function wl_get_attachment_for_source_url( $parent_post_id, $source_url ) {
 
-	// wl_write_log( "wl_get_attachment_for_source_url [ parent post id :: $parent_post_id ][ source url :: $source_url ]" );
+    // wl_write_log( "wl_get_attachment_for_source_url [ parent post id :: $parent_post_id ][ source url :: $source_url ]" );
 
-	$posts = get_posts( array(
-		'post_type'      => 'attachment',
-		'posts_per_page' => 1,
-		'post_status'    => 'any',
-		'post_parent'    => $parent_post_id,
-		'meta_key'       => 'wl_source_url',
-		'meta_value'     => $source_url,
-	) );
+    $posts = get_posts( array(
+        'post_type'      => 'attachment',
+        'posts_per_page' => 1,
+        'post_status'    => 'any',
+        'post_parent'    => $parent_post_id,
+        'meta_key'       => 'wl_source_url',
+        'meta_value'     => $source_url,
+    ) );
 
-	// Return the found post.
-	if ( 1 === count( $posts ) ) {
-		return $posts[0];
-	}
+    // Return the found post.
+    if ( 1 === count( $posts ) ) {
+        return $posts[0];
+    }
 
-	// Return null.
-	return null;
+    // Return null.
+    return null;
 }
 
 /**
@@ -279,8 +279,8 @@ 
  */
 function wl_set_source_url( $post_id, $source_url ) {
 
-	delete_post_meta( $post_id, 'wl_source_url' );
-	add_post_meta( $post_id, 'wl_source_url', $source_url );
+    delete_post_meta( $post_id, 'wl_source_url' );
+    add_post_meta( $post_id, 'wl_source_url', $source_url );
 }
 
 /**
@@ -296,7 +296,7 @@ 
  */
 function wl_sanitize_uri_path( $path, $char = '_' ) {
 
-	return Wordlift_Uri_Service::get_instance()->sanitize_path( $path, $char );
+    return Wordlift_Uri_Service::get_instance()->sanitize_path( $path, $char );
 }
 
 ///**
@@ -337,47 +337,47 @@ 
  */
 function wl_replace_item_id_with_uri( $content ) {
 
-	$log = Wordlift_Log_Service::get_logger( 'wl_replace_item_id_with_uri' );
-	$log->trace( 'Replacing item IDs with URIs...' );
+    $log = Wordlift_Log_Service::get_logger( 'wl_replace_item_id_with_uri' );
+    $log->trace( 'Replacing item IDs with URIs...' );
 
-	// Strip slashes, see https://core.trac.wordpress.org/ticket/21767
-	$content = stripslashes( $content );
+    // Strip slashes, see https://core.trac.wordpress.org/ticket/21767
+    $content = stripslashes( $content );
 
-	// If any match are found.
-	$matches = array();
-	if ( 0 < preg_match_all( '/ itemid="([^"]+)"/i', $content, $matches, PREG_SET_ORDER ) ) {
+    // If any match are found.
+    $matches = array();
+    if ( 0 < preg_match_all( '/ itemid="([^"]+)"/i', $content, $matches, PREG_SET_ORDER ) ) {
 
-		foreach ( $matches as $match ) {
+        foreach ( $matches as $match ) {
 
-			// Get the item ID.
-			$item_id = $match[1];
+            // Get the item ID.
+            $item_id = $match[1];
 
-			// Get the post bound to that item ID (looking both in the 'official' URI and in the 'same-as' .
-			$post = Wordlift_Entity_Service::get_instance()
-			                               ->get_entity_post_by_uri( $item_id );
+            // Get the post bound to that item ID (looking both in the 'official' URI and in the 'same-as' .
+            $post = Wordlift_Entity_Service::get_instance()
+                                            ->get_entity_post_by_uri( $item_id );
 
-			// If no entity is found, continue to the next one.
-			if ( null === $post ) {
-				continue;
-			}
+            // If no entity is found, continue to the next one.
+            if ( null === $post ) {
+                continue;
+            }
 
-			// Get the URI for that post.
-			$uri = wl_get_entity_uri( $post->ID );
+            // Get the URI for that post.
+            $uri = wl_get_entity_uri( $post->ID );
 
-			// wl_write_log( "wl_replace_item_id_with_uri [ item id :: $item_id ][ uri :: $uri ]" );
+            // wl_write_log( "wl_replace_item_id_with_uri [ item id :: $item_id ][ uri :: $uri ]" );
 
-			// If the item ID and the URI differ, replace the item ID with the URI saved in WordPress.
-			if ( $item_id !== $uri ) {
-				$uri_e   = esc_html( $uri );
-				$content = str_replace( " itemid=\"$item_id\"", " itemid=\"$uri_e\"", $content );
-			}
-		}
-	}
+            // If the item ID and the URI differ, replace the item ID with the URI saved in WordPress.
+            if ( $item_id !== $uri ) {
+                $uri_e   = esc_html( $uri );
+                $content = str_replace( " itemid=\"$item_id\"", " itemid=\"$uri_e\"", $content );
+            }
+        }
+    }
 
-	// Reapply slashes.
-	$content = addslashes( $content );
+    // Reapply slashes.
+    $content = addslashes( $content );
 
-	return $content;
+    return $content;
 }
 
 add_filter( 'content_save_pre', 'wl_replace_item_id_with_uri', 1, 1 );
@@ -438,24 +438,24 @@ 
  */
 function activate_wordlift() {
 
-	$log = Wordlift_Log_Service::get_logger( 'activate_wordlift' );
+    $log = Wordlift_Log_Service::get_logger( 'activate_wordlift' );
 
-	$log->info( 'Activating WordLift...' );
+    $log->info( 'Activating WordLift...' );
 
-	require_once plugin_dir_path( __FILE__ ) . 'includes/class-wordlift-activator.php';
-	Wordlift_Activator::activate();
+    require_once plugin_dir_path( __FILE__ ) . 'includes/class-wordlift-activator.php';
+    Wordlift_Activator::activate();
 
-	/**
-	 * Tell the {@link Wordlift_Http_Api} class that we're activating, to let it run activation tasks.
-	 *
-	 * @see https://github.com/insideout10/wordlift-plugin/issues/820 related issue.
-	 * @since 3.19.2
-	 */
-	Wordlift_Http_Api::activate();
+    /**
+     * Tell the {@link Wordlift_Http_Api} class that we're activating, to let it run activation tasks.
+     *
+     * @see https://github.com/insideout10/wordlift-plugin/issues/820 related issue.
+     * @since 3.19.2
+     */
+    Wordlift_Http_Api::activate();
 
-	// Ensure the post type is registered before flushing the rewrite rules.
-	Wordlift_Entity_Post_Type_Service::get_instance()->register();
-	flush_rewrite_rules();
+    // Ensure the post type is registered before flushing the rewrite rules.
+    Wordlift_Entity_Post_Type_Service::get_instance()->register();
+    flush_rewrite_rules();
 
 }
 
@@ -465,10 +465,10 @@ 
  */
 function deactivate_wordlift() {
 
-	require_once plugin_dir_path( __FILE__ ) . 'includes/class-wordlift-deactivator.php';
-	Wordlift_Deactivator::deactivate();
-	Wordlift_Http_Api::deactivate();
-	flush_rewrite_rules();
+    require_once plugin_dir_path( __FILE__ ) . 'includes/class-wordlift-deactivator.php';
+    Wordlift_Deactivator::deactivate();
+    Wordlift_Http_Api::deactivate();
+    flush_rewrite_rules();
 
 }
 
@@ -492,8 +492,8 @@ 
  */
 function run_wordlift() {
 
-	$plugin = new Wordlift();
-	$plugin->run();
+    $plugin = new Wordlift();
+    $plugin->run();
 
 }
 

Spacing +85 added lines, -85 removed lines

@@ -25,15 +25,15 @@ 
  */
 
 // If this file is called directly, abort.
-if ( ! defined( 'WPINC' ) ) {
+if ( ! defined('WPINC')) {
 	die;
 }
 
 // Include WordLift constants.
-require_once( 'wordlift_constants.php' );
+require_once('wordlift_constants.php');
 
 // Load modules.
-require_once( 'modules/core/wordlift_core.php' );
+require_once('modules/core/wordlift_core.php');
 
 /**
  * Log to the debug.log file.
@@ -44,9 +44,9 @@ 
  *
  * @param string|mixed $log The log data.
  */
-function wl_write_log( $log ) {
+function wl_write_log($log) {
 
-	Wordlift_Log_Service::get_instance()->debug( $log );
+	Wordlift_Log_Service::get_instance()->debug($log);
 
 }
 
@@ -61,9 +61,9 @@ 
  *
  * @return string A text with the key hidden.
  */
-function wl_write_log_hide_key( $text ) {
+function wl_write_log_hide_key($text) {
 
-	return str_ireplace( wl_configuration_get_key(), '<hidden>', $text );
+	return str_ireplace(wl_configuration_get_key(), '<hidden>', $text);
 }
 
 /**
@@ -73,7 +73,7 @@ 
 function wordlift_allowed_post_tags() {
 	global $allowedposttags;
 
-	$tags           = array( 'span' );
+	$tags           = array('span');
 	$new_attributes = array(
 		'itemscope' => array(),
 		'itemtype'  => array(),
@@ -81,15 +81,15 @@ 
 		'itemid'    => array(),
 	);
 
-	foreach ( $tags as $tag ) {
-		if ( isset( $allowedposttags[ $tag ] ) && is_array( $allowedposttags[ $tag ] ) ) {
-			$allowedposttags[ $tag ] = array_merge( $allowedposttags[ $tag ], $new_attributes );
+	foreach ($tags as $tag) {
+		if (isset($allowedposttags[$tag]) && is_array($allowedposttags[$tag])) {
+			$allowedposttags[$tag] = array_merge($allowedposttags[$tag], $new_attributes);
 		}
 	}
 }
 
 // add allowed post tags.
-add_action( 'init', 'wordlift_allowed_post_tags' );
+add_action('init', 'wordlift_allowed_post_tags');
 
 /**
  * Register additional scripts for the admin UI.
@@ -97,12 +97,12 @@ 
 function wordlift_admin_enqueue_scripts() {
 
 	// Added for compatibility with WordPress 3.9 (see http://make.wordpress.org/core/2014/04/16/jquery-ui-and-wpdialogs-in-wordpress-3-9/)
-	wp_enqueue_script( 'wpdialogs' );
-	wp_enqueue_style( 'wp-jquery-ui-dialog' );
+	wp_enqueue_script('wpdialogs');
+	wp_enqueue_style('wp-jquery-ui-dialog');
 
-	wp_enqueue_style( 'wordlift-reloaded', plugin_dir_url( __FILE__ ) . 'css/wordlift-reloaded.min.css' );
+	wp_enqueue_style('wordlift-reloaded', plugin_dir_url(__FILE__).'css/wordlift-reloaded.min.css');
 
-	wp_enqueue_script( 'jquery-ui-autocomplete' );
+	wp_enqueue_script('jquery-ui-autocomplete');
 
 	/*
 	 * Angular isn't loaded anymore separately, it is embedded in wordlift-reloaded.js.
@@ -126,13 +126,13 @@ 
 //	$log->debug( 'Registering angular scripts was ' . ( $result ? 'successful.' : 'unsuccessful.' ) );
 
 	// Disable auto-save for custom entity posts only
-	if ( Wordlift_Entity_Service::TYPE_NAME === get_post_type() ) {
-		wp_dequeue_script( 'autosave' );
+	if (Wordlift_Entity_Service::TYPE_NAME === get_post_type()) {
+		wp_dequeue_script('autosave');
 	}
 
 }
 
-add_action( 'admin_enqueue_scripts', 'wordlift_admin_enqueue_scripts' );
+add_action('admin_enqueue_scripts', 'wordlift_admin_enqueue_scripts');
 
 // We shouldn't load the wordlift-ui.min.css stylesheet when not needed.
 //
@@ -151,23 +151,23 @@ 
  *
  * @return array An array which contains allowed microdata attributes.
  */
-function wordlift_allowed_html( $allowedtags, $context ) {
+function wordlift_allowed_html($allowedtags, $context) {
 
-	if ( 'post' !== $context ) {
+	if ('post' !== $context) {
 		return $allowedtags;
 	}
 
-	return array_merge_recursive( $allowedtags, array(
+	return array_merge_recursive($allowedtags, array(
 		'span' => array(
 			'itemscope' => true,
 			'itemtype'  => true,
 			'itemid'    => true,
 			'itemprop'  => true,
 		),
-	) );
+	));
 }
 
-add_filter( 'wp_kses_allowed_html', 'wordlift_allowed_html', 10, 2 );
+add_filter('wp_kses_allowed_html', 'wordlift_allowed_html', 10, 2);
 
 /**
  * Get the coordinates for the specified post ID.
@@ -176,17 +176,17 @@ 
  *
  * @return array|null An array of coordinates or null.
  */
-function wl_get_coordinates( $post_id ) {
+function wl_get_coordinates($post_id) {
 
-	$latitude  = wl_schema_get_value( $post_id, 'latitude' );
-	$longitude = wl_schema_get_value( $post_id, 'longitude' );
+	$latitude  = wl_schema_get_value($post_id, 'latitude');
+	$longitude = wl_schema_get_value($post_id, 'longitude');
 
 	// DO NOT set latitude/longitude to 0/0 as default values. It's a specific
 	// place on the globe:"The zero/zero point of this system is located in the
 	// Gulf of Guinea about 625 km (390 mi) south of Tema, Ghana."
 	return array(
-		'latitude'  => isset( $latitude[0] ) && is_numeric( $latitude[0] ) ? $latitude[0] : '',
-		'longitude' => isset( $longitude[0] ) && is_numeric( $longitude[0] ) ? $longitude[0] : '',
+		'latitude'  => isset($latitude[0]) && is_numeric($latitude[0]) ? $latitude[0] : '',
+		'longitude' => isset($longitude[0]) && is_numeric($longitude[0]) ? $longitude[0] : '',
 	);
 }
 
@@ -199,11 +199,11 @@ 
  *
  * @return array An array of image URLs.
  */
-function wl_get_image_urls( $post_id ) {
+function wl_get_image_urls($post_id) {
 
 	return Wordlift_Storage_Factory::get_instance()
 	                               ->post_images()
-	                               ->get( $post_id );
+	                               ->get($post_id);
 
 //	// If there is a featured image it has the priority.
 //	$featured_image_id = get_post_thumbnail_id( $post_id );
@@ -249,21 +249,21 @@ 
  *
  * @return WP_Post|null A post instance or null if not found.
  */
-function wl_get_attachment_for_source_url( $parent_post_id, $source_url ) {
+function wl_get_attachment_for_source_url($parent_post_id, $source_url) {
 
 	// wl_write_log( "wl_get_attachment_for_source_url [ parent post id :: $parent_post_id ][ source url :: $source_url ]" );
 
-	$posts = get_posts( array(
+	$posts = get_posts(array(
 		'post_type'      => 'attachment',
 		'posts_per_page' => 1,
 		'post_status'    => 'any',
 		'post_parent'    => $parent_post_id,
 		'meta_key'       => 'wl_source_url',
 		'meta_value'     => $source_url,
-	) );
+	));
 
 	// Return the found post.
-	if ( 1 === count( $posts ) ) {
+	if (1 === count($posts)) {
 		return $posts[0];
 	}
 
@@ -277,10 +277,10 @@ 
  * @param int    $post_id The post ID.
  * @param string $source_url The source URL.
  */
-function wl_set_source_url( $post_id, $source_url ) {
+function wl_set_source_url($post_id, $source_url) {
 
-	delete_post_meta( $post_id, 'wl_source_url' );
-	add_post_meta( $post_id, 'wl_source_url', $source_url );
+	delete_post_meta($post_id, 'wl_source_url');
+	add_post_meta($post_id, 'wl_source_url', $source_url);
 }
 
 /**
@@ -294,9 +294,9 @@ 
  *
  * @return string The sanitized path.
  */
-function wl_sanitize_uri_path( $path, $char = '_' ) {
+function wl_sanitize_uri_path($path, $char = '_') {
 
-	return Wordlift_Uri_Service::get_instance()->sanitize_path( $path, $char );
+	return Wordlift_Uri_Service::get_instance()->sanitize_path($path, $char);
 }
 
 ///**
@@ -335,102 +335,102 @@ 
  *
  * @return string The updated post content.
  */
-function wl_replace_item_id_with_uri( $content ) {
+function wl_replace_item_id_with_uri($content) {
 
-	$log = Wordlift_Log_Service::get_logger( 'wl_replace_item_id_with_uri' );
-	$log->trace( 'Replacing item IDs with URIs...' );
+	$log = Wordlift_Log_Service::get_logger('wl_replace_item_id_with_uri');
+	$log->trace('Replacing item IDs with URIs...');
 
 	// Strip slashes, see https://core.trac.wordpress.org/ticket/21767
-	$content = stripslashes( $content );
+	$content = stripslashes($content);
 
 	// If any match are found.
 	$matches = array();
-	if ( 0 < preg_match_all( '/ itemid="([^"]+)"/i', $content, $matches, PREG_SET_ORDER ) ) {
+	if (0 < preg_match_all('/ itemid="([^"]+)"/i', $content, $matches, PREG_SET_ORDER)) {
 
-		foreach ( $matches as $match ) {
+		foreach ($matches as $match) {
 
 			// Get the item ID.
 			$item_id = $match[1];
 
 			// Get the post bound to that item ID (looking both in the 'official' URI and in the 'same-as' .
 			$post = Wordlift_Entity_Service::get_instance()
-			                               ->get_entity_post_by_uri( $item_id );
+			                               ->get_entity_post_by_uri($item_id);
 
 			// If no entity is found, continue to the next one.
-			if ( null === $post ) {
+			if (null === $post) {
 				continue;
 			}
 
 			// Get the URI for that post.
-			$uri = wl_get_entity_uri( $post->ID );
+			$uri = wl_get_entity_uri($post->ID);
 
 			// wl_write_log( "wl_replace_item_id_with_uri [ item id :: $item_id ][ uri :: $uri ]" );
 
 			// If the item ID and the URI differ, replace the item ID with the URI saved in WordPress.
-			if ( $item_id !== $uri ) {
-				$uri_e   = esc_html( $uri );
-				$content = str_replace( " itemid=\"$item_id\"", " itemid=\"$uri_e\"", $content );
+			if ($item_id !== $uri) {
+				$uri_e   = esc_html($uri);
+				$content = str_replace(" itemid=\"$item_id\"", " itemid=\"$uri_e\"", $content);
 			}
 		}
 	}
 
 	// Reapply slashes.
-	$content = addslashes( $content );
+	$content = addslashes($content);
 
 	return $content;
 }
 
-add_filter( 'content_save_pre', 'wl_replace_item_id_with_uri', 1, 1 );
+add_filter('content_save_pre', 'wl_replace_item_id_with_uri', 1, 1);
 
-require_once( 'wordlift_entity_functions.php' );
+require_once('wordlift_entity_functions.php');
 
 // add editor related methods.
-require_once( 'wordlift_editor.php' );
+require_once('wordlift_editor.php');
 
 // add the WordLift entity custom type.
-require_once( 'wordlift_entity_type.php' );
+require_once('wordlift_entity_type.php');
 
 // add callbacks on post save to notify data changes from wp to redlink triple store
-require_once( 'wordlift_to_redlink_data_push_callbacks.php' );
+require_once('wordlift_to_redlink_data_push_callbacks.php');
 
-require_once( 'modules/configuration/wordlift_configuration_settings.php' );
+require_once('modules/configuration/wordlift_configuration_settings.php');
 
 // Load modules
-require_once( 'modules/analyzer/wordlift_analyzer.php' );
-require_once( 'modules/linked_data/wordlift_linked_data.php' );
-require_once( 'modules/prefixes/wordlift_prefixes.php' );
+require_once('modules/analyzer/wordlift_analyzer.php');
+require_once('modules/linked_data/wordlift_linked_data.php');
+require_once('modules/prefixes/wordlift_prefixes.php');
 
 // Shortcodes
 
-require_once( 'modules/geo_widget/wordlift_geo_widget.php' );
-require_once( 'shortcodes/wordlift_shortcode_chord.php' );
-require_once( 'shortcodes/wordlift_shortcode_geomap.php' );
-require_once( 'shortcodes/wordlift_shortcode_field.php' );
-require_once( 'shortcodes/wordlift_shortcode_faceted_search.php' );
-require_once( 'shortcodes/wordlift_shortcode_navigator.php' );
+require_once('modules/geo_widget/wordlift_geo_widget.php');
+require_once('shortcodes/wordlift_shortcode_chord.php');
+require_once('shortcodes/wordlift_shortcode_geomap.php');
+require_once('shortcodes/wordlift_shortcode_field.php');
+require_once('shortcodes/wordlift_shortcode_faceted_search.php');
+require_once('shortcodes/wordlift_shortcode_navigator.php');
 
-require_once( 'widgets/wordlift_widget_geo.php' );
-require_once( 'widgets/class-wordlift-chord-widget.php' );
-require_once( 'widgets/wordlift_widget_timeline.php' );
+require_once('widgets/wordlift_widget_geo.php');
+require_once('widgets/class-wordlift-chord-widget.php');
+require_once('widgets/wordlift_widget_timeline.php');
 
-require_once( 'wordlift_redlink.php' );
+require_once('wordlift_redlink.php');
 
 // Add admin functions.
 // TODO: find a way to make 'admin' UI tests work.
 //if ( is_admin() ) {
 
-require_once( 'admin/wordlift_admin.php' );
-require_once( 'admin/wordlift_admin_edit_post.php' );
-require_once( 'admin/wordlift_admin_save_post.php' );
+require_once('admin/wordlift_admin.php');
+require_once('admin/wordlift_admin_edit_post.php');
+require_once('admin/wordlift_admin_save_post.php');
 
 // add the entities meta box.
-require_once( 'admin/wordlift_admin_meta_box_entities.php' );
+require_once('admin/wordlift_admin_meta_box_entities.php');
 
 // add the entity creation AJAX.
-require_once( 'admin/wordlift_admin_ajax_related_posts.php' );
+require_once('admin/wordlift_admin_ajax_related_posts.php');
 
 // Load the wl_chord TinyMCE button and configuration dialog.
-require_once( 'admin/wordlift_admin_shortcodes.php' );
+require_once('admin/wordlift_admin_shortcodes.php');
 
 /**
  * The code that runs during plugin activation.
@@ -438,11 +438,11 @@ 
  */
 function activate_wordlift() {
 
-	$log = Wordlift_Log_Service::get_logger( 'activate_wordlift' );
+	$log = Wordlift_Log_Service::get_logger('activate_wordlift');
 
-	$log->info( 'Activating WordLift...' );
+	$log->info('Activating WordLift...');
 
-	require_once plugin_dir_path( __FILE__ ) . 'includes/class-wordlift-activator.php';
+	require_once plugin_dir_path(__FILE__).'includes/class-wordlift-activator.php';
 	Wordlift_Activator::activate();
 
 	/**
@@ -465,21 +465,21 @@ 
  */
 function deactivate_wordlift() {
 
-	require_once plugin_dir_path( __FILE__ ) . 'includes/class-wordlift-deactivator.php';
+	require_once plugin_dir_path(__FILE__).'includes/class-wordlift-deactivator.php';
 	Wordlift_Deactivator::deactivate();
 	Wordlift_Http_Api::deactivate();
 	flush_rewrite_rules();
 
 }
 
-register_activation_hook( __FILE__, 'activate_wordlift' );
-register_deactivation_hook( __FILE__, 'deactivate_wordlift' );
+register_activation_hook(__FILE__, 'activate_wordlift');
+register_deactivation_hook(__FILE__, 'deactivate_wordlift');
 
 /**
  * The core plugin class that is used to define internationalization,
  * admin-specific hooks, and public-facing site hooks.
  */
-require plugin_dir_path( __FILE__ ) . 'includes/class-wordlift.php';
+require plugin_dir_path(__FILE__).'includes/class-wordlift.php';
 
 /**
  * Begins execution of the plugin.

src/admin/class-wordlift-admin-post-edit-page.php

Indentation +98 added lines, -98 removed lines

@@ -18,82 +18,82 @@ 
  */
 class Wordlift_Admin_Post_Edit_Page {
 
-	/**
-	 * The {@link Wordlift} plugin instance.
-	 *
-	 * @since 3.11.0
-	 *
-	 * @var \Wordlift $plugin The {@link Wordlift} plugin instance.
-	 */
-	private $plugin;
-
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since 3.15.4
-	 *
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * Create the {@link Wordlift_Admin_Post_Edit_Page} instance.
-	 *
-	 * @since 3.11.0
-	 *
-	 * @param \Wordlift $plugin The {@link Wordlift} plugin instance.
-	 */
-	function __construct( $plugin ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
-
-		// Bail out if we're in the UX Builder editor.
-		if ( $this->is_ux_builder_editor() ) {
-			$this->log->info( 'WordLift will not show, since we are in UX Builder editor.' );
-
-			return;
-		}
-
-		// Define the callback.
-		$callback = array( $this, 'enqueue_scripts', );
-
-		// Set a hook to enqueue scripts only when the edit page is displayed.
-		add_action( 'admin_print_scripts-post.php', $callback );
-		add_action( 'admin_print_scripts-post-new.php', $callback );
-
-		$this->plugin = $plugin;
-	}
-
-	/**
-	 * Check if we're in UX builder.
-	 *
-	 * @see   https://github.com/insideout10/wordlift-plugin/issues/691
-	 *
-	 * @since 3.15.4
-	 *
-	 * @return bool True if we're in UX builder, otherwise false.
-	 */
-	private function is_ux_builder_editor() {
-
-		return function_exists( 'ux_builder_is_editor' )
-		       && ux_builder_is_editor();
-	}
-
-	/**
-	 * Enqueue scripts and styles for the edit page.
-	 *
-	 * @since 3.11.0
-	 */
-	public function enqueue_scripts() {
-
-		// Dequeue potentially conflicting ontrapages angular scripts which any *are not* used on the edit screen.
-		//
-		// @see https://github.com/insideout10/wordlift-plugin/issues/832
-		wp_dequeue_script( 'ontrapagesAngular' );
-		wp_dequeue_script( 'ontrapagesApp' );
-		wp_dequeue_script( 'ontrapagesController' );
-
-		/*
+    /**
+     * The {@link Wordlift} plugin instance.
+     *
+     * @since 3.11.0
+     *
+     * @var \Wordlift $plugin The {@link Wordlift} plugin instance.
+     */
+    private $plugin;
+
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since 3.15.4
+     *
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * Create the {@link Wordlift_Admin_Post_Edit_Page} instance.
+     *
+     * @since 3.11.0
+     *
+     * @param \Wordlift $plugin The {@link Wordlift} plugin instance.
+     */
+    function __construct( $plugin ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( get_class() );
+
+        // Bail out if we're in the UX Builder editor.
+        if ( $this->is_ux_builder_editor() ) {
+            $this->log->info( 'WordLift will not show, since we are in UX Builder editor.' );
+
+            return;
+        }
+
+        // Define the callback.
+        $callback = array( $this, 'enqueue_scripts', );
+
+        // Set a hook to enqueue scripts only when the edit page is displayed.
+        add_action( 'admin_print_scripts-post.php', $callback );
+        add_action( 'admin_print_scripts-post-new.php', $callback );
+
+        $this->plugin = $plugin;
+    }
+
+    /**
+     * Check if we're in UX builder.
+     *
+     * @see   https://github.com/insideout10/wordlift-plugin/issues/691
+     *
+     * @since 3.15.4
+     *
+     * @return bool True if we're in UX builder, otherwise false.
+     */
+    private function is_ux_builder_editor() {
+
+        return function_exists( 'ux_builder_is_editor' )
+               && ux_builder_is_editor();
+    }
+
+    /**
+     * Enqueue scripts and styles for the edit page.
+     *
+     * @since 3.11.0
+     */
+    public function enqueue_scripts() {
+
+        // Dequeue potentially conflicting ontrapages angular scripts which any *are not* used on the edit screen.
+        //
+        // @see https://github.com/insideout10/wordlift-plugin/issues/832
+        wp_dequeue_script( 'ontrapagesAngular' );
+        wp_dequeue_script( 'ontrapagesApp' );
+        wp_dequeue_script( 'ontrapagesController' );
+
+        /*
 		 * Enqueue the edit screen JavaScript. The `wordlift-admin.bundle.js` file
 		 * is scheduled to replace the older `wordlift-admin.min.js` once client-side
 		 * code is properly refactored.
@@ -102,33 +102,33 @@ 
 		 *
 		 * @since 3.20.0 edit.js has been migrated to the new webpack configuration.
 		 */
-		// plugin_dir_url( __FILE__ ) . 'js/1/edit.js'
-		$script_name = plugin_dir_url( dirname( __FILE__ ) ) . 'js/dist/edit';
-		wp_enqueue_script(
-			'wordlift-admin-edit-page', "$script_name.js",
-			array(
-				$this->plugin->get_plugin_name(),
-				'jquery',
-				// Require wp.ajax.
-				'wp-util',
-				/*
+        // plugin_dir_url( __FILE__ ) . 'js/1/edit.js'
+        $script_name = plugin_dir_url( dirname( __FILE__ ) ) . 'js/dist/edit';
+        wp_enqueue_script(
+            'wordlift-admin-edit-page', "$script_name.js",
+            array(
+                $this->plugin->get_plugin_name(),
+                'jquery',
+                // Require wp.ajax.
+                'wp-util',
+                /*
 				 * Angular isn't loaded anymore remotely, but it is loaded within wordlift-reloaded.js.
 				 *
 				 * See https://github.com/insideout10/wordlift-plugin/issues/865.
 				 *
 				 * @since 3.19.6
 				 */
-				//				// Require Angular.
-				//				'wl-angular',
-				//				'wl-angular-geolocation',
-				//				'wl-angular-touch',
-				//				'wl-angular-animate',
-			),
-			$this->plugin->get_version(),
-			false
-		);
-		wp_enqueue_style( 'wordlift-admin-edit-page', "$script_name.css", array(), $this->plugin->get_version() );
-
-	}
+                //				// Require Angular.
+                //				'wl-angular',
+                //				'wl-angular-geolocation',
+                //				'wl-angular-touch',
+                //				'wl-angular-animate',
+            ),
+            $this->plugin->get_version(),
+            false
+        );
+        wp_enqueue_style( 'wordlift-admin-edit-page', "$script_name.css", array(), $this->plugin->get_version() );
+
+    }
 
 }

src/includes/cache/class-wordlift-file-cache-service.php

Indentation +192 added lines, -192 removed lines

@@ -16,211 +16,211 @@
  */
 class Wordlift_File_Cache_Service implements Wordlift_Cache_Service {
 
-	/**
-	 * The cache directory.
-	 *
-	 * @since  3.16.0
-	 * @access private
-	 * @var string $cache_dir The root cache directory (ending with a trailing slash).
-	 */
-	private $cache_dir;
-
-	/**
-	 * The file extension for cache files (e.g. `.wlcache`).
-	 *
-	 * @since  3.16.0
-	 * @access private
-	 * @var string $file_extension The file extension for cache files (e.g. `.wlcache`).
-	 */
-	private $file_extension;
-
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.16.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * The {@link Wordlift_File_Cache_Service} registered instances.
-	 *
-	 * Each {@link Wordlift_File_Cache_Service} adds itself to the registered
-	 * instances.
-	 *
-	 * @since  3.16.3
-	 * @access private
-	 * @var array $instances An array of {@link Wordlift_File_Cache_Service} instances.
-	 */
-	private static $instances = array();
-
-	/**
-	 * Create a {@link Wordlift_File_Cache_Service} instance.
-	 *
-	 * The File Cache Service requires a base cache directory (to which a unique
-	 * id for the current site will be appended) and a file extension for cache
-	 * files (by default `.wlcache`) is used.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @param string $cache_dir The base cache directory.
-	 * @param string $file_extension The file extension, by default `.wlcache`.
-	 */
-	public function __construct( $cache_dir, $file_extension = '.wlcache' ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
-
-		// Set the cache directory using the base directory provided by the caller
-		// and appending a hash for the unique site id.
-		$this->cache_dir      = trailingslashit( $cache_dir ) . md5( get_site_url() ) . '/';
-		$this->file_extension = $file_extension;
-
-		// Create the cache dir.
-		if ( ! file_exists( $this->cache_dir ) ) {
-			@mkdir( $this->cache_dir, 0755, true );
-		}
-
-		// Add ourselves to the list of instances.
-		self::$instances[] = $this;
-
-		$this->log->debug( "File Cache service initialized on $this->cache_dir." );
-
-	}
-
-	/**
-	 * Get the cached response for the specified `id`.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @param int $id The cache `id`.
-	 *
-	 * @return mixed|false The cached contents or false if the cache isn't found.
-	 */
-	function get_cache( $id ) {
-
-		// Bail out if we don't have the cache.
-		if ( ! $this->has_cache( $id ) ) {
-			return false;
-		}
-
-		// Get the filename.
-		$filename = $this->get_filename( $id );
-
-		$this->log->trace( "Trying to get cache contents for $id from $filename..." );
-
-		// Try to decode the contents.
-		$contents = json_decode( file_get_contents( $filename ), true );
-
-		// Return false if decoding failed, otherwise the decoded contents.
-		return $contents ?: false;
-	}
-
-	/**
-	 * Set the cache contents for the specified `id`.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @param int $id The cache id.
-	 *
-	 * @return bool True if the `id` has a cache.
-	 */
-	function has_cache( $id ) {
-
-		// Get the filename.
-		$filename = $this->get_filename( $id );
-
-		// Bail out if the file doesn't exist.
-		return file_exists( $filename );
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	function set_cache( $id, $contents ) {
-
-		$filename = $this->get_filename( $id );
-
-		$this->log->trace( "Writing cache contents for $id to $filename..." );
-
-		@file_put_contents( $filename, wp_json_encode( $contents ) );
-
-	}
-
-	/**
-	 * Delete the cache for the specified `id`.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @param int $id The cache `id`.
-	 */
-	function delete_cache( $id ) {
-
-		$filename = $this->get_filename( $id );
-
-		$this->log->trace( "Deleting cache contents for $id, file $filename..." );
-
-		@unlink( $filename );
-
-	}
+    /**
+     * The cache directory.
+     *
+     * @since  3.16.0
+     * @access private
+     * @var string $cache_dir The root cache directory (ending with a trailing slash).
+     */
+    private $cache_dir;
+
+    /**
+     * The file extension for cache files (e.g. `.wlcache`).
+     *
+     * @since  3.16.0
+     * @access private
+     * @var string $file_extension The file extension for cache files (e.g. `.wlcache`).
+     */
+    private $file_extension;
+
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.16.0
+     * @access private
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * The {@link Wordlift_File_Cache_Service} registered instances.
+     *
+     * Each {@link Wordlift_File_Cache_Service} adds itself to the registered
+     * instances.
+     *
+     * @since  3.16.3
+     * @access private
+     * @var array $instances An array of {@link Wordlift_File_Cache_Service} instances.
+     */
+    private static $instances = array();
+
+    /**
+     * Create a {@link Wordlift_File_Cache_Service} instance.
+     *
+     * The File Cache Service requires a base cache directory (to which a unique
+     * id for the current site will be appended) and a file extension for cache
+     * files (by default `.wlcache`) is used.
+     *
+     * @since 3.16.0
+     *
+     * @param string $cache_dir The base cache directory.
+     * @param string $file_extension The file extension, by default `.wlcache`.
+     */
+    public function __construct( $cache_dir, $file_extension = '.wlcache' ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( get_class() );
+
+        // Set the cache directory using the base directory provided by the caller
+        // and appending a hash for the unique site id.
+        $this->cache_dir      = trailingslashit( $cache_dir ) . md5( get_site_url() ) . '/';
+        $this->file_extension = $file_extension;
+
+        // Create the cache dir.
+        if ( ! file_exists( $this->cache_dir ) ) {
+            @mkdir( $this->cache_dir, 0755, true );
+        }
+
+        // Add ourselves to the list of instances.
+        self::$instances[] = $this;
+
+        $this->log->debug( "File Cache service initialized on $this->cache_dir." );
+
+    }
+
+    /**
+     * Get the cached response for the specified `id`.
+     *
+     * @since 3.16.0
+     *
+     * @param int $id The cache `id`.
+     *
+     * @return mixed|false The cached contents or false if the cache isn't found.
+     */
+    function get_cache( $id ) {
+
+        // Bail out if we don't have the cache.
+        if ( ! $this->has_cache( $id ) ) {
+            return false;
+        }
+
+        // Get the filename.
+        $filename = $this->get_filename( $id );
+
+        $this->log->trace( "Trying to get cache contents for $id from $filename..." );
+
+        // Try to decode the contents.
+        $contents = json_decode( file_get_contents( $filename ), true );
+
+        // Return false if decoding failed, otherwise the decoded contents.
+        return $contents ?: false;
+    }
+
+    /**
+     * Set the cache contents for the specified `id`.
+     *
+     * @since 3.16.0
+     *
+     * @param int $id The cache id.
+     *
+     * @return bool True if the `id` has a cache.
+     */
+    function has_cache( $id ) {
+
+        // Get the filename.
+        $filename = $this->get_filename( $id );
+
+        // Bail out if the file doesn't exist.
+        return file_exists( $filename );
+    }
+
+    /**
+     * @inheritdoc
+     */
+    function set_cache( $id, $contents ) {
+
+        $filename = $this->get_filename( $id );
+
+        $this->log->trace( "Writing cache contents for $id to $filename..." );
+
+        @file_put_contents( $filename, wp_json_encode( $contents ) );
+
+    }
+
+    /**
+     * Delete the cache for the specified `id`.
+     *
+     * @since 3.16.0
+     *
+     * @param int $id The cache `id`.
+     */
+    function delete_cache( $id ) {
+
+        $filename = $this->get_filename( $id );
+
+        $this->log->trace( "Deleting cache contents for $id, file $filename..." );
+
+        @unlink( $filename );
+
+    }
 
-	/**
-	 * Flush the whole cache.
-	 *
-	 * @since 3.16.0
-	 */
-	function flush() {
+    /**
+     * Flush the whole cache.
+     *
+     * @since 3.16.0
+     */
+    function flush() {
 
-		// Bail out if the cache dir isn't set.
-		if ( empty( $this->cache_dir ) || '/' === $this->cache_dir ) {
-			return;
-		}
+        // Bail out if the cache dir isn't set.
+        if ( empty( $this->cache_dir ) || '/' === $this->cache_dir ) {
+            return;
+        }
 
-		$this->log->trace( "Flushing cache contents from $this->cache_dir..." );
+        $this->log->trace( "Flushing cache contents from $this->cache_dir..." );
 
-		$handle = @opendir( $this->cache_dir );
+        $handle = @opendir( $this->cache_dir );
 
-		// Bail out if the directory can't be opened.
-		if ( false === $handle ) {
-			return;
-		}
+        // Bail out if the directory can't be opened.
+        if ( false === $handle ) {
+            return;
+        }
 
-		// Calculate the file extension length for matching file names.
-		$file_extension_length = strlen( $this->file_extension );
+        // Calculate the file extension length for matching file names.
+        $file_extension_length = strlen( $this->file_extension );
 
-		// Loop into the directory to delete files.
-		while ( false !== ( $entry = readdir( $handle ) ) ) {
-			if ( substr( $entry, - $file_extension_length ) === $this->file_extension ) {
-				$this->log->trace( "Deleting file {$this->cache_dir}{$entry}..." );
-				@unlink( $this->cache_dir . $entry );
-			}
-		}
+        // Loop into the directory to delete files.
+        while ( false !== ( $entry = readdir( $handle ) ) ) {
+            if ( substr( $entry, - $file_extension_length ) === $this->file_extension ) {
+                $this->log->trace( "Deleting file {$this->cache_dir}{$entry}..." );
+                @unlink( $this->cache_dir . $entry );
+            }
+        }
 
-		// Finally closed the directory.
-		closedir( $handle );
+        // Finally closed the directory.
+        closedir( $handle );
 
-	}
+    }
 
-	public static function flush_all() {
+    public static function flush_all() {
 
-		foreach ( self::$instances as $instance ) {
-			$instance->flush();
-		}
+        foreach ( self::$instances as $instance ) {
+            $instance->flush();
+        }
 
-	}
+    }
 
-	/**
-	 * Get the filename holding the cache contents for the specified `id`.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @param int $id The cache `id`.
-	 *
-	 * @return string The filename.
-	 */
-	private function get_filename( $id ) {
+    /**
+     * Get the filename holding the cache contents for the specified `id`.
+     *
+     * @since 3.16.0
+     *
+     * @param int $id The cache `id`.
+     *
+     * @return string The filename.
+     */
+    private function get_filename( $id ) {
 
-		return $this->cache_dir . md5( $id ) . $this->file_extension;
-	}
+        return $this->cache_dir . md5( $id ) . $this->file_extension;
+    }
 
 }

Spacing +35 added lines, -35 removed lines

@@ -67,24 +67,24 @@ 
 	 * @param string $cache_dir The base cache directory.
 	 * @param string $file_extension The file extension, by default `.wlcache`.
 	 */
-	public function __construct( $cache_dir, $file_extension = '.wlcache' ) {
+	public function __construct($cache_dir, $file_extension = '.wlcache') {
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
 		// Set the cache directory using the base directory provided by the caller
 		// and appending a hash for the unique site id.
-		$this->cache_dir      = trailingslashit( $cache_dir ) . md5( get_site_url() ) . '/';
+		$this->cache_dir      = trailingslashit($cache_dir).md5(get_site_url()).'/';
 		$this->file_extension = $file_extension;
 
 		// Create the cache dir.
-		if ( ! file_exists( $this->cache_dir ) ) {
-			@mkdir( $this->cache_dir, 0755, true );
+		if ( ! file_exists($this->cache_dir)) {
+			@mkdir($this->cache_dir, 0755, true);
 		}
 
 		// Add ourselves to the list of instances.
 		self::$instances[] = $this;
 
-		$this->log->debug( "File Cache service initialized on $this->cache_dir." );
+		$this->log->debug("File Cache service initialized on $this->cache_dir.");
 
 	}
 
@@ -97,20 +97,20 @@ 
 	 *
 	 * @return mixed|false The cached contents or false if the cache isn't found.
 	 */
-	function get_cache( $id ) {
+	function get_cache($id) {
 
 		// Bail out if we don't have the cache.
-		if ( ! $this->has_cache( $id ) ) {
+		if ( ! $this->has_cache($id)) {
 			return false;
 		}
 
 		// Get the filename.
-		$filename = $this->get_filename( $id );
+		$filename = $this->get_filename($id);
 
-		$this->log->trace( "Trying to get cache contents for $id from $filename..." );
+		$this->log->trace("Trying to get cache contents for $id from $filename...");
 
 		// Try to decode the contents.
-		$contents = json_decode( file_get_contents( $filename ), true );
+		$contents = json_decode(file_get_contents($filename), true);
 
 		// Return false if decoding failed, otherwise the decoded contents.
 		return $contents ?: false;
@@ -125,25 +125,25 @@ 
 	 *
 	 * @return bool True if the `id` has a cache.
 	 */
-	function has_cache( $id ) {
+	function has_cache($id) {
 
 		// Get the filename.
-		$filename = $this->get_filename( $id );
+		$filename = $this->get_filename($id);
 
 		// Bail out if the file doesn't exist.
-		return file_exists( $filename );
+		return file_exists($filename);
 	}
 
 	/**
 	 * @inheritdoc
 	 */
-	function set_cache( $id, $contents ) {
+	function set_cache($id, $contents) {
 
-		$filename = $this->get_filename( $id );
+		$filename = $this->get_filename($id);
 
-		$this->log->trace( "Writing cache contents for $id to $filename..." );
+		$this->log->trace("Writing cache contents for $id to $filename...");
 
-		@file_put_contents( $filename, wp_json_encode( $contents ) );
+		@file_put_contents($filename, wp_json_encode($contents));
 
 	}
 
@@ -154,13 +154,13 @@ 
 	 *
 	 * @param int $id The cache `id`.
 	 */
-	function delete_cache( $id ) {
+	function delete_cache($id) {
 
-		$filename = $this->get_filename( $id );
+		$filename = $this->get_filename($id);
 
-		$this->log->trace( "Deleting cache contents for $id, file $filename..." );
+		$this->log->trace("Deleting cache contents for $id, file $filename...");
 
-		@unlink( $filename );
+		@unlink($filename);
 
 	}
 
@@ -172,38 +172,38 @@ 
 	function flush() {
 
 		// Bail out if the cache dir isn't set.
-		if ( empty( $this->cache_dir ) || '/' === $this->cache_dir ) {
+		if (empty($this->cache_dir) || '/' === $this->cache_dir) {
 			return;
 		}
 
-		$this->log->trace( "Flushing cache contents from $this->cache_dir..." );
+		$this->log->trace("Flushing cache contents from $this->cache_dir...");
 
-		$handle = @opendir( $this->cache_dir );
+		$handle = @opendir($this->cache_dir);
 
 		// Bail out if the directory can't be opened.
-		if ( false === $handle ) {
+		if (false === $handle) {
 			return;
 		}
 
 		// Calculate the file extension length for matching file names.
-		$file_extension_length = strlen( $this->file_extension );
+		$file_extension_length = strlen($this->file_extension);
 
 		// Loop into the directory to delete files.
-		while ( false !== ( $entry = readdir( $handle ) ) ) {
-			if ( substr( $entry, - $file_extension_length ) === $this->file_extension ) {
-				$this->log->trace( "Deleting file {$this->cache_dir}{$entry}..." );
-				@unlink( $this->cache_dir . $entry );
+		while (false !== ($entry = readdir($handle))) {
+			if (substr($entry, - $file_extension_length) === $this->file_extension) {
+				$this->log->trace("Deleting file {$this->cache_dir}{$entry}...");
+				@unlink($this->cache_dir.$entry);
 			}
 		}
 
 		// Finally closed the directory.
-		closedir( $handle );
+		closedir($handle);
 
 	}
 
 	public static function flush_all() {
 
-		foreach ( self::$instances as $instance ) {
+		foreach (self::$instances as $instance) {
 			$instance->flush();
 		}
 
@@ -218,9 +218,9 @@ 
 	 *
 	 * @return string The filename.
 	 */
-	private function get_filename( $id ) {
+	private function get_filename($id) {
 
-		return $this->cache_dir . md5( $id ) . $this->file_extension;
+		return $this->cache_dir.md5($id).$this->file_extension;
 	}
 
 }

src/includes/class-wordlift-sparql-service.php

Indentation +307 added lines, -307 removed lines

@@ -18,312 +18,312 @@
  */
 class Wordlift_Sparql_Service {
 
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.6.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private static $log;
-
-	/**
-	 * The {@link Wordlift_Sparql_Service} singleton instance.
-	 *
-	 * @since  3.6.0
-	 * @access private
-	 * @var \Wordlift_Sparql_Service $instance The {@link Wordlift_Sparql_Service} singleton instance.
-	 */
-	private static $instance;
-
-	/**
-	 * Create a {@link Wordlift_Sparql_Service} instance.
-	 *
-	 * @since 3.6.0
-	 */
-	public function __construct() {
-
-		self::$log = Wordlift_Log_Service::get_logger( 'Wordlift_Sparql_Service' );
-
-		self::$instance = $this;
-
-	}
-
-	/**
-	 * Get the singleton instance of the {@link Wordlift_Sparql_Service}.
-	 *
-	 * @since 3.6.0
-	 * @return \Wordlift_Sparql_Service
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * Queue a SPARQL statement for execution.
-	 *
-	 * @since 3.6.0
-	 *
-	 * @param string $stmt The SPARQL statement.
-	 * @param bool   $queue Whether to queue the statement for asynchronous
-	 *                      execution.
-	 */
-	public function execute( $stmt, $queue = WL_ENABLE_SPARQL_UPDATE_QUERIES_BUFFERING ) {
-
-		rl_execute_sparql_update_query( $stmt, $queue );
-
-	}
-
-	/**
-	 * Run the SPARQL queries buffered for the specified request id.
-	 *
-	 * @since 3.13.2
-	 *
-	 * @param string $request_id A unique request id.
-	 */
-	public function run_sparql_query( $request_id ) {
-
-		self::$log->debug( "Running SPARQL queries..." );
-
-		// Look for a free temporary filename.
-		for ( $index = 1; $index < PHP_INT_MAX; $index ++ ) {
-			$filename = WL_TEMP_DIR . $request_id . "-$index.sparql";
-
-			// Bail out if there are no files left.
-			if ( ! file_exists( $filename ) ) {
-				break;
-			}
-
-			self::$log->debug( "Running SPARQL from $filename..." );
-
-			// Get the query saved in the file.
-			$query = file_get_contents( $filename );
-
-			// Execute the SPARQL query.
-			rl_execute_sparql_update_query( $query, false );
-
-			// Delete the temporary file.
-			unlink( $filename );
-		}
-
-		// Reindex the triple store.
-		wordlift_reindex_triple_store();
-
-	}
-
-	/**
-	 * Queue a SPARQL statement for asynchronous execution.
-	 *
-	 * @since 3.13.2
-	 *
-	 * @param string $stmt The SPARQL statement.
-	 *
-	 * @throws Exception
-	 */
-	public function queue( $stmt ) {
-
-		// Get a temporary filename.
-		$filename = $this->get_temporary_file_for_sparql();
-
-		self::$log->debug( "Buffering SPARQL to file $filename..." );
-
-		// Write the contents to the temporary filename.
-		@file_put_contents( $filename, $stmt . "\n", FILE_APPEND );
-
-	}
-
-	/**
-	 * Get a temporary filename where to store SPARQL queries.
-	 *
-	 * @since 3.13.2
-	 *
-	 * @return string The filename.
-	 * @throws Exception An exception is thrown if there are already 1.000
-	 *                   temporary files for this request.
-	 */
-	private function get_temporary_file_for_sparql() {
-
-		// Look for a free temporary filename.
-		for ( $index = 1; $index < PHP_INT_MAX; $index ++ ) {
-			$filename = WL_TEMP_DIR . WL_REQUEST_ID . "-$index.sparql";
-
-			if ( ! file_exists( $filename ) ) {
-
-				// Only if this it the first buffered SPARQL, then launch the
-				// action which will be handled by the Async Task. The Async
-				// Task will take care of all the buffered files _on shutdown_.
-				if ( 1 === $index ) {
-					do_action( 'wl_run_sparql_query', WL_REQUEST_ID );
-				}
-
-				// Return the temporary filename.
-				return $filename;
-			}
-		}
-
-		throw new Exception( 'Cannot create a temporary file [ ' . WL_TEMP_DIR . WL_REQUEST_ID . ' ].' );
-	}
-
-	/**
-	 * Execute the SELECT query.
-	 *
-	 * @since 3.12.2
-	 *
-	 * @param string $query The SELECT query to execute.
-	 *
-	 * @return WP_Error|array The response or WP_Error on failure.
-	 */
-	public function select( $query ) {
-
-		// Prepare the SPARQL statement by prepending the default namespaces.
-		$sparql = rl_sparql_prefixes() . "\n" . $query;
-
-		// Get the SPARQL SELECT URL.
-		$url = wl_configuration_get_query_select_url() . urlencode( $sparql );
-
-		$http_options = unserialize( WL_REDLINK_API_HTTP_OPTIONS );
-
-		/**
-		 * Filter: 'wl_sparql_select_http_args' - Allow third parties to hook and add additional HTTP args.
-		 *
-		 * @since 3.17.0
-		 *
-		 * @param   array $http_options Current http options.
-		 */
-		$args = apply_filters( 'wl_sparql_select_http_args', $http_options );
-
-		return wp_remote_get( $url, $args );
-	}
-
-	/**
-	 * Formats the provided value according to the specified type in order to
-	 * insert the value using SPARQL. The value is also escaped.
-	 *
-	 * @since 3.6.0
-	 *
-	 * @param string      $value The value.
-	 * @param string      $type The value type.
-	 * @param string|null $language The language tag or null if not set.
-	 *
-	 * @return string The formatted value for SPARQL statements.
-	 */
-	public static function format( $value, $type = null, $language = null ) {
-
-		// see https://www.w3.org/TR/sparql11-query/.
-
-		switch ( $type ) {
-
-			case Wordlift_Schema_Service::DATA_TYPE_BOOLEAN:
-				// SPARQL supports 'true' and 'false', so we evaluate the $value
-				// and return true/false accordingly.
-				return $value ? 'true' : 'false';
-
-			case Wordlift_Schema_Service::DATA_TYPE_DATE:
-				$date       = date_create_from_format( 'Y/m/d', $value );
-				$date_value = date_format( $date, 'Y-m-d' );
-
-				return sprintf( '"%s"^^xsd:date', self::escape( $date_value ) );
-
-			case Wordlift_Schema_Service::DATA_TYPE_DATE_TIME:
-				$date       = date_create_from_format( 'Y/m/d H:i', $value );
-				$date_value = date_format( $date, 'Y-m-d\TH:i:00' );
-
-				return sprintf( '"%s"^^xsd:dateTime', self::escape( $date_value ) );
-
-			case Wordlift_Schema_Service::DATA_TYPE_DURATION:
-				$time       = date_create_from_format( 'H:i', $value );
-				$time_value = sprintf( 'PT%dH%dM', date_format( $time, 'H' ), intval( date_format( $time, 'i' ) ) );
-
-				return sprintf( '"%s"^^xsd:duration', self::escape( $time_value ) );
-
-			case Wordlift_Schema_Service::DATA_TYPE_DOUBLE:
-				return sprintf( '"%s"^^xsd:double', self::escape( $value ) );
-
-			case Wordlift_Schema_Service::DATA_TYPE_INTEGER:
-				return sprintf( '"%s"^^xsd:integer', self::escape( $value ) );
-
-			case Wordlift_Schema_Service::DATA_TYPE_STRING:
-				return sprintf( '"%s"^^xsd:string', self::escape( $value ) );
-
-			case Wordlift_Schema_Service::DATA_TYPE_URI:
-				/**
-				 * Allow 3rd parties to change the uri.
-				 *
-				 * @since 3.20.0
-				 *
-				 * @see https://github.com/insideout10/wordlift-plugin/issues/850
-				 *
-				 * @param string $uri The uri.
-				 */
-				return sprintf( '<%s>', self::escape_uri( apply_filters( 'wl_production_uri', $value ) ) );
-
-			case null:
-				$language_tag = ( null !== $language ? "@$language" : '' );
-
-				return sprintf( '"%s"%s', self::escape( $value ), $language_tag );
-
-			default:
-
-				self::$log->warn( "Unknown data type [ type :: $type ]" );
-
-				// Try to insert the value anyway.
-				return sprintf( '"%s"', self::escape( $value ) );
-		}
-
-	}
-
-	/**
-	 * Escapes an URI for a SPARQL statement.
-	 *
-	 * @since 3.6.0
-	 *
-	 * @param string $uri The URI to escape.
-	 *
-	 * @return string The escaped URI.
-	 */
-	public static function escape_uri( $uri ) {
-
-		// Should we validate the IRI?
-		// http://www.w3.org/TR/sparql11-query/#QSynIRI
-
-		$uri = str_replace( '<', '\<', $uri );
-		$uri = str_replace( '>', '\>', $uri );
-
-		return $uri;
-	}
-
-	/**
-	 * Escapes a string for a SPARQL statement.
-	 *
-	 * @since 3.6.0
-	 *
-	 * @param string $string The string to escape.
-	 *
-	 * @return string The escaped string.
-	 */
-	public static function escape( $string ) {
-
-		// see http://www.w3.org/TR/rdf-sparql-query/
-		//    '\t'	U+0009 (tab)
-		//    '\n'	U+000A (line feed)
-		//    '\r'	U+000D (carriage return)
-		//    '\b'	U+0008 (backspace)
-		//    '\f'	U+000C (form feed)
-		//    '\"'	U+0022 (quotation mark, double quote mark)
-		//    "\'"	U+0027 (apostrophe-quote, single quote mark)
-		//    '\\'	U+005C (backslash)
-
-		$string = str_replace( '\\', '\\\\', $string );
-		$string = str_replace( '\'', '\\\'', $string );
-		$string = str_replace( '"', '\\"', $string );
-		$string = str_replace( "\f", '\\f', $string );
-		$string = str_replace( "\b", '\\b', $string );
-		$string = str_replace( "\r", '\\r', $string );
-		$string = str_replace( "\n", '\\n', $string );
-		$string = str_replace( "\t", '\\t', $string );
-
-		return $string;
-	}
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.6.0
+     * @access private
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private static $log;
+
+    /**
+     * The {@link Wordlift_Sparql_Service} singleton instance.
+     *
+     * @since  3.6.0
+     * @access private
+     * @var \Wordlift_Sparql_Service $instance The {@link Wordlift_Sparql_Service} singleton instance.
+     */
+    private static $instance;
+
+    /**
+     * Create a {@link Wordlift_Sparql_Service} instance.
+     *
+     * @since 3.6.0
+     */
+    public function __construct() {
+
+        self::$log = Wordlift_Log_Service::get_logger( 'Wordlift_Sparql_Service' );
+
+        self::$instance = $this;
+
+    }
+
+    /**
+     * Get the singleton instance of the {@link Wordlift_Sparql_Service}.
+     *
+     * @since 3.6.0
+     * @return \Wordlift_Sparql_Service
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * Queue a SPARQL statement for execution.
+     *
+     * @since 3.6.0
+     *
+     * @param string $stmt The SPARQL statement.
+     * @param bool   $queue Whether to queue the statement for asynchronous
+     *                      execution.
+     */
+    public function execute( $stmt, $queue = WL_ENABLE_SPARQL_UPDATE_QUERIES_BUFFERING ) {
+
+        rl_execute_sparql_update_query( $stmt, $queue );
+
+    }
+
+    /**
+     * Run the SPARQL queries buffered for the specified request id.
+     *
+     * @since 3.13.2
+     *
+     * @param string $request_id A unique request id.
+     */
+    public function run_sparql_query( $request_id ) {
+
+        self::$log->debug( "Running SPARQL queries..." );
+
+        // Look for a free temporary filename.
+        for ( $index = 1; $index < PHP_INT_MAX; $index ++ ) {
+            $filename = WL_TEMP_DIR . $request_id . "-$index.sparql";
+
+            // Bail out if there are no files left.
+            if ( ! file_exists( $filename ) ) {
+                break;
+            }
+
+            self::$log->debug( "Running SPARQL from $filename..." );
+
+            // Get the query saved in the file.
+            $query = file_get_contents( $filename );
+
+            // Execute the SPARQL query.
+            rl_execute_sparql_update_query( $query, false );
+
+            // Delete the temporary file.
+            unlink( $filename );
+        }
+
+        // Reindex the triple store.
+        wordlift_reindex_triple_store();
+
+    }
+
+    /**
+     * Queue a SPARQL statement for asynchronous execution.
+     *
+     * @since 3.13.2
+     *
+     * @param string $stmt The SPARQL statement.
+     *
+     * @throws Exception
+     */
+    public function queue( $stmt ) {
+
+        // Get a temporary filename.
+        $filename = $this->get_temporary_file_for_sparql();
+
+        self::$log->debug( "Buffering SPARQL to file $filename..." );
+
+        // Write the contents to the temporary filename.
+        @file_put_contents( $filename, $stmt . "\n", FILE_APPEND );
+
+    }
+
+    /**
+     * Get a temporary filename where to store SPARQL queries.
+     *
+     * @since 3.13.2
+     *
+     * @return string The filename.
+     * @throws Exception An exception is thrown if there are already 1.000
+     *                   temporary files for this request.
+     */
+    private function get_temporary_file_for_sparql() {
+
+        // Look for a free temporary filename.
+        for ( $index = 1; $index < PHP_INT_MAX; $index ++ ) {
+            $filename = WL_TEMP_DIR . WL_REQUEST_ID . "-$index.sparql";
+
+            if ( ! file_exists( $filename ) ) {
+
+                // Only if this it the first buffered SPARQL, then launch the
+                // action which will be handled by the Async Task. The Async
+                // Task will take care of all the buffered files _on shutdown_.
+                if ( 1 === $index ) {
+                    do_action( 'wl_run_sparql_query', WL_REQUEST_ID );
+                }
+
+                // Return the temporary filename.
+                return $filename;
+            }
+        }
+
+        throw new Exception( 'Cannot create a temporary file [ ' . WL_TEMP_DIR . WL_REQUEST_ID . ' ].' );
+    }
+
+    /**
+     * Execute the SELECT query.
+     *
+     * @since 3.12.2
+     *
+     * @param string $query The SELECT query to execute.
+     *
+     * @return WP_Error|array The response or WP_Error on failure.
+     */
+    public function select( $query ) {
+
+        // Prepare the SPARQL statement by prepending the default namespaces.
+        $sparql = rl_sparql_prefixes() . "\n" . $query;
+
+        // Get the SPARQL SELECT URL.
+        $url = wl_configuration_get_query_select_url() . urlencode( $sparql );
+
+        $http_options = unserialize( WL_REDLINK_API_HTTP_OPTIONS );
+
+        /**
+         * Filter: 'wl_sparql_select_http_args' - Allow third parties to hook and add additional HTTP args.
+         *
+         * @since 3.17.0
+         *
+         * @param   array $http_options Current http options.
+         */
+        $args = apply_filters( 'wl_sparql_select_http_args', $http_options );
+
+        return wp_remote_get( $url, $args );
+    }
+
+    /**
+     * Formats the provided value according to the specified type in order to
+     * insert the value using SPARQL. The value is also escaped.
+     *
+     * @since 3.6.0
+     *
+     * @param string      $value The value.
+     * @param string      $type The value type.
+     * @param string|null $language The language tag or null if not set.
+     *
+     * @return string The formatted value for SPARQL statements.
+     */
+    public static function format( $value, $type = null, $language = null ) {
+
+        // see https://www.w3.org/TR/sparql11-query/.
+
+        switch ( $type ) {
+
+            case Wordlift_Schema_Service::DATA_TYPE_BOOLEAN:
+                // SPARQL supports 'true' and 'false', so we evaluate the $value
+                // and return true/false accordingly.
+                return $value ? 'true' : 'false';
+
+            case Wordlift_Schema_Service::DATA_TYPE_DATE:
+                $date       = date_create_from_format( 'Y/m/d', $value );
+                $date_value = date_format( $date, 'Y-m-d' );
+
+                return sprintf( '"%s"^^xsd:date', self::escape( $date_value ) );
+
+            case Wordlift_Schema_Service::DATA_TYPE_DATE_TIME:
+                $date       = date_create_from_format( 'Y/m/d H:i', $value );
+                $date_value = date_format( $date, 'Y-m-d\TH:i:00' );
+
+                return sprintf( '"%s"^^xsd:dateTime', self::escape( $date_value ) );
+
+            case Wordlift_Schema_Service::DATA_TYPE_DURATION:
+                $time       = date_create_from_format( 'H:i', $value );
+                $time_value = sprintf( 'PT%dH%dM', date_format( $time, 'H' ), intval( date_format( $time, 'i' ) ) );
+
+                return sprintf( '"%s"^^xsd:duration', self::escape( $time_value ) );
+
+            case Wordlift_Schema_Service::DATA_TYPE_DOUBLE:
+                return sprintf( '"%s"^^xsd:double', self::escape( $value ) );
+
+            case Wordlift_Schema_Service::DATA_TYPE_INTEGER:
+                return sprintf( '"%s"^^xsd:integer', self::escape( $value ) );
+
+            case Wordlift_Schema_Service::DATA_TYPE_STRING:
+                return sprintf( '"%s"^^xsd:string', self::escape( $value ) );
+
+            case Wordlift_Schema_Service::DATA_TYPE_URI:
+                /**
+                 * Allow 3rd parties to change the uri.
+                 *
+                 * @since 3.20.0
+                 *
+                 * @see https://github.com/insideout10/wordlift-plugin/issues/850
+                 *
+                 * @param string $uri The uri.
+                 */
+                return sprintf( '<%s>', self::escape_uri( apply_filters( 'wl_production_uri', $value ) ) );
+
+            case null:
+                $language_tag = ( null !== $language ? "@$language" : '' );
+
+                return sprintf( '"%s"%s', self::escape( $value ), $language_tag );
+
+            default:
+
+                self::$log->warn( "Unknown data type [ type :: $type ]" );
+
+                // Try to insert the value anyway.
+                return sprintf( '"%s"', self::escape( $value ) );
+        }
+
+    }
+
+    /**
+     * Escapes an URI for a SPARQL statement.
+     *
+     * @since 3.6.0
+     *
+     * @param string $uri The URI to escape.
+     *
+     * @return string The escaped URI.
+     */
+    public static function escape_uri( $uri ) {
+
+        // Should we validate the IRI?
+        // http://www.w3.org/TR/sparql11-query/#QSynIRI
+
+        $uri = str_replace( '<', '\<', $uri );
+        $uri = str_replace( '>', '\>', $uri );
+
+        return $uri;
+    }
+
+    /**
+     * Escapes a string for a SPARQL statement.
+     *
+     * @since 3.6.0
+     *
+     * @param string $string The string to escape.
+     *
+     * @return string The escaped string.
+     */
+    public static function escape( $string ) {
+
+        // see http://www.w3.org/TR/rdf-sparql-query/
+        //    '\t'	U+0009 (tab)
+        //    '\n'	U+000A (line feed)
+        //    '\r'	U+000D (carriage return)
+        //    '\b'	U+0008 (backspace)
+        //    '\f'	U+000C (form feed)
+        //    '\"'	U+0022 (quotation mark, double quote mark)
+        //    "\'"	U+0027 (apostrophe-quote, single quote mark)
+        //    '\\'	U+005C (backslash)
+
+        $string = str_replace( '\\', '\\\\', $string );
+        $string = str_replace( '\'', '\\\'', $string );
+        $string = str_replace( '"', '\\"', $string );
+        $string = str_replace( "\f", '\\f', $string );
+        $string = str_replace( "\b", '\\b', $string );
+        $string = str_replace( "\r", '\\r', $string );
+        $string = str_replace( "\n", '\\n', $string );
+        $string = str_replace( "\t", '\\t', $string );
+
+        return $string;
+    }
 
 }

Spacing +58 added lines, -58 removed lines

@@ -43,7 +43,7 @@ 
 	 */
 	public function __construct() {
 
-		self::$log = Wordlift_Log_Service::get_logger( 'Wordlift_Sparql_Service' );
+		self::$log = Wordlift_Log_Service::get_logger('Wordlift_Sparql_Service');
 
 		self::$instance = $this;
 
@@ -69,9 +69,9 @@ 
 	 * @param bool   $queue Whether to queue the statement for asynchronous
 	 *                      execution.
 	 */
-	public function execute( $stmt, $queue = WL_ENABLE_SPARQL_UPDATE_QUERIES_BUFFERING ) {
+	public function execute($stmt, $queue = WL_ENABLE_SPARQL_UPDATE_QUERIES_BUFFERING) {
 
-		rl_execute_sparql_update_query( $stmt, $queue );
+		rl_execute_sparql_update_query($stmt, $queue);
 
 	}
 
@@ -82,29 +82,29 @@ 
 	 *
 	 * @param string $request_id A unique request id.
 	 */
-	public function run_sparql_query( $request_id ) {
+	public function run_sparql_query($request_id) {
 
-		self::$log->debug( "Running SPARQL queries..." );
+		self::$log->debug("Running SPARQL queries...");
 
 		// Look for a free temporary filename.
-		for ( $index = 1; $index < PHP_INT_MAX; $index ++ ) {
-			$filename = WL_TEMP_DIR . $request_id . "-$index.sparql";
+		for ($index = 1; $index < PHP_INT_MAX; $index++) {
+			$filename = WL_TEMP_DIR.$request_id."-$index.sparql";
 
 			// Bail out if there are no files left.
-			if ( ! file_exists( $filename ) ) {
+			if ( ! file_exists($filename)) {
 				break;
 			}
 
-			self::$log->debug( "Running SPARQL from $filename..." );
+			self::$log->debug("Running SPARQL from $filename...");
 
 			// Get the query saved in the file.
-			$query = file_get_contents( $filename );
+			$query = file_get_contents($filename);
 
 			// Execute the SPARQL query.
-			rl_execute_sparql_update_query( $query, false );
+			rl_execute_sparql_update_query($query, false);
 
 			// Delete the temporary file.
-			unlink( $filename );
+			unlink($filename);
 		}
 
 		// Reindex the triple store.
@@ -121,15 +121,15 @@ 
 	 *
 	 * @throws Exception
 	 */
-	public function queue( $stmt ) {
+	public function queue($stmt) {
 
 		// Get a temporary filename.
 		$filename = $this->get_temporary_file_for_sparql();
 
-		self::$log->debug( "Buffering SPARQL to file $filename..." );
+		self::$log->debug("Buffering SPARQL to file $filename...");
 
 		// Write the contents to the temporary filename.
-		@file_put_contents( $filename, $stmt . "\n", FILE_APPEND );
+		@file_put_contents($filename, $stmt."\n", FILE_APPEND);
 
 	}
 
@@ -145,16 +145,16 @@ 
 	private function get_temporary_file_for_sparql() {
 
 		// Look for a free temporary filename.
-		for ( $index = 1; $index < PHP_INT_MAX; $index ++ ) {
-			$filename = WL_TEMP_DIR . WL_REQUEST_ID . "-$index.sparql";
+		for ($index = 1; $index < PHP_INT_MAX; $index++) {
+			$filename = WL_TEMP_DIR.WL_REQUEST_ID."-$index.sparql";
 
-			if ( ! file_exists( $filename ) ) {
+			if ( ! file_exists($filename)) {
 
 				// Only if this it the first buffered SPARQL, then launch the
 				// action which will be handled by the Async Task. The Async
 				// Task will take care of all the buffered files _on shutdown_.
-				if ( 1 === $index ) {
-					do_action( 'wl_run_sparql_query', WL_REQUEST_ID );
+				if (1 === $index) {
+					do_action('wl_run_sparql_query', WL_REQUEST_ID);
 				}
 
 				// Return the temporary filename.
@@ -162,7 +162,7 @@ 
 			}
 		}
 
-		throw new Exception( 'Cannot create a temporary file [ ' . WL_TEMP_DIR . WL_REQUEST_ID . ' ].' );
+		throw new Exception('Cannot create a temporary file [ '.WL_TEMP_DIR.WL_REQUEST_ID.' ].');
 	}
 
 	/**
@@ -174,15 +174,15 @@ 
 	 *
 	 * @return WP_Error|array The response or WP_Error on failure.
 	 */
-	public function select( $query ) {
+	public function select($query) {
 
 		// Prepare the SPARQL statement by prepending the default namespaces.
-		$sparql = rl_sparql_prefixes() . "\n" . $query;
+		$sparql = rl_sparql_prefixes()."\n".$query;
 
 		// Get the SPARQL SELECT URL.
-		$url = wl_configuration_get_query_select_url() . urlencode( $sparql );
+		$url = wl_configuration_get_query_select_url().urlencode($sparql);
 
-		$http_options = unserialize( WL_REDLINK_API_HTTP_OPTIONS );
+		$http_options = unserialize(WL_REDLINK_API_HTTP_OPTIONS);
 
 		/**
 		 * Filter: 'wl_sparql_select_http_args' - Allow third parties to hook and add additional HTTP args.
@@ -191,9 +191,9 @@ 
 		 *
 		 * @param   array $http_options Current http options.
 		 */
-		$args = apply_filters( 'wl_sparql_select_http_args', $http_options );
+		$args = apply_filters('wl_sparql_select_http_args', $http_options);
 
-		return wp_remote_get( $url, $args );
+		return wp_remote_get($url, $args);
 	}
 
 	/**
@@ -208,11 +208,11 @@ 
 	 *
 	 * @return string The formatted value for SPARQL statements.
 	 */
-	public static function format( $value, $type = null, $language = null ) {
+	public static function format($value, $type = null, $language = null) {
 
 		// see https://www.w3.org/TR/sparql11-query/.
 
-		switch ( $type ) {
+		switch ($type) {
 
 			case Wordlift_Schema_Service::DATA_TYPE_BOOLEAN:
 				// SPARQL supports 'true' and 'false', so we evaluate the $value
@@ -220,31 +220,31 @@ 
 				return $value ? 'true' : 'false';
 
 			case Wordlift_Schema_Service::DATA_TYPE_DATE:
-				$date       = date_create_from_format( 'Y/m/d', $value );
-				$date_value = date_format( $date, 'Y-m-d' );
+				$date       = date_create_from_format('Y/m/d', $value);
+				$date_value = date_format($date, 'Y-m-d');
 
-				return sprintf( '"%s"^^xsd:date', self::escape( $date_value ) );
+				return sprintf('"%s"^^xsd:date', self::escape($date_value));
 
 			case Wordlift_Schema_Service::DATA_TYPE_DATE_TIME:
-				$date       = date_create_from_format( 'Y/m/d H:i', $value );
-				$date_value = date_format( $date, 'Y-m-d\TH:i:00' );
+				$date       = date_create_from_format('Y/m/d H:i', $value);
+				$date_value = date_format($date, 'Y-m-d\TH:i:00');
 
-				return sprintf( '"%s"^^xsd:dateTime', self::escape( $date_value ) );
+				return sprintf('"%s"^^xsd:dateTime', self::escape($date_value));
 
 			case Wordlift_Schema_Service::DATA_TYPE_DURATION:
-				$time       = date_create_from_format( 'H:i', $value );
-				$time_value = sprintf( 'PT%dH%dM', date_format( $time, 'H' ), intval( date_format( $time, 'i' ) ) );
+				$time       = date_create_from_format('H:i', $value);
+				$time_value = sprintf('PT%dH%dM', date_format($time, 'H'), intval(date_format($time, 'i')));
 
-				return sprintf( '"%s"^^xsd:duration', self::escape( $time_value ) );
+				return sprintf('"%s"^^xsd:duration', self::escape($time_value));
 
 			case Wordlift_Schema_Service::DATA_TYPE_DOUBLE:
-				return sprintf( '"%s"^^xsd:double', self::escape( $value ) );
+				return sprintf('"%s"^^xsd:double', self::escape($value));
 
 			case Wordlift_Schema_Service::DATA_TYPE_INTEGER:
-				return sprintf( '"%s"^^xsd:integer', self::escape( $value ) );
+				return sprintf('"%s"^^xsd:integer', self::escape($value));
 
 			case Wordlift_Schema_Service::DATA_TYPE_STRING:
-				return sprintf( '"%s"^^xsd:string', self::escape( $value ) );
+				return sprintf('"%s"^^xsd:string', self::escape($value));
 
 			case Wordlift_Schema_Service::DATA_TYPE_URI:
 				/**
@@ -256,19 +256,19 @@ 
 				 *
 				 * @param string $uri The uri.
 				 */
-				return sprintf( '<%s>', self::escape_uri( apply_filters( 'wl_production_uri', $value ) ) );
+				return sprintf('<%s>', self::escape_uri(apply_filters('wl_production_uri', $value)));
 
 			case null:
-				$language_tag = ( null !== $language ? "@$language" : '' );
+				$language_tag = (null !== $language ? "@$language" : '');
 
-				return sprintf( '"%s"%s', self::escape( $value ), $language_tag );
+				return sprintf('"%s"%s', self::escape($value), $language_tag);
 
 			default:
 
-				self::$log->warn( "Unknown data type [ type :: $type ]" );
+				self::$log->warn("Unknown data type [ type :: $type ]");
 
 				// Try to insert the value anyway.
-				return sprintf( '"%s"', self::escape( $value ) );
+				return sprintf('"%s"', self::escape($value));
 		}
 
 	}
@@ -282,13 +282,13 @@ 
 	 *
 	 * @return string The escaped URI.
 	 */
-	public static function escape_uri( $uri ) {
+	public static function escape_uri($uri) {
 
 		// Should we validate the IRI?
 		// http://www.w3.org/TR/sparql11-query/#QSynIRI
 
-		$uri = str_replace( '<', '\<', $uri );
-		$uri = str_replace( '>', '\>', $uri );
+		$uri = str_replace('<', '\<', $uri);
+		$uri = str_replace('>', '\>', $uri);
 
 		return $uri;
 	}
@@ -302,7 +302,7 @@ 
 	 *
 	 * @return string The escaped string.
 	 */
-	public static function escape( $string ) {
+	public static function escape($string) {
 
 		// see http://www.w3.org/TR/rdf-sparql-query/
 		//    '\t'	U+0009 (tab)
@@ -314,14 +314,14 @@ 
 		//    "\'"	U+0027 (apostrophe-quote, single quote mark)
 		//    '\\'	U+005C (backslash)
 
-		$string = str_replace( '\\', '\\\\', $string );
-		$string = str_replace( '\'', '\\\'', $string );
-		$string = str_replace( '"', '\\"', $string );
-		$string = str_replace( "\f", '\\f', $string );
-		$string = str_replace( "\b", '\\b', $string );
-		$string = str_replace( "\r", '\\r', $string );
-		$string = str_replace( "\n", '\\n', $string );
-		$string = str_replace( "\t", '\\t', $string );
+		$string = str_replace('\\', '\\\\', $string);
+		$string = str_replace('\'', '\\\'', $string);
+		$string = str_replace('"', '\\"', $string);
+		$string = str_replace("\f", '\\f', $string);
+		$string = str_replace("\b", '\\b', $string);
+		$string = str_replace("\r", '\\r', $string);
+		$string = str_replace("\n", '\\n', $string);
+		$string = str_replace("\t", '\\t', $string);
 
 		return $string;
 	}

src/includes/class-wordlift-tinymce-adapter.php

Indentation +41 added lines, -41 removed lines

@@ -14,55 +14,55 @@
  */
 class Wordlift_Tinymce_Adapter {
 
-	/**
-	 * The {@link Wordlift} plugin instance.
-	 *
-	 * @since  3.12.0
-	 * @access private
-	 * @var \Wordlift $plugin The {@link Wordlift} plugin instance.
-	 */
-	private $plugin;
+    /**
+     * The {@link Wordlift} plugin instance.
+     *
+     * @since  3.12.0
+     * @access private
+     * @var \Wordlift $plugin The {@link Wordlift} plugin instance.
+     */
+    private $plugin;
 
-	/**
-	 * Wordlift_Tinymce_Adapter constructor.
-	 *
-	 * @param \Wordlift $plugin The {@link Wordlift} plugin instance.
-	 */
-	public function __construct( $plugin ) {
+    /**
+     * Wordlift_Tinymce_Adapter constructor.
+     *
+     * @param \Wordlift $plugin The {@link Wordlift} plugin instance.
+     */
+    public function __construct( $plugin ) {
 
-		$this->plugin = $plugin;
+        $this->plugin = $plugin;
 
-	}
+    }
 
-	/**
-	 * Load the TinyMCE plugin. This method is called by the WP mce_external_plugins hook.
-	 *
-	 * @since 3.12.0
-	 *
-	 * @param array $plugins The existing plugins array.
-	 *
-	 * @return array The modified plugins array.
-	 */
-	function mce_external_plugins( $plugins ) {
+    /**
+     * Load the TinyMCE plugin. This method is called by the WP mce_external_plugins hook.
+     *
+     * @since 3.12.0
+     *
+     * @param array $plugins The existing plugins array.
+     *
+     * @return array The modified plugins array.
+     */
+    function mce_external_plugins( $plugins ) {
 
-		// Get WordLift's version as a cache killer.
-		$version = $this->plugin->get_version();
+        // Get WordLift's version as a cache killer.
+        $version = $this->plugin->get_version();
 
-		// User can edit?
-		$can_edit = current_user_can( 'edit_posts' ) || current_user_can( 'edit_pages' );
+        // User can edit?
+        $can_edit = current_user_can( 'edit_posts' ) || current_user_can( 'edit_pages' );
 
-		// If user can't edit or rich editing isn't enabled, bail out.
-		if ( ! $can_edit || ! get_user_option( 'rich_editing' ) ) {
-			return $plugins;
-		}
+        // If user can't edit or rich editing isn't enabled, bail out.
+        if ( ! $can_edit || ! get_user_option( 'rich_editing' ) ) {
+            return $plugins;
+        }
 
-		// Add our own JavaScript file to TinyMCE's extensions.
-		// DO NOT use the minified version, it'll yield errors with AngularJS.
-		$plugins['wordlift']      = plugin_dir_url( dirname( __FILE__ ) ) . 'js/wordlift-reloaded.js?ver=' . $version;
-		$plugins['wl_shortcodes'] = plugin_dir_url( dirname( __FILE__ ) ) . 'admin/js/wordlift_shortcode_tinymce_plugin.js?ver=' . $version;
-		$plugins['wl_tinymce']    = plugin_dir_url( dirname( __FILE__ ) ) . 'admin/js/1/tinymce.js?ver=' . $version;
+        // Add our own JavaScript file to TinyMCE's extensions.
+        // DO NOT use the minified version, it'll yield errors with AngularJS.
+        $plugins['wordlift']      = plugin_dir_url( dirname( __FILE__ ) ) . 'js/wordlift-reloaded.js?ver=' . $version;
+        $plugins['wl_shortcodes'] = plugin_dir_url( dirname( __FILE__ ) ) . 'admin/js/wordlift_shortcode_tinymce_plugin.js?ver=' . $version;
+        $plugins['wl_tinymce']    = plugin_dir_url( dirname( __FILE__ ) ) . 'admin/js/1/tinymce.js?ver=' . $version;
 
-		return $plugins;
-	}
+        return $plugins;
+    }
 
 }

Spacing +7 added lines, -7 removed lines

@@ -28,7 +28,7 @@ 
 	 *
 	 * @param \Wordlift $plugin The {@link Wordlift} plugin instance.
 	 */
-	public function __construct( $plugin ) {
+	public function __construct($plugin) {
 
 		$this->plugin = $plugin;
 
@@ -43,24 +43,24 @@ 
 	 *
 	 * @return array The modified plugins array.
 	 */
-	function mce_external_plugins( $plugins ) {
+	function mce_external_plugins($plugins) {
 
 		// Get WordLift's version as a cache killer.
 		$version = $this->plugin->get_version();
 
 		// User can edit?
-		$can_edit = current_user_can( 'edit_posts' ) || current_user_can( 'edit_pages' );
+		$can_edit = current_user_can('edit_posts') || current_user_can('edit_pages');
 
 		// If user can't edit or rich editing isn't enabled, bail out.
-		if ( ! $can_edit || ! get_user_option( 'rich_editing' ) ) {
+		if ( ! $can_edit || ! get_user_option('rich_editing')) {
 			return $plugins;
 		}
 
 		// Add our own JavaScript file to TinyMCE's extensions.
 		// DO NOT use the minified version, it'll yield errors with AngularJS.
-		$plugins['wordlift']      = plugin_dir_url( dirname( __FILE__ ) ) . 'js/wordlift-reloaded.js?ver=' . $version;
-		$plugins['wl_shortcodes'] = plugin_dir_url( dirname( __FILE__ ) ) . 'admin/js/wordlift_shortcode_tinymce_plugin.js?ver=' . $version;
-		$plugins['wl_tinymce']    = plugin_dir_url( dirname( __FILE__ ) ) . 'admin/js/1/tinymce.js?ver=' . $version;
+		$plugins['wordlift']      = plugin_dir_url(dirname(__FILE__)).'js/wordlift-reloaded.js?ver='.$version;
+		$plugins['wl_shortcodes'] = plugin_dir_url(dirname(__FILE__)).'admin/js/wordlift_shortcode_tinymce_plugin.js?ver='.$version;
+		$plugins['wl_tinymce']    = plugin_dir_url(dirname(__FILE__)).'admin/js/1/tinymce.js?ver='.$version;
 
 		return $plugins;
 	}