insideout10 / wordlift-plugin

src/modules/core/wordlift_core_install.php

Indentation +171 added lines, -171 removed lines

@@ -11,99 +11,99 @@ 
  */
 function wl_core_install_entity_type_data() {
 
-	Wordlift_Log_Service::get_instance()->debug('Installing Entity Type data...');
-
-	// Ensure the custom type and the taxonomy are registered.
-	Wordlift_Entity_Post_Type_Service::get_instance()->register();
-
-	wl_entity_type_taxonomy_register();
-
-	// Ensure the custom taxonomy for dbpedia topics is registered
-	Wordlift_Topic_Taxonomy_Service::get_instance()->init();
-
-	// Set the taxonomy data.
-	// Note: parent types must be defined before child types.
-	$terms = array(
-		'thing'         => array(
-			'label'       => 'Thing',
-			'description' => 'A generic thing (something that doesn\'t fit in the previous definitions.',
-		),
-		'creative-work' => array(
-			'label'       => 'CreativeWork',
-			'description' => 'A creative work (or a Music Album).',
-		),
-		'event'         => array(
-			'label'       => 'Event',
-			'description' => 'An event.',
-		),
-		'organization'  => array(
-			'label'       => 'Organization',
-			'description' => 'An organization, including a government or a newspaper.',
-		),
-		'person'        => array(
-			'label'       => 'Person',
-			'description' => 'A person (or a music artist).',
-		),
-		'place'         => array(
-			'label'       => 'Place',
-			'description' => 'A place.',
-		),
-		'localbusiness' => array(
-			'label'       => 'LocalBusiness',
-			'description' => 'A local business.',
-		),
-	);
-
-	foreach ( $terms as $slug => $term ) {
-
-		// Create the term if it does not exist, then get its ID
-		$term_id = term_exists( $slug, Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME );
-
-		if ( 0 == $term_id || is_null( $term_id ) ) {
-			$result = wp_insert_term( $slug, Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME );
-		} else {
-			$term_id = $term_id['term_id'];
-			$result  = get_term( $term_id, Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME, ARRAY_A );
-		}
-
-		// Check for errors.
-		if ( is_wp_error( $result ) ) {
-			wl_write_log( 'wl_install_entity_type_data [ ' . $result->get_error_message() . ' ]' );
-			continue;
-		}
-
-		// Check if 'parent' corresponds to an actual term and get its ID.
-		if ( ! isset( $term['parents'] ) ) {
-			$term['parents'] = array();
-		}
-
-		$parent_ids = array();
-		foreach ( $term['parents'] as $parent_slug ) {
-			$parent_id    = get_term_by( 'slug', $parent_slug, Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME );
-			$parent_ids[] = intval( $parent_id->term_id );  // Note: int casting is suggested by Codex: http://codex.wordpress.org/Function_Reference/get_term_by
-		}
-
-		// Define a parent in the WP taxonomy style (not important for WL)
-		if ( empty( $parent_ids ) ) {
-			// No parent
-			$parent_id = 0;
-		} else {
-			// Get first parent
-			$parent_id = $parent_ids[0];
-		}
-
-		// Update term with description, slug and parent
-		wp_update_term( $result['term_id'], Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME, array(
-			'name'        => $term['label'],
-			'slug'        => $slug,
-			'description' => $term['description'],
-			// We give to WP taxonomy just one parent. TODO: see if can give more than one
-			'parent'      => $parent_id,
-		) );
-
-	}
-
-	Wordlift_Log_Service::get_instance()->debug('Entity Type data installed.');
+    Wordlift_Log_Service::get_instance()->debug('Installing Entity Type data...');
+
+    // Ensure the custom type and the taxonomy are registered.
+    Wordlift_Entity_Post_Type_Service::get_instance()->register();
+
+    wl_entity_type_taxonomy_register();
+
+    // Ensure the custom taxonomy for dbpedia topics is registered
+    Wordlift_Topic_Taxonomy_Service::get_instance()->init();
+
+    // Set the taxonomy data.
+    // Note: parent types must be defined before child types.
+    $terms = array(
+        'thing'         => array(
+            'label'       => 'Thing',
+            'description' => 'A generic thing (something that doesn\'t fit in the previous definitions.',
+        ),
+        'creative-work' => array(
+            'label'       => 'CreativeWork',
+            'description' => 'A creative work (or a Music Album).',
+        ),
+        'event'         => array(
+            'label'       => 'Event',
+            'description' => 'An event.',
+        ),
+        'organization'  => array(
+            'label'       => 'Organization',
+            'description' => 'An organization, including a government or a newspaper.',
+        ),
+        'person'        => array(
+            'label'       => 'Person',
+            'description' => 'A person (or a music artist).',
+        ),
+        'place'         => array(
+            'label'       => 'Place',
+            'description' => 'A place.',
+        ),
+        'localbusiness' => array(
+            'label'       => 'LocalBusiness',
+            'description' => 'A local business.',
+        ),
+    );
+
+    foreach ( $terms as $slug => $term ) {
+
+        // Create the term if it does not exist, then get its ID
+        $term_id = term_exists( $slug, Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME );
+
+        if ( 0 == $term_id || is_null( $term_id ) ) {
+            $result = wp_insert_term( $slug, Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME );
+        } else {
+            $term_id = $term_id['term_id'];
+            $result  = get_term( $term_id, Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME, ARRAY_A );
+        }
+
+        // Check for errors.
+        if ( is_wp_error( $result ) ) {
+            wl_write_log( 'wl_install_entity_type_data [ ' . $result->get_error_message() . ' ]' );
+            continue;
+        }
+
+        // Check if 'parent' corresponds to an actual term and get its ID.
+        if ( ! isset( $term['parents'] ) ) {
+            $term['parents'] = array();
+        }
+
+        $parent_ids = array();
+        foreach ( $term['parents'] as $parent_slug ) {
+            $parent_id    = get_term_by( 'slug', $parent_slug, Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME );
+            $parent_ids[] = intval( $parent_id->term_id );  // Note: int casting is suggested by Codex: http://codex.wordpress.org/Function_Reference/get_term_by
+        }
+
+        // Define a parent in the WP taxonomy style (not important for WL)
+        if ( empty( $parent_ids ) ) {
+            // No parent
+            $parent_id = 0;
+        } else {
+            // Get first parent
+            $parent_id = $parent_ids[0];
+        }
+
+        // Update term with description, slug and parent
+        wp_update_term( $result['term_id'], Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME, array(
+            'name'        => $term['label'],
+            'slug'        => $slug,
+            'description' => $term['description'],
+            // We give to WP taxonomy just one parent. TODO: see if can give more than one
+            'parent'      => $parent_id,
+        ) );
+
+    }
+
+    Wordlift_Log_Service::get_instance()->debug('Entity Type data installed.');
 
 }
 
