Merge pull request #206 from my-language-skills/Chris

Chris

Author: danzhik

.gitignore

@@ -1,3 +1,4 @@
 .idea
 all-in-one-metadata/.idea
 all-in-one-metadata/.vscode
+all-in-one-metadata/vendor

README.md

@@ -40,7 +40,8 @@ https://github.com/pressbooks/pressbooks/issues/950
 
 ## Installation
 
-1. Clone (or copy) this repository to the `/wp-content/plugins/` directory
+1. Clone (or copy) this repository folder `all-in-one-metadata` to the `/wp-content/plugins/` directory
+1. Navigate into `/wp-content/plugins/all-in-one-metadata` and run `composer install` and then `composer dump-autoload -o`
 1. Activate the plugin through the 'Plugins' screen in WordPress
 
 ## Frequently Asked Questions

all-in-one-metadata/admin/adminFunctions/class-pressbooks-metadata-options.php

@@ -86,6 +86,7 @@ function add_metaboxes() {
 		add_meta_box('metadata-location', 'Location Of Metadata', array($this, 'render_metabox_schema_locations'), $this->pagehook, 'normal', 'core');
 		add_meta_box('activated-schema-locations', 'Activated Locations For Schema Types', array($this, 'render_metabox_active_schemas'), $this->pagehook, 'normal', 'core');
 		add_meta_box('specific-metadata', 'Specific Metadata', array($this, 'render_metabox_specific_metadata'), $this->pagehook, 'normal', 'core');
+		add_meta_box('general-settings', 'General Settings', array($this, 'render_general_settings'), $this->pagehook, 'normal', 'core');
 	}
 
 	/**
@@ -115,6 +116,15 @@ function render_metabox_active_schemas(){
 		include_once plugin_dir_path( dirname( __FILE__ ) ) . 'partials/pressbooks-metadata-admin-settings-activeSchemas.php';
 	}
 
+	/**
+	 * Render data for the general_settings metabox.
+	 *
+	 * @since  0.x
+	 */
+	function render_general_settings(){
+		include_once plugin_dir_path( dirname( __FILE__ ) ) . 'partials/pressbooks-metadata-admin-settings-general.php';
+	}
+
 	/**
 	 * A function that manipulates the inputs for saving the new cpt data
 	 * @since    0.9

all-in-one-metadata/admin/partials/pressbooks-metadata-admin-settings-general.php

@@ -0,0 +1,21 @@
+<?php
+/**
+* The file containing the html for the genral settings Metabox in the settings.
+*
+* @link       https://github.com/Books4Languages/pressbooks-metadata
+* @since      0.x
+*
+* @package    Pressbooks_Metadata
+* @subpackage Pressbooks_Metadata/admin/partials
+* @author     Christos Amyrotos <[email protected]>
+*/
+?>
+
+<form method="post" action="options.php">
+    <?php
+    settings_fields( 'general_settings_page' );
+    do_settings_sections( 'general_settings_page' );
+    submit_button();
+    echo '<br><br>';
+    ?>
+</form>

all-in-one-metadata/admin/schemaFunctions/class-pressbooks-metadata-engine.php

