Add Schema provider. Add documentation.

webstractions · webstractions · commit bba22b57c31f · 2017-10-13T09:26:46.000-07:00
diff --git a/README.md b/README.md
@@ -8,6 +8,7 @@ A collection of extensions for your Roots\Sage 9.x beta themes.
 - **Blade Directives:** @directives for loop, query, sidebar, FontAwesome, and more.
 - **Menu Provider:** Register nav menu and markup via configuration file.
 - **Sidebar Provider:** Register sidebar and widget markup via configuration file.
+- **Schema Provider** Quickly add schema.org markup via @schema directive.
 
 ## Requirements
 This package is specifically built for `Roots\Sage 9.0.0-beta.4` and above. It goes without saying that your development server needs to have `Php 7.0` or greater as well.
@@ -46,6 +47,9 @@ add_action('after_setup_theme', function (){
 
 });
 ```
+
+**Important** Since this package is introducing new Blade directives, you should clear your cached/compiled Blade files. Those files are located in `wp-content\uploads\cache`.
+
 ## Overview
 Outside of one line of code that you need to add to `setup.php` and the config files, there is nothing else you need to do. Config files are automatically registered with the Sage Container, no messing with `functions.php`.
 
@@ -188,12 +192,32 @@ Alternatively, you can still use WordPress functions to display a sidebar.
 ```blade
 @php( \dynamic_sidebar('sidebar-primary') )
 ```
+
+### Schema Provider
+As with the Blade directives, there are numerous schema.org attributes and has its own documentaion. There are also two filters for each attribute, which can be used to extend them further. See [Schema Provider Documentation](https://github.com/webstractions/sage-xpress/tree/master/docs/schema.md) for complete details.
+
+Using the `@schema` directive makes markup simple.
+
+```blade
+{{--  Author  --}}
+<span @schema( 'entry-author' )>
+  @php( the_author_posts_link() )
+</span>
+```
+Will produce the following Php.
+```php
+<span class="entry-author" itemprop="author" itemscope="itemscope" itemtype="http://schema.org/Person">
+    <?php ( the_author_posts_link() ); ?>
+</span>
+```
+
 ## Documentation
 - [Blade Directives](https://github.com/webstractions/sage-xpress/tree/master/docs/blade.md)
 
 ## Acknowledgements
 - Roots/Sage Discourse thread [Resources for Blade](https://discourse.roots.io/t/best-practice-resources-for-blade/8341) and [Log1x's](https://discourse.roots.io/u/Log1x) contributions for inspiring the Blade component.
 - Appstract's [Laravel Blade Directives](https://github.com/appstract/laravel-blade-directives) for configuration and service provider logic.
+- Justin Tadlock's `hybrid_attr()` functions from older versions of [Hybrid Core](https://github.com/justintadlock/hybrid-core).
 
 
 ## License
diff --git a/docs/schema.md b/docs/schema.md
@@ -0,0 +1,64 @@
+## Schema Usage
+
+Based on Justin Tadlock's `hybrid_attr()` functions from older versions of [Hybrid Core](https://github.com/justintadlock/hybrid-core). Justin has since removed the schema.org attributes from the functions and they are resurected here.
+
+This provider is still a work in progress. It is functional, but has quirks. For instance, I am having problems using the `@schema()` directive using `@include` in an already included partial for some reason.
+
+Another quirk is the original `hybrid_attr()` function allowed for a third `$args` parameter array. You are able to pass stuff like `['class'=>'col-med-4 col-sm-12']` and have that rolled into the attributes. Doing something like this using a single Blade string called `$expression` is tough. At any rate, the same thing can be handled via filters.
+
+### Attributes
+For the most part, adding schema.org attributes is pretty straight forward. You just add `@schema('slug')` to your Blade files. The slug names can be found in the filters section below.
+
+Some slugs need a little more explanation.
+
+`@schema('body')` for the `<body>` tag automatically joins the `get_body_class()` into the list of classes. It also detects what type of page/post is being displayed and will act accordingly and set `itemtype` to WebPage, Blog, or SearchResultsPage.
+
+Three of the schemas require a second parameter:
+- `@schema('sidebar,context')` Where context is the Id of the sidebar
+- `@schema('menu,context')` Where context is the Id of the menu
+- `@schema('entry-terms,context')` Where context is optional. It can either be `category` or `post_tag` and will add an `itemprop` of 'articleSection' or 'keywords' respectively. If omitted, no itemprop will be defined.
+
+Three of the schemas reveal the fact that the blog is WordPress. If you have any plugins or custom code to hide this fact, you may wish to avoid using them. They are `@schema('header')`, `@schema('footer')`, and `@schema('sidebar')` which adds an `itemstype` of WPHeader, WPFooter, and WPSidebar respectively. Of course, you can add your own filters to change `itemtype` attributes.
+
+### Filters
+All filters have a priority of 5 and one argument, except for `sage_schema_sidebar`, `sage_schema_menu`, and `sage_schema_entry-terms`. Those exceptions require a second `$context` argument. For instance `@schema('sidebar, primary')`.
+
+Each filter follows a pattern `sage_schema_{$slug}`. Slugs are hyphenated.
+
+Additionally, there is a second set of matching filters for customizing `class` attributes. They follow a similar pattern `sage_schema_{$slug}_class`
+
+**Schema for major structural elements.**
+- `sage_schema_body`
+- `sage_schema_header`
+- `sage_schema_footer`
+- `sage_schema_content`
+- `sage_schema_sidebar` (2)
+- `sage_schema_menu` (2)
+
+**Header schema.**
+- `sage_schema_head`
+- `sage_schema_branding`
+- `sage_schema_site-title`
+- `sage_schema_site-description`
+
+**Archive page header schema.**
+- `sage_schema_archive-header`
+- `sage_schema_archive-title`
+- `sage_schema_archive-description`
+
+**Post-specific schema.**
+- `sage_schema_post`
+- `sage_schema_entry` (Alias for "post")
+- `sage_schema_entry-title`
+- `sage_schema_entry-author`
+- `sage_schema_entry-published`
+- `sage_schema_entry-content`
+- `sage_schema_entry-summary`
+- `sage_schema_entry-terms` (2)
+
+**Comment specific schema.**
+- `sage_schema_comment`
+- `sage_schema_comment-author`
+- `sage_schema_comment-published`
+- `sage_schema_comment-permalink`
+- `sage_schema_comment-content`
diff --git a/src/Blade/directives.php b/src/Blade/directives.php
@@ -48,6 +48,18 @@
         return "<?php echo do_action($expression); ?>";
     },
 
+    /*
+    |---------------------------------------------------------------------
+    | @schema
+    |---------------------------------------------------------------------
+    */
+    'schema' => function($expression) {
+        // $expression should be in form of [$slug, $context='', $attr=[]]
+        $expression = explode( ",", $expression );
+        $expression = array_replace( ['','',[] ] , $expression);
+        $html = \App\sage()->make('HtmlSchema')->attr($expression[0],$expression[1],$expression[2]);
+        return $html;
+    },
     /*
     |---------------------------------------------------------------------
     | @istrue / @isfalse
diff --git a/src/SageXpress.php b/src/SageXpress.php
@@ -21,6 +21,7 @@ public function bootstrap() {
         $this->registerBladeDirectives();
         $this->registerMenuProvider();
         $this->registerSidebarProvider();
+        $this->registerSchemaProvider();
         $this->registerShortcodesProvider();
         $this->registerLayoutProvider();
     }
@@ -43,6 +44,12 @@ protected function registerSidebarProvider() {
         new SidebarProvider($this->sage);
     }
 
+    protected function registerSchemaProvider() {
+
+        $this->sage->bind('HtmlSchema', \SageXpress\Schema\SchemaFunctions::class);
+        new \SageXpress\Schema\SchemaProvider($this->sage);
+    }
+
     protected function registerShortcodesProvider() {
 
     }
diff --git a/src/Schema/SchemaFunctions.php b/src/Schema/SchemaFunctions.php
diff --git a/src/Schema/SchemaProvider.php b/src/Schema/SchemaProvider.php

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@ public function bootstrap() {`
`21`	`21`	`$this->registerBladeDirectives();`
`22`	`22`	`$this->registerMenuProvider();`
`23`	`23`	`$this->registerSidebarProvider();`
	`24`	`+ $this->registerSchemaProvider();`
`24`	`25`	`$this->registerShortcodesProvider();`
`25`	`26`	`$this->registerLayoutProvider();`
`26`	`27`	`}`
`@@ -43,6 +44,12 @@ protected function registerSidebarProvider() {`
`43`	`44`	`new SidebarProvider($this->sage);`
`44`	`45`	`}`
`45`	`46`
	`47`	`+ protected function registerSchemaProvider() {`
	`48`	`+`
	`49`	`+ $this->sage->bind('HtmlSchema', \SageXpress\Schema\SchemaFunctions::class);`
	`50`	`+ new \SageXpress\Schema\SchemaProvider($this->sage);`
	`51`	`+ }`
	`52`	`+`
`46`	`53`	`protected function registerShortcodesProvider() {`
`47`	`54`
`48`	`55`	`}`