@@ -112,16 +112,16 @@ 
  */
 function wl_core_install_create_relation_instance_table() {
 
-	global $wpdb;
-	// global $wl_db_version;
-	$installed_version = get_option( 'wl_db_version' );
+    global $wpdb;
+    // global $wl_db_version;
+    $installed_version = get_option( 'wl_db_version' );
 
-	if ( WL_DB_VERSION != $installed_version ) {
-		$table_name      = $wpdb->prefix . WL_DB_RELATION_INSTANCES_TABLE_NAME;
-		$charset_collate = $wpdb->get_charset_collate();
+    if ( WL_DB_VERSION != $installed_version ) {
+        $table_name      = $wpdb->prefix . WL_DB_RELATION_INSTANCES_TABLE_NAME;
+        $charset_collate = $wpdb->get_charset_collate();
 
-		// Sql statement for the relation instances custom table
-		$sql = <<<EOF
+        // Sql statement for the relation instances custom table
+        $sql = <<<EOF
 			CREATE TABLE $table_name (
   				id int(11) NOT NULL AUTO_INCREMENT,
   				subject_id int(11) NOT NULL,
@@ -133,14 +133,14 @@ 
 			) $charset_collate;
 EOF;
 
-		// @see: https://codex.wordpress.org/Creating_Tables_with_Plugins
-		require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
-		$results = dbDelta( $sql );
+        // @see: https://codex.wordpress.org/Creating_Tables_with_Plugins
+        require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
+        $results = dbDelta( $sql );
 
-		wl_write_log( $results );
+        wl_write_log( $results );
 
-		update_option( 'wl_db_version', WL_DB_VERSION );
-	}
+        update_option( 'wl_db_version', WL_DB_VERSION );
+    }
 }
 
 /**
@@ -151,9 +151,9 @@ 
  */
 function wl_core_upgrade_db_to_1_0() {
 
-	if ( ! get_option( 'wl_db_version' ) ) {
-		wl_core_install_create_relation_instance_table();
-	}
+    if ( ! get_option( 'wl_db_version' ) ) {
+        wl_core_install_create_relation_instance_table();
+    }
 
 }
 
@@ -166,31 +166,31 @@ 
  */
 function wl_core_upgrade_db_1_0_to_3_10() {
 
-	// If the DB version is less than 3.10, than flatten the txonomy.
-	if ( version_compare( get_option( 'wl_db_version' ), '3.9', '<=' ) ) {
+    // If the DB version is less than 3.10, than flatten the txonomy.
+    if ( version_compare( get_option( 'wl_db_version' ), '3.9', '<=' ) ) {
 
-		$term_slugs = array(
-			'thing',
-			'creative-work',
-			'event',
-			'organization',
-			'person',
-			'place',
-			'localbusiness',
-		);
+        $term_slugs = array(
+            'thing',
+            'creative-work',
+            'event',
+            'organization',
+            'person',
+            'place',
+            'localbusiness',
+        );
 
-		foreach ( $term_slugs as $slug ) {
+        foreach ( $term_slugs as $slug ) {
 
-			$term = get_term_by( 'slug', $slug, Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME );
+            $term = get_term_by( 'slug', $slug, Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME );
 
-			// Set the term's parent to 0.
-			if ( $term ) {
-				wp_update_term( $term->term_id, Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME, array(
-					'parent' => 0,
-				) );
-			}
-		}
-	}
+            // Set the term's parent to 0.
+            if ( $term ) {
+                wp_update_term( $term->term_id, Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME, array(
+                    'parent' => 0,
+                ) );
+            }
+        }
+    }
 
 }
 
@@ -203,14 +203,14 @@ 
  * @since 3.12.0
  */
 function wl_core_upgrade_db_3_10_3_12() {
-	/*
+    /*
 	 * As this upgrade functionality runs on the init hook, and the AMP plugin
 	 * initialization does the same, avoid possible race conditions by
 	 * deferring the actual flush to a later hook.
 	 */
-	add_action( 'wp_loaded', function () {
-		flush_rewrite_rules();
-	} );
+    add_action( 'wp_loaded', function () {
+        flush_rewrite_rules();
+    } );
 }
 
 /**
@@ -221,51 +221,51 @@ 
  * @since 3.14.0
  */
 function wl_core_upgrade_db_3_12_3_14() {
-	$result = wp_insert_term(
-		'Recipe',
-		Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME,
-		array(
-			'slug'        => 'recipe',
-			'description' => 'A Recipe.',
-		)
-	);
-
-	// Assign capabilities to manipulate entities to admins.
-	$admins = get_role( 'administrator' );
-
-	$admins->add_cap( 'edit_wordlift_entity' );
-	$admins->add_cap( 'edit_wordlift_entities' );
-	$admins->add_cap( 'edit_others_wordlift_entities' );
-	$admins->add_cap( 'publish_wordlift_entities' );
-	$admins->add_cap( 'read_private_wordlift_entities' );
-	$admins->add_cap( 'delete_wordlift_entity' );
-
-	// Assign capabilities to manipulate entities to editors.
-	$editors = get_role( 'editor' );
-
-	$editors->add_cap( 'edit_wordlift_entity' );
-	$editors->add_cap( 'edit_wordlift_entities' );
-	$editors->add_cap( 'edit_others_wordlift_entities' );
-	$editors->add_cap( 'publish_wordlift_entities' );
-	$editors->add_cap( 'read_private_wordlift_entities' );
-	$editors->add_cap( 'delete_wordlift_entity' );
+    $result = wp_insert_term(
+        'Recipe',
+        Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME,
+        array(
+            'slug'        => 'recipe',
+            'description' => 'A Recipe.',
+        )
+    );
+
+    // Assign capabilities to manipulate entities to admins.
+    $admins = get_role( 'administrator' );
+
+    $admins->add_cap( 'edit_wordlift_entity' );
+    $admins->add_cap( 'edit_wordlift_entities' );
+    $admins->add_cap( 'edit_others_wordlift_entities' );
+    $admins->add_cap( 'publish_wordlift_entities' );
+    $admins->add_cap( 'read_private_wordlift_entities' );
+    $admins->add_cap( 'delete_wordlift_entity' );
+
+    // Assign capabilities to manipulate entities to editors.
+    $editors = get_role( 'editor' );
+
+    $editors->add_cap( 'edit_wordlift_entity' );
+    $editors->add_cap( 'edit_wordlift_entities' );
+    $editors->add_cap( 'edit_others_wordlift_entities' );
+    $editors->add_cap( 'publish_wordlift_entities' );
+    $editors->add_cap( 'read_private_wordlift_entities' );
+    $editors->add_cap( 'delete_wordlift_entity' );
 
 }
 
 // Check db status on automated plugins updates
 function wl_core_update_db_check() {
 
-	wl_core_install_entity_type_data();
+    wl_core_install_entity_type_data();
 
-	if ( get_option( 'wl_db_version' ) != WL_DB_VERSION ) {
+    if ( get_option( 'wl_db_version' ) != WL_DB_VERSION ) {
 
-		wl_core_upgrade_db_to_1_0();
-		wl_core_upgrade_db_1_0_to_3_10();
-		wl_core_upgrade_db_3_10_3_12();
-		wl_core_upgrade_db_3_12_3_14();
-		update_option( 'wl_db_version', WL_DB_VERSION );
+        wl_core_upgrade_db_to_1_0();
+        wl_core_upgrade_db_1_0_to_3_10();
+        wl_core_upgrade_db_3_10_3_12();
+        wl_core_upgrade_db_3_12_3_14();
+        update_option( 'wl_db_version', WL_DB_VERSION );
 
-	}
+    }
 
 }
 

Spacing +46 added lines, -46 removed lines

@@ -54,37 +54,37 @@ 
 		),
 	);
 