@@ -103,6 +103,14 @@ public static function get_all_post_types(){
 	 */
 	public function register_settings() {
 
+		//General settings
+		$generalSettSection = "generalSettingsSection";
+		$generalSettPage = "general_settings_page";
+
+		//Registering the general settings for the general settings metabox
+		add_settings_section($generalSettSection, "Metadata Output Type", null, $generalSettPage);
+		new post_type_fields('jsonld_output','Enable Jsonld',$generalSettPage,$generalSettSection);
+
 		//Post Level
 		$postLevelSection = "postLevelSection";
 		$postLevelPage = "post_level_tab";

all-in-one-metadata/admin/schemaTypes/class-pressbooks-metadata-type.php

@@ -3,6 +3,7 @@
 namespace schemaTypes;
 use schemaFunctions\Pressbooks_Metadata_General_Functions as gen_func;
 use schemaFunctions\Pressbooks_Metadata_Create_Metabox as create_metabox;
+use Spatie\SchemaOrg\Schema as jsonldGen;
 
 /**
  * The class for the Type including operations, this class is used as a base class for all the types
@@ -184,18 +185,33 @@ public function pmdt_add_metabox($meta_position) {
 	}
 
 	/**
-	 * A function that creates the metadata for the book type.
+	 * This is a routing function used to check if the administrator wants the metadata to be in jsonld or microdata format
+	 * @since 0.x
+	 *
+	 */
+	public function pmdt_get_metatags(){
+		//Here we need to check for a wordpress option
+		if(!get_option('jsonld_output')){
+			return $this->get_microdata();
+		}else{
+			return $this->get_jsonld();
+		}
+	}
+
+	/**
+	 * A function that creates the metadata for the types using microdata.
 	 * @since 0.8.1
 	 *
 	 */
-	public function pmdt_get_metatags() {
+	private function get_microdata() {
 		//Creating microtags
 		$html = "<!-- Microtags --> \n";
 
 		$html .= '<div itemscope itemtype="'.$this->typeUrl.'">';
 
 		foreach ( $this->type_fields as $itemprop => $details ) {
 			$propName = strtolower('pb_' . $itemprop . '_'.$this->typeName.'_' . $this->type_level);
+			$clearTypeName = str_replace('http://schema.org/','',$this->typeUrl);
 			if ($this->pmdt_prop_run($itemprop)) {
 				$value = $this->pmdt_get_value($propName);
 				if(!empty($value)){$html .= "<meta itemprop = '" . $itemprop . "' content = '" . $value . "'>\n";}
@@ -204,4 +220,47 @@ public function pmdt_get_metatags() {
 		$html .= '</div>';
 		return $html;
 	}
+
+	/**
+	 * A function that creates the metadata for the types using jsonld.
+	 * @since 0.x
+	 *
+	 */
+	private function get_jsonld(){
+
+		//Getting the clear name of the type so we can load a class (type object) from the spatie/schema
+		$clearTypeName = str_replace('http://schema.org/','',$this->typeUrl);
+
+		//Changing the first letter of the type into lower case so we can match the function name in the library (starting point Schema.php)
+		$clearTypeName = lcfirst($clearTypeName);
+
+		//Calling the Schema.php class from the library invoking its function that returns the type
+		//Note that the functions in Schema.php are static and the name of the function ($clearTypeName) returns the type of the name
+		//For example $schema = jsonldGen::$book(); will return a book object
+		$schema = new jsonldGen;
+
+		//Checking if the type exists in the library, in case we have a naming error comming from our type files we end the opperation
+		if(!method_exists($schema,$clearTypeName)){
+			return;
+		}
+
+		//Creating a schema type from the library
+		$schema = jsonldGen::$clearTypeName();
+
+
+		//Where ever we find a property that has a value we add it into the object created above ($schema)
+		foreach ( $this->type_fields as $itemprop => $details ) {
+			$propName = strtolower('pb_' . $itemprop . '_'.$this->typeName.'_' . $this->type_level);
+			if ($this->pmdt_prop_run($itemprop)) {
+				$value = $this->pmdt_get_value($propName);
+				if(!empty($value)){
+					//Note that schema is the object created above and $itemprop is used to call a function from the type stored in the $schema variable
+					//Assuming like above that the $schema is holding a book object doing this $schema->illustrator('a_name') sets the illustrator property of the type to 'a_name'
+					$schema->$itemprop($value);
+				}
+			}
+		}
+		//This uses the $schema object and all the properties we gave it above (illustrator for example) to return jasonld data
+		return $schema->toScript();
+	}
 }

all-in-one-metadata/composer.json

@@ -6,10 +6,15 @@
       "schemaTypes\\": "admin/schemaTypes",
       "requiredPlugins\\": "admin/requiredPlugins",
       "schemaTypes\\cw\\": "admin/schemaTypes/creativeWorks",
-      "schemaTypes\\organization\\": "admin/schemaTypesorganization",
+      "schemaTypes\\organization\\": "admin/schemaTypes/organization",
       "adminFunctions\\": "admin/adminFunctions",
       "networkFunctions\\": "admin/networkFunctions",
-      "vocabularyFunctions\\": "admin/vocabularyFunctions"
+      "vocabularyFunctions\\": "admin/vocabularyFunctions",
+      "Spatie\\SchemaOrg\\": "vendor/spatie/schema-org/src"
     }
+  },
+  "require": {
+    "spatie/schema-org": "^1.4"
   }
-}
+}
+