Added Serialized Datastore example

Author: dmhendricks

README.md

@@ -77,7 +77,7 @@ Release changes are noted on the [Releases](https://github.com/dmhendricks/wordp
 
 #### Branch: `master`
 
-* None since release
+* Added Carbon Fields [Serialized Datastore](https://github.com/dmhendricks/wordpress-base-plugin/wiki/Features-&-Customization#serialized-data-store) example
 
 ## Credits
 

app/Datastores/Serialized_Theme_Options_Datastore.php

@@ -0,0 +1,82 @@
+<?php
+namespace Carbon_Fields\Datastore\Datastore;
+use Carbon_Fields\Field\Field;
+use Carbon_Fields\Datastore\Datastore;
+
+/**
+ * Stores serialized values in the database
+ */
+class Serialized_Theme_Options_Datastore extends Datastore {
+
+    /**
+     * Initialization tasks for concrete datastores.
+     **/
+    public function init() {
+
+    }
+
+    protected function get_key_for_field( Field $field ) {
+        $key = '_' . $field->get_base_name();
+        return $key;
+    }
+
+    /**
+     * Save a single key-value pair to the database with autoload
+     *
+     * @param string $key
+     * @param string $value
+     * @param bool $autoload
+     */
+    protected function save_key_value_pair_with_autoload( $key, $value, $autoload ) {
+        $notoptions = wp_cache_get( 'notoptions', 'options' );
+        $notoptions[ $key ] = '';
+        wp_cache_set( 'notoptions', $notoptions, 'options' );
+        $autoload = $autoload ? 'yes' : 'no';
+
+        if ( ! add_option( $key, $value, null, $autoload ) ) {
+            update_option( $key, $value, $autoload );
+        }
+    }
+
+    /**
+     * Load the field value(s)
+     *
+     * @param Field $field The field to load value(s) in.
+     * @return array
+     */
+    public function load( Field $field ) {
+        $key = $this->get_key_for_field( $field );
+        $value = get_option( $key, null );
+        return $value;
+    }
+
+    /**
+     * Save the field value(s)
+     *
+     * @param Field $field The field to save.
+     */
+    public function save( Field $field ) {
+        if ( ! empty( $field->get_hierarchy() ) ) {
+            return; // only applicable to root fields
+        }
+        $key = $this->get_key_for_field( $field );
+        $value = $field->get_full_value();
+        if ( is_a( $field, '\\Carbon_Fields\\Field\\Complex_Field' ) ) {
+            $value = $field->get_value_tree();
+        }
+        $this->save_key_value_pair_with_autoload( $key, $value, $field->get_autoload() );
+    }
+
+    /**
+     * Delete the field value(s)
+     *
+     * @param Field $field The field to delete.
+     */
+    public function delete( Field $field ) {
+        if ( ! empty( $field->get_hierarchy() ) ) {
+            return; // only applicable to root fields
+        }
+        $key = $this->get_key_for_field( $field );
+        delete_option( $key );
+    }
+}

app/PostTypes/Clients.php

@@ -10,8 +10,8 @@ class Clients extends Plugin {
   public function __construct() {
 
     // Sample Custom Post Type - Client
-    add_action( 'carbon_fields_loaded', array( $this, 'add_post_type_client' ) );
-    //$this->add_post_type_client();
+    //add_action( 'carbon_fields_loaded', array( $this, 'add_post_type_client' ) );
+    $this->add_post_type_client();
 
     // Hide unnecessary publishing options like Draft, visibility, etc.
     add_action( 'admin_head-post.php', array( $this, 'hide_publishing_actions' ) );

app/Settings/Carbon_Page.php

@@ -1,6 +1,7 @@
 <?php
 namespace VendorName\PluginName\Settings;
 use VendorName\PluginName\Plugin;
+use Carbon_Fields\Datastore\Datastore\Serialized_Theme_Options_Datastore;
 use Carbon_Fields\Container;
 use Carbon_Fields\Field;
 
@@ -73,10 +74,13 @@ private function create_tabbed_options_page() {
             'left' => __('Left', self::$textdomain)
           ))
           ->set_default_value('top'),
-        Field::make('complex', $this->prefix('slides'), self::$config->get( 'plugin/meta/Name' ) . ' ' . __('Slides', self::$textdomain))->add_fields(array(
-          Field::make('text', 'title'),
-          Field::make('image', 'photo'),
-        )),
+        Field::make('complex', $this->prefix('slides'), self::$config->get( 'plugin/meta/Name' ) . ' ' . __('Slides', self::$textdomain))
+          ->set_datastore( new Serialized_Theme_Options_Datastore() )
+          ->add_fields(array(
+            Field::make('text', 'title'),
+            Field::make('image', 'photo'),
+          )
+        ),
         Field::make('select', $this->prefix('select_dropdown'), __('Favorite Continent', self::$textdomain) )
           ->add_options(array(
             'aria' => __('Asia', self::$textdomain),

composer.json

@@ -28,7 +28,8 @@
   "minimum-stability": "dev",
   "autoload": {
     "psr-4": {
-      "VendorName\\PluginName\\": "app/"
+      "VendorName\\PluginName\\": "app/",
+      "Carbon_Fields\\Datastore\\Datastore\\": "app/Datastores/"
     }
   }
 }