-	foreach ( $terms as $slug => $term ) {
+	foreach ($terms as $slug => $term) {
 
 		// Create the term if it does not exist, then get its ID
-		$term_id = term_exists( $slug, Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME );
+		$term_id = term_exists($slug, Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME);
 
-		if ( 0 == $term_id || is_null( $term_id ) ) {
-			$result = wp_insert_term( $slug, Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME );
+		if (0 == $term_id || is_null($term_id)) {
+			$result = wp_insert_term($slug, Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME);
 		} else {
 			$term_id = $term_id['term_id'];
-			$result  = get_term( $term_id, Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME, ARRAY_A );
+			$result  = get_term($term_id, Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME, ARRAY_A);
 		}
 
 		// Check for errors.
-		if ( is_wp_error( $result ) ) {
-			wl_write_log( 'wl_install_entity_type_data [ ' . $result->get_error_message() . ' ]' );
+		if (is_wp_error($result)) {
+			wl_write_log('wl_install_entity_type_data [ '.$result->get_error_message().' ]');
 			continue;
 		}
 
 		// Check if 'parent' corresponds to an actual term and get its ID.
-		if ( ! isset( $term['parents'] ) ) {
+		if ( ! isset($term['parents'])) {
 			$term['parents'] = array();
 		}
 
 		$parent_ids = array();
-		foreach ( $term['parents'] as $parent_slug ) {
-			$parent_id    = get_term_by( 'slug', $parent_slug, Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME );
-			$parent_ids[] = intval( $parent_id->term_id );  // Note: int casting is suggested by Codex: http://codex.wordpress.org/Function_Reference/get_term_by
+		foreach ($term['parents'] as $parent_slug) {
+			$parent_id    = get_term_by('slug', $parent_slug, Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME);
+			$parent_ids[] = intval($parent_id->term_id); // Note: int casting is suggested by Codex: http://codex.wordpress.org/Function_Reference/get_term_by
 		}
 
 		// Define a parent in the WP taxonomy style (not important for WL)
-		if ( empty( $parent_ids ) ) {
+		if (empty($parent_ids)) {
 			// No parent
 			$parent_id = 0;
 		} else {
@@ -93,13 +93,13 @@ 
 		}
 
 		// Update term with description, slug and parent
-		wp_update_term( $result['term_id'], Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME, array(
+		wp_update_term($result['term_id'], Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME, array(
 			'name'        => $term['label'],
 			'slug'        => $slug,
 			'description' => $term['description'],
 			// We give to WP taxonomy just one parent. TODO: see if can give more than one
 			'parent'      => $parent_id,
-		) );
+		));
 
 	}
 
@@ -114,10 +114,10 @@ 
 
 	global $wpdb;
 	// global $wl_db_version;
-	$installed_version = get_option( 'wl_db_version' );
+	$installed_version = get_option('wl_db_version');
 
-	if ( WL_DB_VERSION != $installed_version ) {
-		$table_name      = $wpdb->prefix . WL_DB_RELATION_INSTANCES_TABLE_NAME;
+	if (WL_DB_VERSION != $installed_version) {
+		$table_name      = $wpdb->prefix.WL_DB_RELATION_INSTANCES_TABLE_NAME;
 		$charset_collate = $wpdb->get_charset_collate();
 
 		// Sql statement for the relation instances custom table
@@ -134,12 +134,12 @@ 
 EOF;
 
 		// @see: https://codex.wordpress.org/Creating_Tables_with_Plugins
-		require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
-		$results = dbDelta( $sql );
+		require_once(ABSPATH.'wp-admin/includes/upgrade.php');
+		$results = dbDelta($sql);
 
-		wl_write_log( $results );
+		wl_write_log($results);
 
-		update_option( 'wl_db_version', WL_DB_VERSION );
+		update_option('wl_db_version', WL_DB_VERSION);
 	}
 }
 
@@ -151,7 +151,7 @@ 
  */
 function wl_core_upgrade_db_to_1_0() {
 
-	if ( ! get_option( 'wl_db_version' ) ) {
+	if ( ! get_option('wl_db_version')) {
 		wl_core_install_create_relation_instance_table();
 	}
 
@@ -167,7 +167,7 @@ 
 function wl_core_upgrade_db_1_0_to_3_10() {
 
 	// If the DB version is less than 3.10, than flatten the txonomy.
-	if ( version_compare( get_option( 'wl_db_version' ), '3.9', '<=' ) ) {
+	if (version_compare(get_option('wl_db_version'), '3.9', '<=')) {
 
 		$term_slugs = array(
 			'thing',
@@ -179,15 +179,15 @@ 
 			'localbusiness',
 		);
 
-		foreach ( $term_slugs as $slug ) {
+		foreach ($term_slugs as $slug) {
 
-			$term = get_term_by( 'slug', $slug, Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME );
+			$term = get_term_by('slug', $slug, Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME);
 
 			// Set the term's parent to 0.
-			if ( $term ) {
-				wp_update_term( $term->term_id, Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME, array(
+			if ($term) {
+				wp_update_term($term->term_id, Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME, array(
 					'parent' => 0,
-				) );
+				));
 			}
 		}
 	}
@@ -208,7 +208,7 @@ 
 	 * initialization does the same, avoid possible race conditions by
 	 * deferring the actual flush to a later hook.
 	 */
-	add_action( 'wp_loaded', function () {
+	add_action('wp_loaded', function() {
 		flush_rewrite_rules();
 	} );
 }
@@ -231,24 +231,24 @@ 
 	);
 
 	// Assign capabilities to manipulate entities to admins.
-	$admins = get_role( 'administrator' );
+	$admins = get_role('administrator');
 
-	$admins->add_cap( 'edit_wordlift_entity' );
-	$admins->add_cap( 'edit_wordlift_entities' );
-	$admins->add_cap( 'edit_others_wordlift_entities' );
-	$admins->add_cap( 'publish_wordlift_entities' );
-	$admins->add_cap( 'read_private_wordlift_entities' );
-	$admins->add_cap( 'delete_wordlift_entity' );
+	$admins->add_cap('edit_wordlift_entity');
+	$admins->add_cap('edit_wordlift_entities');
+	$admins->add_cap('edit_others_wordlift_entities');
+	$admins->add_cap('publish_wordlift_entities');
+	$admins->add_cap('read_private_wordlift_entities');
+	$admins->add_cap('delete_wordlift_entity');
 
 	// Assign capabilities to manipulate entities to editors.
-	$editors = get_role( 'editor' );
+	$editors = get_role('editor');
 
-	$editors->add_cap( 'edit_wordlift_entity' );
-	$editors->add_cap( 'edit_wordlift_entities' );
-	$editors->add_cap( 'edit_others_wordlift_entities' );
-	$editors->add_cap( 'publish_wordlift_entities' );
-	$editors->add_cap( 'read_private_wordlift_entities' );
-	$editors->add_cap( 'delete_wordlift_entity' );
+	$editors->add_cap('edit_wordlift_entity');
+	$editors->add_cap('edit_wordlift_entities');
+	$editors->add_cap('edit_others_wordlift_entities');
+	$editors->add_cap('publish_wordlift_entities');
+	$editors->add_cap('read_private_wordlift_entities');
+	$editors->add_cap('delete_wordlift_entity');
 
 }
 
@@ -257,16 +257,16 @@ 
 
 	wl_core_install_entity_type_data();
 
-	if ( get_option( 'wl_db_version' ) != WL_DB_VERSION ) {
+	if (get_option('wl_db_version') != WL_DB_VERSION) {
 
 		wl_core_upgrade_db_to_1_0();
 		wl_core_upgrade_db_1_0_to_3_10();
 		wl_core_upgrade_db_3_10_3_12();
 		wl_core_upgrade_db_3_12_3_14();
-		update_option( 'wl_db_version', WL_DB_VERSION );
+		update_option('wl_db_version', WL_DB_VERSION);
 
 	}
 
 }
 
-add_action( 'init', 'wl_core_update_db_check', 11 ); // need taxonomies and post type to be defined first
+add_action('init', 'wl_core_update_db_check', 11); // need taxonomies and post type to be defined first

src/admin/class-wordlift-entity-type-settings.php

Indentation +188 added lines, -188 removed lines

@@ -13,7 +13,7 @@ 
  */
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -30,208 +30,208 @@ 
  */
 class Wordlift_Admin_Entity_Type_Settings {
 
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.14.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * Create a {@link Wordlift_Admin_Entity_Type_Settings} instance.
-	 *
-	 * @since 3.14.0
-	 */
-	public function __construct() {
-
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Admin_Entity_Type_Settings' );
-
-	}
-
-	/**
-	 * Handle menu registration.
-	 *
-	 * The registration is required, although we do not want to actually to add
-	 * an item to the menu, in order to "whitelist" the access to the settings page in
-	 * the admin.
-	 *
-	 * @since 3.11.0
-	 */
-	public function admin_menu() {
-
-		/*
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.14.0
+     * @access private
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * Create a {@link Wordlift_Admin_Entity_Type_Settings} instance.
+     *
+     * @since 3.14.0
+     */
+    public function __construct() {
+
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Admin_Entity_Type_Settings' );
+
+    }
+
+    /**
+     * Handle menu registration.
+     *
+     * The registration is required, although we do not want to actually to add
+     * an item to the menu, in order to "whitelist" the access to the settings page in
+     * the admin.
+     *
+     * @since 3.11.0
+     */
+    public function admin_menu() {
+
+        /*
 		 * Before anything else check if an settings form was submitted.
 		 * This has to be done before any output happens in order to be able to
 		 * display proper "die" error messages and redirect.
 		 */
-		if ( isset( $_GET['page'] ) && ( 'wl_entity_type_settings' === $_GET['page'] ) ) {
+        if ( isset( $_GET['page'] ) && ( 'wl_entity_type_settings' === $_GET['page'] ) ) {
 
-			// Validate inputs. Do not return on invalid parameters or capabilities.
-			$this->validate_proper_term();
+            // Validate inputs. Do not return on invalid parameters or capabilities.
+            $this->validate_proper_term();
 
-			// If proper form submission, handle it and redirect back to the settings page.
-			if ( isset( $_POST['action'] ) && ( 'wl_edit_entity_type_term' === $_POST['action'] ) ) {
-				$this->handle_form_submission();
-			}
+            // If proper form submission, handle it and redirect back to the settings page.
+            if ( isset( $_POST['action'] ) && ( 'wl_edit_entity_type_term' === $_POST['action'] ) ) {
+                $this->handle_form_submission();
+            }
 
-			// Register admin notices handler.
-			add_action( 'admin_notices', array( $this, 'admin_notice' ) );
+            // Register admin notices handler.
+            add_action( 'admin_notices', array( $this, 'admin_notice' ) );
 
-		}
+        }
 
-		/*
+        /*
 		 * Use a null parent slug to prevent the menu from actually appearing
 		 * in the admin menu.
 		 */
-		// @todo: use the new {@link Wordlift_Admin_Page}.
-		add_submenu_page(
-			null,
-			__( 'Edit Entity term', 'wordlift' ),
-			__( 'Edit Entity term', 'wordlift' ),
-			'manage_options',
-			'wl_entity_type_settings',
-			array( $this, 'render' )
-		);
-	}
-
-	/**
-	 * Output admin notices if needed, based on the message url parameter.
-	 * A value of 1 indicates that a successful save was done.
-	 *
-	 * @since 3.11.0
-	 */
-	function admin_notice() {
-		if ( isset( $_GET['message'] ) && ( '1' === $_GET['message'] ) ) {
-			?>
+        // @todo: use the new {@link Wordlift_Admin_Page}.
+        add_submenu_page(
+            null,
+            __( 'Edit Entity term', 'wordlift' ),
+            __( 'Edit Entity term', 'wordlift' ),
+            'manage_options',
+            'wl_entity_type_settings',
+            array( $this, 'render' )
+        );
+    }
+
+    /**
+     * Output admin notices if needed, based on the message url parameter.
+     * A value of 1 indicates that a successful save was done.
+     *
+     * @since 3.11.0
+     */
+    function admin_notice() {
+        if ( isset( $_GET['message'] ) && ( '1' === $_GET['message'] ) ) {
+            ?>
 			<div class="notice notice-success is-dismissible">
 				<p><?php esc_html_e( 'Settings saved', 'wordlift' ) ?></p>
 			</div>
 			<?php
-		}
-	}
-
-	/**
-	 * Validate the existence of the entity type indicated by the tag_ID url
-	 * parameter before doing any processing. Done before any output to mimic
-	 * the way WordPress handles same situation with "normal" term editing screens.
-	 *
-	 * @since 3.11.0
-	 */
-	function validate_proper_term() {
-
-		// Validate capabilities.
-		if ( ! current_user_can( 'manage_options' ) ) {
-			wp_die(
-				'<h1>' . __( 'Cheatin&#8217; uh?' ) . '</h1>' .
-				'<p>' . __( 'Sorry, you are not allowed to edit this item.' ) . '</p>',
-				403
-			);
-		}
-
-		// Get the term id and the actual term.
-		$term_id = (int) $_REQUEST['tag_ID'];
-
-		if ( ! term_exists( $term_id, Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME ) ) {
-			wp_die( __( 'You attempted to edit an entity type term that doesn&#8217;t exist.', 'wordlift' ) );
-		}
-
-	}
-
-	/**
-	 * Handle the form submission of the settings form. On successful
-	 * handling redirect tp the setting edit page.
-	 *
-	 * @since 3.11.0
-	 */
-	function handle_form_submission() {
-
-		$term_id = (int) $_POST['tag_ID'];
-
-		// Check the nonce.
-		check_admin_referer( 'update-entity_type_term_' . $term_id );
-
-		$term = get_term( $term_id, 'wl_entity_type' );
-
-		$this->set_setting(
-			$term_id,
-			trim( wp_unslash( $_POST['title'] ) ),
-			wp_unslash( $_POST['description'] )
-		);
-
-		// Redirect back to the term settings page and indicate a save was done.
-		$url = admin_url( "admin.php?page=wl_entity_type_settings&tag_ID=$term->term_id&message=1" );
-
-		wp_redirect( $url );
-		exit;
-
-	}
-
-	/**
-	 * Render the settings page for the term.
-	 *
-	 * Access and parameter validity is assumed to be done earlier.
-	 *
-	 * @since 3.11.0
-	 */
-	function render() {
-
-		// Set variables used by the partial
-		$term_id  = absint( $_REQUEST['tag_ID'] );
-		$settings = $this->get_setting( $term_id );
-
-		include plugin_dir_path( dirname( __FILE__ ) ) . 'admin/partials/wordlift-admin-entity-type-settings.php';
-
-	}
-
-	/**
-	 * Store the entity type term settings in the DB
-	 *
-	 * @since 3.11.0
-	 *
-	 * @param    integer $term_id     The ID of the entity type term
-	 * @param    string  $title       The override for the terms title.
-	 * @param    string  $description The override for the terms description.
-	 *
-	 */
-	function set_setting( $term_id, $title, $description ) {
-
-		$settings             = get_option( 'wl_entity_type_settings', array() );
-		$settings[ $term_id ] = array(
-			'title'       => $title,
-			'description' => $description,
-		);
-		update_option( 'wl_entity_type_settings', $settings );
-
-	}
-
-	/**
-	 * Retrieve the entity type term settings from the DB
-	 *
-	 * @since 3.11.0
-	 *
-	 * @param    integer $term_id The ID of the entity type term
-	 *
-	 * @return    null|array {
-	 *                null is returned when there are no settings otherwise
-	 *                an array is returned with following fields
-	 *
-	 * @type    string    title    The overriding title for the term
-	 * @type    string    description    The overriding description for the term
-	 *            }
-	 */
-	function get_setting( $term_id ) {
-
-		$settings = get_option( 'wl_entity_type_settings', array() );
-
-		if ( isset( $settings[ $term_id ] ) ) {
-			return $settings[ $term_id ];
-		}
-
-		$this->log->warn( "No settings found for term id $term_id." );
-
-		return null;
-	}
+        }
+    }
+
+    /**
+     * Validate the existence of the entity type indicated by the tag_ID url
+     * parameter before doing any processing. Done before any output to mimic
+     * the way WordPress handles same situation with "normal" term editing screens.
+     *
+     * @since 3.11.0
+     */
+    function validate_proper_term() {
+
+        // Validate capabilities.
+        if ( ! current_user_can( 'manage_options' ) ) {
+            wp_die(
+                '<h1>' . __( 'Cheatin&#8217; uh?' ) . '</h1>' .
+                '<p>' . __( 'Sorry, you are not allowed to edit this item.' ) . '</p>',
+                403
+            );
+        }
+
+        // Get the term id and the actual term.
+        $term_id = (int) $_REQUEST['tag_ID'];
+
+        if ( ! term_exists( $term_id, Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME ) ) {
+            wp_die( __( 'You attempted to edit an entity type term that doesn&#8217;t exist.', 'wordlift' ) );
+        }
+
+    }
+
+    /**
+     * Handle the form submission of the settings form. On successful
+     * handling redirect tp the setting edit page.
+     *
+     * @since 3.11.0
+     */
+    function handle_form_submission() {
+
+        $term_id = (int) $_POST['tag_ID'];
+
+        // Check the nonce.
+        check_admin_referer( 'update-entity_type_term_' . $term_id );
+
+        $term = get_term( $term_id, 'wl_entity_type' );
+
+        $this->set_setting(
+            $term_id,
+            trim( wp_unslash( $_POST['title'] ) ),
+            wp_unslash( $_POST['description'] )
+        );
+
+        // Redirect back to the term settings page and indicate a save was done.
+        $url = admin_url( "admin.php?page=wl_entity_type_settings&tag_ID=$term->term_id&message=1" );
+
+        wp_redirect( $url );
+        exit;
+
+    }
+
+    /**
+     * Render the settings page for the term.
+     *
+     * Access and parameter validity is assumed to be done earlier.
+     *
+     * @since 3.11.0
+     */
+    function render() {
+
+        // Set variables used by the partial
+        $term_id  = absint( $_REQUEST['tag_ID'] );
+        $settings = $this->get_setting( $term_id );
+
+        include plugin_dir_path( dirname( __FILE__ ) ) . 'admin/partials/wordlift-admin-entity-type-settings.php';
+
+    }
+
+    /**
+     * Store the entity type term settings in the DB
+     *
+     * @since 3.11.0
+     *
+     * @param    integer $term_id     The ID of the entity type term
+     * @param    string  $title       The override for the terms title.
+     * @param    string  $description The override for the terms description.
+     *
+     */
+    function set_setting( $term_id, $title, $description ) {
+
+        $settings             = get_option( 'wl_entity_type_settings', array() );
+        $settings[ $term_id ] = array(
+            'title'       => $title,
+            'description' => $description,
+        );
+        update_option( 'wl_entity_type_settings', $settings );
+
+    }
+
+    /**
+     * Retrieve the entity type term settings from the DB
+     *
+     * @since 3.11.0
+     *
+     * @param    integer $term_id The ID of the entity type term
+     *
+     * @return    null|array {
+     *                null is returned when there are no settings otherwise
+     *                an array is returned with following fields
+     *
+     * @type    string    title    The overriding title for the term
+     * @type    string    description    The overriding description for the term
+     *            }
+     */
+    function get_setting( $term_id ) {
+
+        $settings = get_option( 'wl_entity_type_settings', array() );
+
+        if ( isset( $settings[ $term_id ] ) ) {
+            return $settings[ $term_id ];
+        }
+
+        $this->log->warn( "No settings found for term id $term_id." );
+
+        return null;
+    }
 
 }

Spacing +33 added lines, -33 removed lines

@@ -12,7 +12,7 @@ 
  * @since      3.11.0
  */
 
-if ( ! defined( 'ABSPATH' ) ) {
+if ( ! defined('ABSPATH')) {
 	exit;
 }
 
@@ -46,7 +46,7 @@ 
 	 */
 	public function __construct() {
 
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Admin_Entity_Type_Settings' );
+		$this->log = Wordlift_Log_Service::get_logger('Wordlift_Admin_Entity_Type_Settings');
 
 	}
 
@@ -66,18 +66,18 @@ 
 		 * This has to be done before any output happens in order to be able to
 		 * display proper "die" error messages and redirect.
 		 */
-		if ( isset( $_GET['page'] ) && ( 'wl_entity_type_settings' === $_GET['page'] ) ) {
+		if (isset($_GET['page']) && ('wl_entity_type_settings' === $_GET['page'])) {
 
 			// Validate inputs. Do not return on invalid parameters or capabilities.
 			$this->validate_proper_term();
 
 			// If proper form submission, handle it and redirect back to the settings page.
-			if ( isset( $_POST['action'] ) && ( 'wl_edit_entity_type_term' === $_POST['action'] ) ) {
+			if (isset($_POST['action']) && ('wl_edit_entity_type_term' === $_POST['action'])) {
 				$this->handle_form_submission();
 			}
 
 			// Register admin notices handler.
-			add_action( 'admin_notices', array( $this, 'admin_notice' ) );
+			add_action('admin_notices', array($this, 'admin_notice'));
 
 		}
 
@@ -88,11 +88,11 @@ 
 		// @todo: use the new {@link Wordlift_Admin_Page}.
 		add_submenu_page(
 			null,
-			__( 'Edit Entity term', 'wordlift' ),
-			__( 'Edit Entity term', 'wordlift' ),
+			__('Edit Entity term', 'wordlift'),
+			__('Edit Entity term', 'wordlift'),
 			'manage_options',
 			'wl_entity_type_settings',
-			array( $this, 'render' )
+			array($this, 'render')
 		);
 	}
 
@@ -103,10 +103,10 @@ 
 	 * @since 3.11.0
 	 */
 	function admin_notice() {
-		if ( isset( $_GET['message'] ) && ( '1' === $_GET['message'] ) ) {
+		if (isset($_GET['message']) && ('1' === $_GET['message'])) {
 			?>
 			<div class="notice notice-success is-dismissible">
-				<p><?php esc_html_e( 'Settings saved', 'wordlift' ) ?></p>
+				<p><?php esc_html_e('Settings saved', 'wordlift') ?></p>
 			</div>
 			<?php
 		}
@@ -122,10 +122,10 @@ 
 	function validate_proper_term() {
 
 		// Validate capabilities.
-		if ( ! current_user_can( 'manage_options' ) ) {
+		if ( ! current_user_can('manage_options')) {
 			wp_die(
-				'<h1>' . __( 'Cheatin&#8217; uh?' ) . '</h1>' .
-				'<p>' . __( 'Sorry, you are not allowed to edit this item.' ) . '</p>',
+				'<h1>'.__('Cheatin&#8217; uh?').'</h1>'.
+				'<p>'.__('Sorry, you are not allowed to edit this item.').'</p>',
 				403
 			);
 		}
@@ -133,8 +133,8 @@ 
 		// Get the term id and the actual term.
 		$term_id = (int) $_REQUEST['tag_ID'];
 
-		if ( ! term_exists( $term_id, Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME ) ) {
-			wp_die( __( 'You attempted to edit an entity type term that doesn&#8217;t exist.', 'wordlift' ) );
+		if ( ! term_exists($term_id, Wordlift_Entity_Types_Taxonomy_Service::TAXONOMY_NAME)) {
+			wp_die(__('You attempted to edit an entity type term that doesn&#8217;t exist.', 'wordlift'));
 		}
 
 	}
@@ -150,20 +150,20 @@ 
 		$term_id = (int) $_POST['tag_ID'];
 
 		// Check the nonce.
-		check_admin_referer( 'update-entity_type_term_' . $term_id );
+		check_admin_referer('update-entity_type_term_'.$term_id);
 
-		$term = get_term( $term_id, 'wl_entity_type' );
+		$term = get_term($term_id, 'wl_entity_type');
 
 		$this->set_setting(
 			$term_id,
-			trim( wp_unslash( $_POST['title'] ) ),
-			wp_unslash( $_POST['description'] )
+			trim(wp_unslash($_POST['title'])),
+			wp_unslash($_POST['description'])
 		);
 
 		// Redirect back to the term settings page and indicate a save was done.
-		$url = admin_url( "admin.php?page=wl_entity_type_settings&tag_ID=$term->term_id&message=1" );
+		$url = admin_url("admin.php?page=wl_entity_type_settings&tag_ID=$term->term_id&message=1");
 
-		wp_redirect( $url );
+		wp_redirect($url);
 		exit;
 
 	}
@@ -178,10 +178,10 @@ 
 	function render() {
 
 		// Set variables used by the partial
-		$term_id  = absint( $_REQUEST['tag_ID'] );
-		$settings = $this->get_setting( $term_id );
+		$term_id  = absint($_REQUEST['tag_ID']);
+		$settings = $this->get_setting($term_id);
 
-		include plugin_dir_path( dirname( __FILE__ ) ) . 'admin/partials/wordlift-admin-entity-type-settings.php';
+		include plugin_dir_path(dirname(__FILE__)).'admin/partials/wordlift-admin-entity-type-settings.php';
 
 	}
 
@@ -195,14 +195,14 @@ 
 	 * @param    string  $description The override for the terms description.
 	 *
 	 */
-	function set_setting( $term_id, $title, $description ) {
+	function set_setting($term_id, $title, $description) {
 
-		$settings             = get_option( 'wl_entity_type_settings', array() );
-		$settings[ $term_id ] = array(
+		$settings             = get_option('wl_entity_type_settings', array());
+		$settings[$term_id] = array(
 			'title'       => $title,
 			'description' => $description,
 		);
-		update_option( 'wl_entity_type_settings', $settings );
+		update_option('wl_entity_type_settings', $settings);
 
 	}
 
@@ -221,15 +221,15 @@ 
 	 * @type    string    description    The overriding description for the term
 	 *            }
 	 */
-	function get_setting( $term_id ) {
+	function get_setting($term_id) {
 
-		$settings = get_option( 'wl_entity_type_settings', array() );
+		$settings = get_option('wl_entity_type_settings', array());
 
-		if ( isset( $settings[ $term_id ] ) ) {
-			return $settings[ $term_id ];
+		if (isset($settings[$term_id])) {
+			return $settings[$term_id];
 		}
 
-		$this->log->warn( "No settings found for term id $term_id." );
+		$this->log->warn("No settings found for term id $term_id.");
 
 		return null;
 	}

src/admin/class-wordlift-admin.php

Indentation +156 added lines, -156 removed lines

@@ -22,161 +22,161 @@
  */
 class Wordlift_Admin {
 
-	/**
-	 * The ID of this plugin.
-	 *
-	 * @since    1.0.0
-	 * @access   private
-	 * @var      string $plugin_name The ID of this plugin.
-	 */
-	private $plugin_name;
-
-	/**
-	 * The version of this plugin.
-	 *
-	 * @since    1.0.0
-	 * @access   private
-	 * @var      string $version The current version of this plugin.
-	 */
-	private $version;
-
-	/**
-	 * The {@link Wordlift_Configuration_Service} instance.
-	 *
-	 * @since  3.14.0
-	 * @access private
-	 * @var \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
-	 */
-	private $configuration_service;
-
-	/**
-	 * The {@link Wordlift_User_Service} instance.
-	 *
-	 * @since  3.14.0
-	 * @access private
-	 * @var \Wordlift_User_Service $user_service The {@link Wordlift_User_Service} instance.
-	 */
-	private $user_service;
-
-	/**
-	 * Initialize the class and set its properties.
-	 *
-	 * @since  1.0.0
-	 *
-	 * @param string                          $plugin_name           The name of this plugin.
-	 * @param string                          $version               The version of this plugin.
-	 * @param \Wordlift_Configuration_Service $configuration_service The configuration service.
-	 * @param \Wordlift_Notice_Service        $notice_service        The notice service.
-	 * @param \Wordlift_User_Service          $user_service          The {@link Wordlift_User_Service} instance.
-	 */
-	public function __construct( $plugin_name, $version, $configuration_service, $notice_service, $user_service ) {
-
-		$this->plugin_name = $plugin_name;
-		$this->version     = $version;
-
-		$this->configuration_service = $configuration_service;
-		$this->user_service          = $user_service;
-
-		$dataset_uri = $configuration_service->get_dataset_uri();
-		$key         = $configuration_service->get_key();
-
-		if ( empty( $dataset_uri ) ) {
-			$settings_page = Wordlift_Admin_Settings_Page::get_instance();
-			if ( empty( $key ) ) {
-				$error = sprintf( esc_html__( "WordLift's key isn't set, please open the %s to set WordLift's key.", 'wordlift' ), '<a href="' . $settings_page->get_url() . '">' . esc_html__( 'settings page', 'wordlift' ) . '</a>' );
-			} else {
-				$error = sprintf( esc_html__( "WordLift's dataset URI is not configured: please open the %s to set WordLift's key again.", 'wordlift' ), '<a href="' . $settings_page->get_url() . '">' . esc_html__( 'settings page', 'wordlift' ) . '</a>' );
-			}
-			$notice_service->add_error( $error );
-		}
-
-	}
-
-	/**
-	 * Register the stylesheets for the admin area.
-	 *
-	 * @since    1.0.0
-	 */
-	public function enqueue_styles() {
-
-		/**
-		 * This function is provided for demonstration purposes only.
-		 *
-		 * An instance of this class should be passed to the run() function
-		 * defined in Wordlift_Loader as all of the hooks are defined
-		 * in that particular class.
-		 *
-		 * The Wordlift_Loader will then create the relationship
-		 * between the defined hooks and the functions defined in this
-		 * class.
-		 */
-
-		wp_enqueue_style( $this->plugin_name, plugin_dir_url( __FILE__ ) . 'css/wordlift-admin.css', array(), $this->version, 'all' );
-
-	}
-
-	/**
-	 * Register the JavaScript for the admin area.
-	 *
-	 * @since    1.0.0
-	 */
-	public function enqueue_scripts() {
-
-		/**
-		 * This function is provided for demonstration purposes only.
-		 *
-		 * An instance of this class should be passed to the run() function
-		 * defined in Wordlift_Loader as all of the hooks are defined
-		 * in that particular class.
-		 *
-		 * The Wordlift_Loader will then create the relationship
-		 * between the defined hooks and the functions defined in this
-		 * class.
-		 */
-
-		// Enqueue the admin scripts.
-		wp_enqueue_script( $this->plugin_name, plugin_dir_url( __FILE__ ) . 'js/wordlift-admin.bundle.js', array(
-			'jquery',
-			'underscore',
-			'backbone',
-		), $this->version, false );
-
-		// Set the basic params.
-		$params = array(
-			// @todo scripts in admin should use wp.post.
-			'ajax_url'            => admin_url( 'admin-ajax.php' ),
-			// @todo remove specific actions from settings.
-			'action'              => 'entity_by_title',
-			'datasetUri'          => $this->configuration_service->get_dataset_uri(),
-			'language'            => $this->configuration_service->get_language_code(),
-			'link_by_default'     => $this->configuration_service->is_link_by_default(),
-			// Whether the current user is allowed to create new entities.
-			//
-			// @see https://github.com/insideout10/wordlift-plugin/issues/561
-			'can_create_entities' => current_user_can( 'edit_wordlift_entities' ) ? 'yes' : 'no',
-			'l10n'                => array(
-				'You already published an entity with the same name' => __( 'You already published an entity with the same name: ', 'wordlift' ),
-				'logo_selection_title'                               => __( 'WordLift Choose Logo', 'wordlift' ),
-				'logo_selection_button'                              => array( 'text' => __( 'Choose Logo', 'wordlift' ) ),
-			),
-		);
-
-		// Set post-related values if there's a current post.
-		if ( null !== $post = $entity_being_edited = get_post() ) {
-
-			$params['post_id']           = $entity_being_edited->ID;
-			$params['entityBeingEdited'] = isset( $entity_being_edited->post_type ) && Wordlift_Entity_Service::TYPE_NAME == $entity_being_edited->post_type && is_numeric( get_the_ID() );
-			// We add the `itemId` here to give a chance to the analysis to use it in order to tell WLS to exclude it
-			// from the results, since we don't want the current entity to be discovered by the analysis.
-			//
-			// See https://github.com/insideout10/wordlift-plugin/issues/345
-			$params['itemId'] = Wordlift_Entity_Service::get_instance()->get_uri( $entity_being_edited->ID );
-
-		}
-
-		// Finally output the params as `wlSettings` for JavaScript code.
-		wp_localize_script( $this->plugin_name, 'wlSettings', $params );
-
-	}
+    /**
+     * The ID of this plugin.
+     *
+     * @since    1.0.0
+     * @access   private
+     * @var      string $plugin_name The ID of this plugin.
+     */
+    private $plugin_name;
+
+    /**
+     * The version of this plugin.
+     *
+     * @since    1.0.0
+     * @access   private
+     * @var      string $version The current version of this plugin.
+     */
+    private $version;
+
+    /**
+     * The {@link Wordlift_Configuration_Service} instance.
+     *
+     * @since  3.14.0
+     * @access private
+     * @var \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
+     */
+    private $configuration_service;
+
+    /**
+     * The {@link Wordlift_User_Service} instance.
+     *
+     * @since  3.14.0
+     * @access private
+     * @var \Wordlift_User_Service $user_service The {@link Wordlift_User_Service} instance.
+     */
+    private $user_service;
+
+    /**
+     * Initialize the class and set its properties.
+     *
+     * @since  1.0.0
+     *
+     * @param string                          $plugin_name           The name of this plugin.
+     * @param string                          $version               The version of this plugin.
+     * @param \Wordlift_Configuration_Service $configuration_service The configuration service.
+     * @param \Wordlift_Notice_Service        $notice_service        The notice service.
+     * @param \Wordlift_User_Service          $user_service          The {@link Wordlift_User_Service} instance.
+     */
+    public function __construct( $plugin_name, $version, $configuration_service, $notice_service, $user_service ) {
+
+        $this->plugin_name = $plugin_name;
+        $this->version     = $version;
+
+        $this->configuration_service = $configuration_service;
+        $this->user_service          = $user_service;
+
+        $dataset_uri = $configuration_service->get_dataset_uri();
+        $key         = $configuration_service->get_key();
+
+        if ( empty( $dataset_uri ) ) {
+            $settings_page = Wordlift_Admin_Settings_Page::get_instance();
+            if ( empty( $key ) ) {
+                $error = sprintf( esc_html__( "WordLift's key isn't set, please open the %s to set WordLift's key.", 'wordlift' ), '<a href="' . $settings_page->get_url() . '">' . esc_html__( 'settings page', 'wordlift' ) . '</a>' );
+            } else {
+                $error = sprintf( esc_html__( "WordLift's dataset URI is not configured: please open the %s to set WordLift's key again.", 'wordlift' ), '<a href="' . $settings_page->get_url() . '">' . esc_html__( 'settings page', 'wordlift' ) . '</a>' );
+            }
+            $notice_service->add_error( $error );
+        }
+
+    }
+
+    /**
+     * Register the stylesheets for the admin area.
+     *
+     * @since    1.0.0
+     */
+    public function enqueue_styles() {
+
+        /**
+         * This function is provided for demonstration purposes only.
+         *
+         * An instance of this class should be passed to the run() function
+         * defined in Wordlift_Loader as all of the hooks are defined
+         * in that particular class.
+         *
+         * The Wordlift_Loader will then create the relationship
+         * between the defined hooks and the functions defined in this
+         * class.
+         */
+
+        wp_enqueue_style( $this->plugin_name, plugin_dir_url( __FILE__ ) . 'css/wordlift-admin.css', array(), $this->version, 'all' );
+
+    }
+
+    /**
+     * Register the JavaScript for the admin area.
+     *
+     * @since    1.0.0
+     */
+    public function enqueue_scripts() {
+
+        /**
+         * This function is provided for demonstration purposes only.
+         *
+         * An instance of this class should be passed to the run() function
+         * defined in Wordlift_Loader as all of the hooks are defined
+         * in that particular class.
+         *
+         * The Wordlift_Loader will then create the relationship
+         * between the defined hooks and the functions defined in this
+         * class.
+         */
+
+        // Enqueue the admin scripts.
+        wp_enqueue_script( $this->plugin_name, plugin_dir_url( __FILE__ ) . 'js/wordlift-admin.bundle.js', array(
+            'jquery',
+            'underscore',
+            'backbone',
+        ), $this->version, false );
+
+        // Set the basic params.
+        $params = array(
+            // @todo scripts in admin should use wp.post.
+            'ajax_url'            => admin_url( 'admin-ajax.php' ),
+            // @todo remove specific actions from settings.
+            'action'              => 'entity_by_title',
+            'datasetUri'          => $this->configuration_service->get_dataset_uri(),
+            'language'            => $this->configuration_service->get_language_code(),
+            'link_by_default'     => $this->configuration_service->is_link_by_default(),
+            // Whether the current user is allowed to create new entities.
+            //
+            // @see https://github.com/insideout10/wordlift-plugin/issues/561
+            'can_create_entities' => current_user_can( 'edit_wordlift_entities' ) ? 'yes' : 'no',
+            'l10n'                => array(
+                'You already published an entity with the same name' => __( 'You already published an entity with the same name: ', 'wordlift' ),
+                'logo_selection_title'                               => __( 'WordLift Choose Logo', 'wordlift' ),
+                'logo_selection_button'                              => array( 'text' => __( 'Choose Logo', 'wordlift' ) ),
+            ),
+        );
+
+        // Set post-related values if there's a current post.
+        if ( null !== $post = $entity_being_edited = get_post() ) {
+
+            $params['post_id']           = $entity_being_edited->ID;
+            $params['entityBeingEdited'] = isset( $entity_being_edited->post_type ) && Wordlift_Entity_Service::TYPE_NAME == $entity_being_edited->post_type && is_numeric( get_the_ID() );
+            // We add the `itemId` here to give a chance to the analysis to use it in order to tell WLS to exclude it
+            // from the results, since we don't want the current entity to be discovered by the analysis.
+            //
+            // See https://github.com/insideout10/wordlift-plugin/issues/345
+            $params['itemId'] = Wordlift_Entity_Service::get_instance()->get_uri( $entity_being_edited->ID );
+
+        }
+
+        // Finally output the params as `wlSettings` for JavaScript code.
+        wp_localize_script( $this->plugin_name, 'wlSettings', $params );
+
+    }
 
 }

Spacing +18 added lines, -18 removed lines

@@ -69,7 +69,7 @@ 
 	 * @param \Wordlift_Notice_Service        $notice_service        The notice service.
 	 * @param \Wordlift_User_Service          $user_service          The {@link Wordlift_User_Service} instance.
 	 */
-	public function __construct( $plugin_name, $version, $configuration_service, $notice_service, $user_service ) {
+	public function __construct($plugin_name, $version, $configuration_service, $notice_service, $user_service) {
 
 		$this->plugin_name = $plugin_name;
 		$this->version     = $version;
@@ -80,14 +80,14 @@ 
 		$dataset_uri = $configuration_service->get_dataset_uri();
 		$key         = $configuration_service->get_key();
 
-		if ( empty( $dataset_uri ) ) {
+		if (empty($dataset_uri)) {
 			$settings_page = Wordlift_Admin_Settings_Page::get_instance();
-			if ( empty( $key ) ) {
-				$error = sprintf( esc_html__( "WordLift's key isn't set, please open the %s to set WordLift's key.", 'wordlift' ), '<a href="' . $settings_page->get_url() . '">' . esc_html__( 'settings page', 'wordlift' ) . '</a>' );
+			if (empty($key)) {
+				$error = sprintf(esc_html__("WordLift's key isn't set, please open the %s to set WordLift's key.", 'wordlift'), '<a href="'.$settings_page->get_url().'">'.esc_html__('settings page', 'wordlift').'</a>');
 			} else {
-				$error = sprintf( esc_html__( "WordLift's dataset URI is not configured: please open the %s to set WordLift's key again.", 'wordlift' ), '<a href="' . $settings_page->get_url() . '">' . esc_html__( 'settings page', 'wordlift' ) . '</a>' );
+				$error = sprintf(esc_html__("WordLift's dataset URI is not configured: please open the %s to set WordLift's key again.", 'wordlift'), '<a href="'.$settings_page->get_url().'">'.esc_html__('settings page', 'wordlift').'</a>');
 			}
-			$notice_service->add_error( $error );
+			$notice_service->add_error($error);
 		}
 
 	}
@@ -111,7 +111,7 @@ 
 		 * class.
 		 */
 
-		wp_enqueue_style( $this->plugin_name, plugin_dir_url( __FILE__ ) . 'css/wordlift-admin.css', array(), $this->version, 'all' );
+		wp_enqueue_style($this->plugin_name, plugin_dir_url(__FILE__).'css/wordlift-admin.css', array(), $this->version, 'all');
 
 	}
 
@@ -135,16 +135,16 @@ 
 		 */
 
 		// Enqueue the admin scripts.
-		wp_enqueue_script( $this->plugin_name, plugin_dir_url( __FILE__ ) . 'js/wordlift-admin.bundle.js', array(
+		wp_enqueue_script($this->plugin_name, plugin_dir_url(__FILE__).'js/wordlift-admin.bundle.js', array(
 			'jquery',
 			'underscore',
 			'backbone',
-		), $this->version, false );
+		), $this->version, false);
 
 		// Set the basic params.
 		$params = array(
 			// @todo scripts in admin should use wp.post.
-			'ajax_url'            => admin_url( 'admin-ajax.php' ),
+			'ajax_url'            => admin_url('admin-ajax.php'),
 			// @todo remove specific actions from settings.
 			'action'              => 'entity_by_title',
 			'datasetUri'          => $this->configuration_service->get_dataset_uri(),
@@ -153,29 +153,29 @@ 
 			// Whether the current user is allowed to create new entities.
 			//
 			// @see https://github.com/insideout10/wordlift-plugin/issues/561
-			'can_create_entities' => current_user_can( 'edit_wordlift_entities' ) ? 'yes' : 'no',
+			'can_create_entities' => current_user_can('edit_wordlift_entities') ? 'yes' : 'no',
 			'l10n'                => array(
-				'You already published an entity with the same name' => __( 'You already published an entity with the same name: ', 'wordlift' ),
-				'logo_selection_title'                               => __( 'WordLift Choose Logo', 'wordlift' ),
-				'logo_selection_button'                              => array( 'text' => __( 'Choose Logo', 'wordlift' ) ),
+				'You already published an entity with the same name' => __('You already published an entity with the same name: ', 'wordlift'),
+				'logo_selection_title'                               => __('WordLift Choose Logo', 'wordlift'),
+				'logo_selection_button'                              => array('text' => __('Choose Logo', 'wordlift')),
 			),
 		);
 
 		// Set post-related values if there's a current post.
-		if ( null !== $post = $entity_being_edited = get_post() ) {
+		if (null !== $post = $entity_being_edited = get_post()) {
 
 			$params['post_id']           = $entity_being_edited->ID;
-			$params['entityBeingEdited'] = isset( $entity_being_edited->post_type ) && Wordlift_Entity_Service::TYPE_NAME == $entity_being_edited->post_type && is_numeric( get_the_ID() );
+			$params['entityBeingEdited'] = isset($entity_being_edited->post_type) && Wordlift_Entity_Service::TYPE_NAME == $entity_being_edited->post_type && is_numeric(get_the_ID());
 			// We add the `itemId` here to give a chance to the analysis to use it in order to tell WLS to exclude it
 			// from the results, since we don't want the current entity to be discovered by the analysis.
 			//
 			// See https://github.com/insideout10/wordlift-plugin/issues/345
-			$params['itemId'] = Wordlift_Entity_Service::get_instance()->get_uri( $entity_being_edited->ID );
+			$params['itemId'] = Wordlift_Entity_Service::get_instance()->get_uri($entity_being_edited->ID);
 
 		}
 
 		// Finally output the params as `wlSettings` for JavaScript code.
-		wp_localize_script( $this->plugin_name, 'wlSettings', $params );
+		wp_localize_script($this->plugin_name, 'wlSettings', $params);
 
 	}