From: Chuck Scott Date: Mon, 8 Feb 2016 20:03:37 +0000 (-0500) Subject: initial commit X-Git-Tag: v0.0.2~1 X-Git-Url: http://cvs2.gaslightmedia.com/gitweb/?a=commitdiff_plain;h=8599febd2effc242c73460e27a900daea8decb8b;p=WP-Plugins%2Fglm-member-db-sample.git initial commit --- 8599febd2effc242c73460e27a900daea8decb8b diff --git a/activate.php b/activate.php new file mode 100644 index 0000000..ddff3ba --- /dev/null +++ b/activate.php @@ -0,0 +1,165 @@ + + * @license http://www.gaslightmedia.com Gaslightmedia + * @release activate.php,v 1.0 2014/10/31 19:31:47 cscott Exp $ + * @link http://dev.gaslightmedia.com/ + */ + +/********************************************************************** + * NOTE: THIS IS A SAMPLE FILE - DO NOT USE UNMODIFIED + * + * Please change all references to sample, Sample, or SAMPLE to a name + * appropriate for your new Add-On. + * + * This file activates this add-on. Other than replacing the various + * versions of the work "Sample", this code should not need editing. + * + * Remove this message before using this file in production! + **********************************************************************/ + +// Check that we're being called by WordPress. +if (!defined('ABSPATH')) { + die("Please do not call this code directly!"); +} + +/* + * This class performs all necessary additional work when this + * plugin is activated. + * + * Currently the only actions are to add role capability to display and modify + * prototypes. + */ +class glmMembersSamplePluginActivate +{ + + /** + * WordPress Database Object + * + * @var $wpdb + * @access public + */ + public $wpdb; + /** + * Plugin Configuration Data + * + * @var $config + * @access public + */ + public $config; + + /* + * Constructor + * + * Note that the $noDatabaseCheck is used to access the database versions + * without triggering a database check. + * + * Performs all the work for this model + */ + public function __construct ($wpdb, $config) + { + + // Make sure the current user has this capability + if (! current_user_can('activate_plugins')) { + $this->addNotice("Interesting, you don't have permission to activate plugins."); + die(); + } + + // Save WordPress Database object + $this->wpdb = $wpdb; + + // Save plugin configuration object + $this->config = $config; + + // Set current plugin version + update_option('glmMembersDatabaseSamplePluginVersion', GLM_MEMBERS_SAMPLE_PLUGIN_VERSION); + + // Set Roles and Capabilities for this plugin + require_once(GLM_MEMBERS_SAMPLE_PLUGIN_SETUP_PATH.'/rolesAndCapabilities.php'); + } + + /* + * Add a capability to all current roles + * + * @param string $capability Name of capability to add + * @param array $default Whether capability should be on by default + * array( + * 'author' => false, + * 'contributor' => false, + * 'editor' => false, + * 'subscriber' => false + * ) + * + * @return void + * @access private + */ + private function addRoleCapability($capability, $default) + { + // Get list of role objects + $roleObjects = $GLOBALS['wp_roles']->role_objects; + + // Get list of roles we can edit + $roles = get_editable_roles(); + + // For each role object + foreach ($roleObjects as $key => $role) { + + // Check if the role exists in list of editable roles and + // the capability does not exist + if (isset($roles[$key]) && ! isset($role->capabilities[$capability])) { + + // Check if a default value has been specified in the $default array + $enabled = false; + if (isset($default[$role->name])) { + + // It has, so use that + $enabled = $default[$role->name]; + + } + + // Add the role + $role->add_cap($capability, $enabled); + + } + } + } + + + /* + * Delete a capability from all current roles + * + * @param string $capability Name of capability to add + * + * @return void + * @access private + */ + private function deleteRoleCapability($capability) + { + // Get list of role objects + $roleObjects = $GLOBALS['wp_roles']->role_objects; + + // Get list of roles we can edit + $roles = get_editable_roles(); + + // For each role object + foreach ($roleObjects as $key => $role) { + + if ( isset($role->capabilities[$capability])) { + $role->remove_cap($capability); + } + + } + + } + + + +} diff --git a/classes/data/dataSample.php b/classes/data/dataSample.php new file mode 100644 index 0000000..052a759 --- /dev/null +++ b/classes/data/dataSample.php @@ -0,0 +1,172 @@ + + * @license http://www.gaslightmedia.com Gaslightmedia + * @release SVN: $Id: dataSample.php,v 1.0 2011/01/25 19:31:47 cscott Exp $ + */ + +/********************************************************************** + * NOTE: THIS IS A SAMPLE FILE - DO NOT USE UNMODIFIED + * + * Please change all references to sample, Sample, or SAMPLE to a name + * appropriate for your new Add-On. + * + * Data fields in this file are sample only. + * + * Remove this message before using this file in production! + **********************************************************************/ + +// Member Info Data required +require_once(GLM_MEMBERS_PLUGIN_CLASS_PATH.'/data/dataMemberInfo.php'); + +/** + * GlmDataSample class + * + * PHP version 5 + * + * @category Data + * @package GLM Member DB + * @author Chuck Scott + * @license http://www.gaslightmedia.com Gaslightmedia + * @release SVN: $Id: dataMembers.php,v 1.0 2011/01/25 19:31:47 cscott + * Exp $ + */ +class GlmDataSample extends GlmDataAbstract +{ + + /** + * WordPress Database Object + * + * @var $wpdb + * @access public + */ + public $wpdb; + /** + * Plugin Configuration Data + * + * @var $config + * @access public + */ + public $config; + /** + * Data Table Name + * + * @var $table + * @access public + */ + public $table; + /** + * Field definitions + * + * 'type' is type of field as defined by the application + * text Regular text field + * pointer Pointer to an entry in another table + * 'filters' is the filter name for a particular filter ID in PHP filter + * functions + * See PHP filter_id() + * + * 'use' is when to use the field + * l = List + * g = Get + * n = New + * i = Insert + * e = Edit + * u = Update + * d = Delete + * a = All + * + * @var $ini + * @access public + */ + public $fields = false; + /** + * MemberInfo DB object + * + * @var $MemberInfo + * @access public + */ + public $MemberInfo; + + /** + * Constructor + * + * @param object $d database connection + * @param array $config Configuration array + * @param bool $limitedEdit Flag to say indicate limited edit requested + * + * @return void + * @access public + */ + public function __construct($wpdb, $config, $limitedEdit = false) + { + + // If this class is not being extended along with existing $wpdb and $config + if (!$this->wpdb) { + + // Save WordPress Database object + $this->wpdb = $wpdb; + + // Save plugin configuration object + $this->config = $config; + + } + + /* + * Table Name + */ + $this->table = GLM_MEMBERS_SAMPLE_PLUGIN_DB_PREFIX . 'sampletable'; + + /* + * Table Data Fields + */ + + $this->fields = array ( + + 'id' => array ( + 'field' => 'id', + 'type' => 'integer', + 'view_only' => true, + 'use' => 'a' + ), + + // Active flag + 'active' => array ( + 'field' => 'active', + 'type' => 'checkbox', + 'default' => true, + 'use' => 'a' + ) + + ); + + } + + /* + * Entry Post Processing Call-Back Method + * + * Perform post-processing for all result entries. + * + * In this case we're using it to append an array of category + * data to each member result and also sort by member name. + * + * @param array $r Array of field result data for a single entry + * @param string $a Action being performed (l, i, g, ...) + * + * @return object Class object + * + */ + public function entryPostProcessing($r, $a) + { + return $r; + } + +} + +?> \ No newline at end of file diff --git a/config/plugin.ini b/config/plugin.ini new file mode 100644 index 0000000..45899fc --- /dev/null +++ b/config/plugin.ini @@ -0,0 +1,8 @@ +; +; Main Configuration File +; Gaslight Media Members Database Sample Add-On Plugin +; +; Place any static configuration parameters here. +; + +[common] diff --git a/css/readme.txt b/css/readme.txt new file mode 100644 index 0000000..954cc9c --- /dev/null +++ b/css/readme.txt @@ -0,0 +1 @@ +Add admin.css and/or front.css to this directory to have those registered automatically. \ No newline at end of file diff --git a/deactivate.php b/deactivate.php new file mode 100644 index 0000000..b7fb800 --- /dev/null +++ b/deactivate.php @@ -0,0 +1,73 @@ + + * @license http://www.gaslightmedia.com Gaslightmedia + * @release admin.php,v 1.0 2014/10/31 19:31:47 cscott Exp $ + * @link http://dev.gaslightmedia.com/ + */ + +/********************************************************************** + * NOTE: THIS IS A SAMPLE FILE - DO NOT USE UNMODIFIED + * + * Please change all references to sample, Sample, or SAMPLE to a name + * appropriate for your new Add-On. + * + * This file deactivates this add-on. Other than replacing the various + * versions of the work "Sample", this code should not need editing. + * + * Remove this message before using this file in production! + **********************************************************************/ + +// Check that we're being called by WordPress. +if (!defined('ABSPATH')) { + die("Please do not call this code directly!"); +} + +/* + * This class performs all necessary additional work when this + * plugin is deactivated. + */ +class glmMembersSamplePluginDeactivate +{ + + /** + * WordPress Database Object + * + * @var $wpdb + * @access public + */ + public $wpdb; + /** + * Plugin Configuration Data + * + * @var $config + * @access public + */ + public $config; + + /* + * Constructor + * + * Performs all the work for this model + */ + public function __construct ($wpdb, $config) + { + + // Save WordPress Database object + $this->wpdb = $wpdb; + + // Save plugin configuration object + $this->config = $config; + + // Delete our version from WordPress Options + delete_option('glmMembersDatabaseSamplePluginVersion'); + } + +} diff --git a/defines.php b/defines.php new file mode 100644 index 0000000..17fc4f4 --- /dev/null +++ b/defines.php @@ -0,0 +1,67 @@ +prefix.'glm_membersSample_'); +define('GLM_MEMBERS_SAMPLE_PLUGIN_ACTIVE_DB_OPTION', 'glmMembersSampleDbVersion'); + +// Determine which system we're running on - If not provided, assume PRODUCTION +$host = getenv('GLM_HOST_ID'); +if (trim($host) == '') { + $host = 'PRODUCTION'; +} +define('GLM_MEMBER_SAMPLE_PLUGIN_HOST', $host); + +// Determine current http/https protocol +$pageProtocol = 'http'; +if (isset($_SERVER['SERVER_PORT']) && $_SERVER['SERVER_PORT'] == '443') { + $pageProtocol = 'https'; +} +define('GLM_MEMBERS_SAMPLE_PLUGIN_HTTP_PROTOCOL', $pageProtocol); + +// Get various pieces of the URL +$urlParts = parse_url(get_bloginfo('url')); +$pageUri = explode('?', $_SERVER['REQUEST_URI']); // Bust this up to access URL path and script name only + +$WPUploadDir = wp_upload_dir(); + +// URLs +define('GLM_MEMBERS_SAMPLE_SITE_BASE_URL', home_url('/') ); +define('GLM_MEMBERS_SAMPLE_PLUGIN_URL', plugin_dir_url(__FILE__)); +define('GLM_MEMBERS_SAMPLE_PLUGIN_ADMIN_URL', admin_url('admin.php')); +define('GLM_MEMBERS_SAMPLE_PLUGIN_BASE_URL', WP_PLUGIN_URL.'/'.GLM_MEMBERS_SAMPLE_PLUGIN_SLUG); +define('GLM_MEMBERS_SAMPLE_PLUGIN_CURRENT_URL', $urlParts['scheme'].'://'.$urlParts['host'].$pageUri[0]); + +// Directories +define('GLM_MEMBERS_SAMPLE_PLUGIN_PATH', dirname(__FILE__)); +define('GLM_MEMBERS_SAMPLE_PLUGIN_SETUP_PATH', GLM_MEMBERS_SAMPLE_PLUGIN_PATH.'/setup'); +define('GLM_MEMBERS_SAMPLE_PLUGIN_DB_SCRIPTS', GLM_MEMBERS_SAMPLE_PLUGIN_SETUP_PATH.'/databaseScripts'); +define('GLM_MEMBERS_SAMPLE_PLUGIN_CLASS_PATH', GLM_MEMBERS_SAMPLE_PLUGIN_PATH.'/classes'); +define('GLM_MEMBERS_SAMPLE_PLUGIN_CONFIG_PATH', GLM_MEMBERS_SAMPLE_PLUGIN_PATH.'/config'); + +// Parameters related to the Main GLM Member DB plugin - Depending on what's going on these may already defined by the main plugin +$pluginsPath = str_replace(GLM_MEMBERS_SAMPLE_PLUGIN_SLUG, '', GLM_MEMBERS_SAMPLE_PLUGIN_PATH); +define('GLM_MEMBERS_SAMPLE_MAIN_PLUGIN_PATH', $pluginsPath.'/glm-member-db'); +define('GLM_MEMBERS_SAMPLE_PLUGIN_LIB_PATH', GLM_MEMBERS_SAMPLE_MAIN_PLUGIN_PATH.'/lib'); + diff --git a/glm-member-db-sample.php b/glm-member-db-sample.php new file mode 100644 index 0000000..a89a81c --- /dev/null +++ b/glm-member-db-sample.php @@ -0,0 +1,227 @@ + + * @license http://www.gaslightmedia.com Gaslightmedia + * @version 1.1.1 + */ + +/* + * Plugin and Database Versions + * + * Note that the database version matches the version of the last + * plugin version where there was a change in the database. + * + * Updates to checkDatabase() in glmPluginSupport.php must be + * made together with the DB_VERSION below. ONLY bump the DB + * version when there's a change in the database!! Use the + * version nunmber of that release for the DB version. + * + * We check the plugin version stored in the WordPress option below + * so that we're sure the other add-ons see an up to date + * version from this plugin. + */ +define('GLM_MEMBERS_SAMPLE_PLUGIN_VERSION', '0.0.1'); +// define('GLM_MEMBERS_SAMPLE_PLUGIN_DB_VERSION', '0.0.1'); + +// This is the minimum version of the GLM Members DB plugin require for this plugin. +define('GLM_MEMBERS_SAMPLE_PLUGIN_MIN_MEMBERS_REQUIRED_VERSION', '1.0.57'); + +// Check if plugin version is not current in WordPress option and if needed updated it +if (GLM_MEMBERS_SAMPLE_PLUGIN_VERSION != get_option('glmMembersDatabaseSamplePluginVersion')) { + update_option('glmMembersDatabaseSamplePluginVersion', GLM_MEMBERS_SAMPLE_PLUGIN_VERSION); +} + +/* + * Copyright 2014 Charles Scott (email : cscott@gaslightmedia.com) + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License, version 2, as + * published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + */ + + +// Check that we're being called by WordPress. +if (!defined('ABSPATH')) { + die("Please do not call this code directly!"); +} + +/* +* Some initial setup and tests +*/ + +$startupNotices = ''; + +// Get standard defined parameters +require_once('defines.php'); + +// Required to be able to get user capabilities when being called as a filter from the main plugin +require_once(ABSPATH . 'wp-includes/pluggable.php'); + +/* + * Do some checks to make sure the main GLM Member DB is active and of a recceint enough version + */ + +// Function to generate message regarding main GLM Member DB plugin not installed and active +function glmMembersSamplePluginRequired() { + echo ' +
+

The '.GLM_MEMBERS_SAMPLE_PLUGIN_NAME.' add-on requires the base GLM Member DB plugin to be installed and active!

+

The '.GLM_MEMBERS_SAMPLE_PLUGIN_NAME.' plugin has been de-activated.

+
+ '; +} + +/* + * Check installation, activation, and version of main Member DB plugin + */ +include_once( ABSPATH . 'wp-admin/includes/plugin.php' ); +$plugin_name = 'glm-member-db/glm-member-db.php'; +$is_active = is_plugin_active($plugin_name); + +// If it's not active, then warn user and deactivate this add-on plugin +if ($is_active != '1') { + add_action( 'admin_notices', 'glmMembersSamplePluginRequired' ); + deactivate_plugins('/'.GLM_MEMBERS_SAMPLE_PLUGIN_SLUG.'/'.GLM_MEMBERS_SAMPLE_PLUGIN_SLUG.'.php'); +} + +// Function to generate message regarding main GLM Member DB plugin version is not receint enought to run this add-on +function glmMembersPluginSampleMinVerRequired() { + echo ' +
+

The '.GLM_MEMBERS_SAMPLE_PLUGIN_NAME.' requires that the main GLM Member DB plugin version be no older than ' + .GLM_MEMBERS_SAMPLE_PLUGIN_MIN_MEMBERS_REQUIRED_VERSION.'!
+ '.GLM_MEMBERS_SAMPLE_MIN_VERSION_NOTE.'

+

The '.GLM_MEMBERS_SAMPLE_PLUGIN_NAME.' plugin has been de-activated.

+
+ '; +} + +/* + * Check for Minimum DB version for main Member DB + */ +$glmMembersDatabasePluginVersion = get_option('glmMembersDatabasePluginVersion'); +if (version_compare($glmMembersDatabasePluginVersion, GLM_MEMBERS_SAMPLE_PLUGIN_MIN_MEMBERS_REQUIRED_VERSION) < 0) { + define('GLM_MEMBERS_SAMPLE_MIN_VERSION_NOTE', "Members DB: $glmMembersDatabasePluginVersion, Sample Requires: ".GLM_MEMBERS_SAMPLE_PLUGIN_MIN_MEMBERS_REQUIRED_VERSION); + add_action( 'admin_notices', 'glmMembersPluginSampleMinVerRequired'); + deactivate_plugins('/'.GLM_MEMBERS_SAMPLE_PLUGIN_SLUG.'/'.GLM_MEMBERS_SAMPLE_PLUGIN_SLUG.'.php'); +} + +/* + * Register this add-on with the main GLM Member DB plugin and get information on all add-ons loaded. + */ +require_once(GLM_MEMBERS_SAMPLE_PLUGIN_SETUP_PATH.'/validActions.php'); +require_once(GLM_MEMBERS_SAMPLE_PLUGIN_SETUP_PATH.'/shortcodes.php'); +$havePluginDatabase = false; +if (is_file(GLM_MEMBERS_SAMPLE_PLUGIN_DB_SCRIPTS.'/dbVersions.php')) { + require_once(GLM_MEMBERS_SAMPLE_PLUGIN_DB_SCRIPTS.'/dbVersions.php'); + $havePluginDatabase = true; +} + +// Load Sample Management Settings data +$sampleManagementSettings = $wpdb->get_row( "SELECT * FROM ".GLM_MEMBERS_SAMPLE_PLUGIN_DB_PREFIX."management WHERE id = 1", ARRAY_A ); +unset($sampleManagementSettings['id']); + +function glmMembersRegisterSample($addOns) { + + // Add this add-on to the add-ons array + $addOns[GLM_MEMBERS_SAMPLE_PLUGIN_SLUG] = array( + 'dir' => GLM_MEMBERS_SAMPLE_PLUGIN_PATH, + 'name' => GLM_MEMBERS_SAMPLE_PLUGIN_NAME, + 'short_name' => GLM_MEMBERS_SAMPLE_PLUGIN_SHORT_NAME, + 'slug' => GLM_MEMBERS_SAMPLE_PLUGIN_SLUG, + 'actions' => $GLOBALS['glmMembersSampleAddOnValidActions'], + 'config' => array( + 'settings' => $GLOBALS['sampleManagementSettings'] + ), + 'shortcodes' => $GLOBALS['glmMembersSampleShortcodes'], + 'shortcodesDescription' => $GLOBALS['glmMembersSampleShortcodesDescription'] + ); + + // If we have database tables for this plugin/addon, provide that data also + if ($havePluginDatabase) { + $addOns[GLM_MEMBERS_SAMPLE_PLUGIN_SLUG]['database'] = array( + 'dbPrefix' => GLM_MEMBERS_SAMPLE_PLUGIN_DB_PREFIX, + 'dbCurrentVersion' => GLM_MEMBERS_SAMPLE_PLUGIN_DB_VERSION, + 'dbActiveVersionOption' => GLM_MEMBERS_SAMPLE_PLUGIN_ACTIVE_DB_OPTION, + 'dbScriptPath' => GLM_MEMBERS_SAMPLE_PLUGIN_DB_SCRIPTS, + 'dbVersions' => $GLOBALS['glmMembersSampleDbVersions'] + ); + } + + // Return the array with our data added + return $addOns; +} +add_filter('glm-member-db-register-addon','glmMembersRegisterSample', 10, 1); + + /* + * + * Activate and Deactivate hooks + * + */ + + // Activate + function glmMembersSamplePluginActivate () + { + global $wpdb, $config; + require_once (GLM_MEMBERS_SAMPLE_PLUGIN_PATH . '/activate.php'); + new glmMembersSamplePluginActivate($wpdb, $config); + } + register_activation_hook(__FILE__, 'glmMembersSamplePluginActivate'); + + // Deactivate + function glmMembersSamplePluginDeactivate () + { + global $wpdb, $config; + require_once (GLM_MEMBERS_SAMPLE_PLUGIN_PATH . '/deactivate.php'); + $x = new glmMembersSamplePluginDeactivate($wpdb, $config); + return false; + } + register_deactivation_hook(__FILE__, 'glmMembersSamplePluginDeactivate'); + +/* + * Hooks for testing capabilities provided by this add-on + */ +require_once(GLM_MEMBERS_SAMPLE_PLUGIN_SETUP_PATH.'/permissions.php'); + diff --git a/index.php b/index.php new file mode 100644 index 0000000..4e6c07c --- /dev/null +++ b/index.php @@ -0,0 +1,3 @@ + \ No newline at end of file diff --git a/js/readme.txt b/js/readme.txt new file mode 100644 index 0000000..f642355 --- /dev/null +++ b/js/readme.txt @@ -0,0 +1 @@ +Add admin.js and/or front.js to this directory to have those registered automatically. \ No newline at end of file diff --git a/misc/documentation/AddAnAdminTab.txt b/misc/documentation/AddAnAdminTab.txt new file mode 100644 index 0000000..c697b47 --- /dev/null +++ b/misc/documentation/AddAnAdminTab.txt @@ -0,0 +1,15 @@ +Add an admin tab + +* Add a new section in setup/adminTabs.php + +* Add a model file - models/admin/{menu}/{action}.php + +* Add a view file - views/admin/{menu}/{action}.html + +* Add action to setup/validActions.php + +* If needed add a database table to the create_database_V...sql file + and update name to current database version, add an + update_database_V....sql file, and/or update dbVersions.php + +* If required add a data definition for any new tables diff --git a/misc/documentation/CreateNewAddOn.txt b/misc/documentation/CreateNewAddOn.txt new file mode 100644 index 0000000..ece4624 --- /dev/null +++ b/misc/documentation/CreateNewAddOn.txt @@ -0,0 +1,54 @@ +Procedure to create a new GLM Members add-on plugin +---------------------------------------------------- + +* Checkout glm-member-db-sample and rename directory to glm-member-db-{add-on name} + +* Rename glm-member-db-sample.php to glm-member-db-{addon name}.php + +* Review all files and change references to "sample" (any case) to the new add-on name. + - Read the information in the "NOTE: THIS IS A SAMPLE FILE - DO NOT USE UNMODIFIED" and + do anything recommended there. + - Remove all of the "NOTE: THIS IS A SAMPLE FILE - DO NOT USE UNMODIFIED" blocks. + +* Create new repository named WP-Plugins/glm-member-db-{name of add-on}.git + +* If there are any databases associated with this add-on, setup the database scripts and + data under the "setup/databaseScripts" directory. If there are no database tables + with this add-on, remove all but the "readme.txt" file from that directory. + NOTE: No "update_database..." files should be there for a new add-on with new tables. + NOTE: There should be only one entry in the "dbVersions.php" file. + +* Carefully review "defines.php" file and update as needed. + +* Do a quick review of the readme.txt file and update as desired. + +* TEST - At this point the add-on should install and activate but not do anything. + - If there are any database tables, make sure they were created and are correct. + - Go to "Members" -> "Management" -> "Add-Ons" and make sure the add-on was + properly registered with the main plugin and that any database data is shown. + +* Adding menus + - Update "setup/adminMenus.php" and add menu section as described there. + - Add an entry in the validActions.php file. Pay attention to how slug name is + constructed ("glm-members-admin-{page}-{action}"). + - If needed add a database table to the create_database_V...sql file + Also add a "classes/data/data{Table}.php file + - Add a model file as "models/admin/{page}/{action}.php + - Add any desired view file as "views/admin/{page}/{action}.html + Note that additional possible view files should be named as... + "views/admin/{page}/{action}{Name}.html + - Test that when add-on is activated that the menu shows and is functional. + +* Adding tabs + - Update "setup/admin/Tabs.php" and add new tab filter as described there. + - Add an entry in the validActions.php file. Pay attention to how slug name is + constructed ("glm-members-admin-{page}-{action}"). + - If needed add a database table to the create_database_V...sql file + Also add a "classes/data/data{Table}.php file + - Add a model file as "models/admin/{page}/{action}.php + - Add any desired view file as "views/admin/{page}/{action}.html + Note that additional possible view files should be named as... + "views/admin/{page}/{action}{Name}.html + - Test that when add-on is activated that the tab shows and is functional. + + * \ No newline at end of file diff --git a/models/admin/readme.txt b/models/admin/readme.txt new file mode 100644 index 0000000..e9a199d --- /dev/null +++ b/models/admin/readme.txt @@ -0,0 +1,5 @@ +The admin controller executes models under this directory. + +Typically you should add a directory here that matches the page where the action should take place. + +Under that directory place the model for the various actions. \ No newline at end of file diff --git a/models/front/readme.txt b/models/front/readme.txt new file mode 100644 index 0000000..4c54852 --- /dev/null +++ b/models/front/readme.txt @@ -0,0 +1,7 @@ +The front controller executes models under this directory. + +Typically you should add a directory here that matches the category of actions that will take place. + +Under that directory place the model for the various actions. + +Actions under this directory would normally be called due to processing of a shortcode. \ No newline at end of file diff --git a/readme.txt b/readme.txt new file mode 100644 index 0000000..2bbad40 --- /dev/null +++ b/readme.txt @@ -0,0 +1,27 @@ +=== Gaslight Media Member Database Sample Child Plugin === +Contributors: cscott@gaslightmedia.com +Donate link: http://www.gaslightmedia.com +Tags: Gaslight Media,Plugin,Members Sample +Requires at least: 3.0.1 +Tested up to: 3.4 +Stable tag: 4.3 +License: GPLv2 or later +License URI: http://www.gnu.org/licenses/gpl-2.0.html + +This is the Gaslight Media Members Database Sample Child Plugin. + +== Description == + +The Gaslight Media Members Database Sample Child Plugin is an add-on to the Gaslight Media Members Database, +which is required to install and run this plugin + +== Installation == + +This section describes how to install the plugin and get it working. + +e.g. + +1. Upload `plugin-name.php` to the `/wp-content/plugins/` directory +1. Activate the plugin through the 'Plugins' menu in WordPress + + diff --git a/setup/adminHooks.php b/setup/adminHooks.php new file mode 100644 index 0000000..8c36dfc --- /dev/null +++ b/setup/adminHooks.php @@ -0,0 +1,39 @@ + + * @license http://www.gaslightmedia.com Gaslightmedia + * @release adminHooks.php,v 1.0 2014/10/31 19:31:47 cscott Exp $ + * @link http://dev.gaslightmedia.com/ + */ + +/********************************************************************** + * NOTE: THIS IS A SAMPLE FILE - DO NOT USE UNMODIFIED + * + * Please change all references to sample, Sample, or SAMPLE to a name + * appropriate for your new Add-On. + * + * This file is used to create hooks into the main plugin or other + * add-ons. If no such hooks are needed, this file may be omitted. + * + * Remove this message before using this file in production! + **********************************************************************/ + +/* + * Place Misc Hooks and Filters here. If this file exists, it will be included + * by the add-on main plugin script. + * + * Note that filter and hook callback functions must be included in-line as shown below... + * + * add_filter( 'filter_title', function( $parameter ) { + * // Function code + * }); + * + * Also note that parameters will be in the context of the main admin controller constructor. + */ diff --git a/setup/adminMenus.php b/setup/adminMenus.php new file mode 100644 index 0000000..0853084 --- /dev/null +++ b/setup/adminMenus.php @@ -0,0 +1,51 @@ + + * @license http://www.gaslightmedia.com Gaslightmedia + * @release admin.php,v 1.0 2014/10/31 19:31:47 cscott Exp $ + * @link http://dev.gaslightmedia.com/ + */ + +/********************************************************************** + * NOTE: THIS IS A SAMPLE FILE - DO NOT USE UNMODIFIED + * + * Please change all references to sample, Sample, or SAMPLE to a name + * appropriate for your new Add-On. + * + * This file is used to add main menus or sub-menus to the admin + * area. If this add-on does not create additional menus, this file + * should be omitted. + * + * If adding a main menu, use "add_menu_page()" WordPress function + * instead and note any differences. + * + * The menu slug should be constructed as + * "glm-members-admin-{page}-{action}" + * The default action for a page is usually "index". + * + * Remove this message before using this file in production! + **********************************************************************/ + +/* + * Added menus or sub-menus examples + * + * add_submenu_page( + * 'glm-members-admin-menu-members', // Parent slug + * 'Sample', // Page title + * 'Sample', // Menu Title + * 'glm_members_edit', // Capability required + * 'glm-members-admin-menu-sample', // Menu slug + * function() {$this->controller('sample');} + * ); + * + * If creating a main menu item with add_menu_page(), please document + * that structure here. + * + */ diff --git a/setup/adminTabs.php b/setup/adminTabs.php new file mode 100644 index 0000000..850f8fd --- /dev/null +++ b/setup/adminTabs.php @@ -0,0 +1,49 @@ + + * @license http://www.gaslightmedia.com Gaslightmedia + * @release admin.php,v 1.0 2014/10/31 19:31:47 cscott Exp $ + * @link http://dev.gaslightmedia.com/ + */ + +/********************************************************************** + * NOTE: THIS IS A SAMPLE FILE - DO NOT USE UNMODIFIED + * + * Please change all references to sample, Sample, or SAMPLE to a name + * appropriate for your new Add-On. + * + * This file is used to add tabs to existing admin pages in the main + * plugin or other add-ons. If this add-on does not create additional + * tabs, this file should be omitted. + * + * Remove this message before using this file in production! + **********************************************************************/ + +/* + * To add a new tab to an existing Member DB page use a block + * like this and replace the {} parameters. + * + * add_filter('glm-member-db-add-tab-for-{menu name}', + * function($addOnTabs) { + * $newTabs = array( + * array( + * 'text' => '{text for display on tab}', + * 'menu' => '{menu name}', + * 'action' => '{action to perform}' + * ) + * ); + * $addOnTabs = array_merge($addOnTabs, $newTabs); + * return $addOnTabs; + * } + * ); + * + */ + + diff --git a/setup/databaseScripts/SAMPLE.create_database_V0.0.1.sql b/setup/databaseScripts/SAMPLE.create_database_V0.0.1.sql new file mode 100644 index 0000000..ae98344 --- /dev/null +++ b/setup/databaseScripts/SAMPLE.create_database_V0.0.1.sql @@ -0,0 +1,42 @@ +-- Gaslight Media Members Database - Sample +-- File Created: 12/02/15 15:27:15 +-- Database Version: 0.0.1 +-- Database Creation Script +-- +-- This file is called to create a new set of tables for this +-- add-on for the most receint database version for this add-on. +-- +-- There should only be one such file in this directory +-- +-- To permit each query below to be executed separately, +-- all queries must be separated by a line with four dashes + + +-- ********************************************************************** +-- NOTE: THIS IS A SAMPLE FILE - DO NOT USE UNMODIFIED +-- +-- Please change all references to sample, Sample, or SAMPLE to a name +-- appropriate for your new Add-On. +-- +-- Tables and queries in this file are sample only. +-- +-- Remove this message before using this file in production! +-- **********************************************************************/ + + +-- Sample Management Settings +CREATE TABLE {prefix}management ( + id INT NOT NULL AUTO_INCREMENT, + canonical_sample_page TINYTEXT NULL, -- Canonical page slug for detail + PRIMARY KEY (id) +); + +---- + +-- Set default sample management entry +INSERT INTO {prefix}management + ( id, canonical_sample_page ) + VALUES + ( 1, 'sample data' ) +; + diff --git a/setup/databaseScripts/SAMPLE.dbVersions.php b/setup/databaseScripts/SAMPLE.dbVersions.php new file mode 100644 index 0000000..c2b6a9f --- /dev/null +++ b/setup/databaseScripts/SAMPLE.dbVersions.php @@ -0,0 +1,40 @@ + + * @license http://www.gaslightmedia.com Gaslightmedia + * @release dbVersions.php,v 1.0 2014/10/31 19:31:47 cscott Exp $ + * @link http://dev.gaslightmedia.com/ + */ + + +/********************************************************************** + * NOTE: THIS IS A SAMPLE FILE - DO NOT USE UNMODIFIED + * + * Please change all references to sample, Sample, or SAMPLE to a name + * appropriate for your new Add-On. + * + * This file lists all versions of the database tables for this add-on. + * The last entry in the array below should be for the most recent + * version and should match the "create_database_V..." file in this + * directory. + * + * NOTE: When first creating a new add-on with database tables, there + * should only be one line in the array below and there should be no + * "update_database..." files in this directory. + * + * Remove this message before using this file in production! + **********************************************************************/ + + +$glmMembersSampleDbVersions = array( + '0.0.1' => array('version' => '0.0.1', 'tables' => 2), + '0.0.2' => array('version' => '0.0.2', 'tables' => 3) +); + diff --git a/setup/databaseScripts/SAMPLE.update_database_V0.0.2.php b/setup/databaseScripts/SAMPLE.update_database_V0.0.2.php new file mode 100644 index 0000000..c4ac161 --- /dev/null +++ b/setup/databaseScripts/SAMPLE.update_database_V0.0.2.php @@ -0,0 +1,54 @@ +wpdb->get_results('SELECT id, title FROM '.GLM_MEMBERS_SAMPLE_PLUGIN_DB_PREFIX.'samples;', ARRAY_A); + +// If there's any sample records +if ($sampleRecords && count($sampleRecords) > 0) { + + // For each sample record + foreach ($sampleRecords as $p) { + + // Create a slug from the title + $slug = sanitize_title($p['title']).'-'.$p['id']; + + // Store this value back into the record + $this->wpdb->update( + GLM_MEMBERS_SAMPLE_PLUGIN_DB_PREFIX.'samples', + array( + 'sample_slug' => $slug + ), + array( 'id' => $p['id'] ), + array( '%s' ), + array( '%d') + ); + } + +} diff --git a/setup/databaseScripts/SAMPLE.update_database_V0.0.2.sql b/setup/databaseScripts/SAMPLE.update_database_V0.0.2.sql new file mode 100644 index 0000000..286cb84 --- /dev/null +++ b/setup/databaseScripts/SAMPLE.update_database_V0.0.2.sql @@ -0,0 +1,30 @@ +-- Gaslight Media Members Database +-- File Created: 12/09/14 15:27:15 +-- Database Version: 0.0.2 +-- Database Update From Previous Version Script +-- +-- To permit each query below to be executed separately, +-- all queries must be separated by a line with four dashses + +-- Package Management Settings +CREATE TABLE {prefix}management ( + id INT NOT NULL AUTO_INCREMENT, + canonical_package_page TINYTEXT NULL, -- Canonical page slug for package detail + PRIMARY KEY (id) +); + +---- + +-- Set default package management entry +INSERT INTO {prefix}management + ( id, canonical_package_page ) + VALUES + ( 1, 'package-detail' ) +; + +---- + +ALTER TABLE {prefix}packages ADD COLUMN package_slug TINYTEXT; + + + diff --git a/setup/databaseScripts/readme.txt b/setup/databaseScripts/readme.txt new file mode 100644 index 0000000..ff3b4e7 --- /dev/null +++ b/setup/databaseScripts/readme.txt @@ -0,0 +1,4 @@ +This directory contains database creation and update scripts for this add-on. + +This directly is optional. If there are no data tables added by this add-on, +this directory should be omitted. diff --git a/setup/frontHooks.php b/setup/frontHooks.php new file mode 100644 index 0000000..f04d3c3 --- /dev/null +++ b/setup/frontHooks.php @@ -0,0 +1,39 @@ + + * @license http://www.gaslightmedia.com Gaslightmedia + * @release frontHooks.php,v 1.0 2014/10/31 19:31:47 cscott Exp $ + * @link http://dev.gaslightmedia.com/ + */ + +/********************************************************************** + * NOTE: THIS IS A SAMPLE FILE - DO NOT USE UNMODIFIED + * + * Please change all references to sample, Sample, or SAMPLE to a name + * appropriate for your new Add-On. + * + * This file is used to create hooks into the main plugin or other + * add-ons. If no such hooks are needed, this file may be omitted. + * + * Remove this message before using this file in production! + **********************************************************************/ + +/* + * Place Misc Hooks and Filters here. If this file exists, it will be included + * by the add-on main plugin script. + * + * Note that filter and hook callback functions must be included in-line as shown below... + * + * add_filter( 'filter_title', function( $parameter ) { + * // Function code + * }); + * + * *** Also note that parameters will be in the context of the main front controller constructor. *** + */ diff --git a/setup/hooksHelp.html b/setup/hooksHelp.html new file mode 100644 index 0000000..d768a5e --- /dev/null +++ b/setup/hooksHelp.html @@ -0,0 +1,70 @@ + + + +/********************************************************************** + * NOTE: THIS IS A SAMPLE FILE - DO NOT USE UNMODIFIED + * + * Please change all references to sample, Sample, or SAMPLE to a name + * appropriate for your new Add-On. + * + * This file is used to document hooks provided by this add-on. Content + * here will be displayed in the "Management" page "Hooks" tab. If + * there is no content for this page, this file should be omitted. + * + * Remove this message before using this file in production! + **********************************************************************/ + + +

Sample Add-On

+ + User Permission Hooks + + + glm_members_permit_admin_members_sample_tab + Filter + + + Returns boolean answer to "Is current user permitted to see multi-member Sample tab?" + + + + glm_members_permit_admin_members_Sample_add_sample + Filter + + + Returns boolean answer to "Is current user permitted to add a new multi-member sample?" + + + + glm_members_permit_admin_members_Sample_edit_sample + Filter + + + Returns boolean answer to "Is current user permitted to edit a multi-member sample?" + + + + glm_members_permit_admin_member_sample_tab + Filter + + + Returns boolean answer to "Is current user permitted to see the member Sample tab?" + + + + glm_members_permit_admin_member_Sample_add_sample + Filter + + + Returns boolean answer to "Is current user permitted to add a new Member sample?" + + + + glm_members_permit_admin_member_Sample_edit_sample + Filter + + + Returns boolean answer to "Is current user permitted to edit a member sample?" + + + diff --git a/setup/permissions.php b/setup/permissions.php new file mode 100644 index 0000000..8647b12 --- /dev/null +++ b/setup/permissions.php @@ -0,0 +1,56 @@ + + * @license http://www.gaslightmedia.com Gaslightmedia + * @release permissions.php,v 1.0 2014/10/31 19:31:47 cscott Exp $ + * @link http://dev.gaslightmedia.com/ + */ + + +/********************************************************************** + * NOTE: THIS IS A SAMPLE FILE - DO NOT USE UNMODIFIED + * + * Please change all references to sample, Sample, or SAMPLE to a name + * appropriate for your new Add-On. + * + * This file is used to add permission checks that can be used throught + * the main plugin and add-ons. If no such permissions are needed by + * this add-on, this file should be omitted. + * + * Remove this message before using this file in production! + **********************************************************************/ + +/* + * Below are permission checks for various specific things in this add-on and + * elsewhere in the Member DB main plugin and add-ons. + * + * Each location where a permission might be required has an apply_filters() + * hook with a tag name that includes the plugin or add-on name, the menu, + * the action, and a name for the specific thing that needs permissions. + * + * This can be included in code or in a Smarty template used in these plugins. + * For example, to check permissions for the main Members menu and it's "index" + * action to see if a member search is permitted, the template includes the + * following code... + * + * {if $membersList && apply_filters('glm_members_permit_admin_members_index_member_search', true)} + * --- some template output --- + * {/if} + * + * In the case above, it's also checking to see if the members list even exists + * before checking the permissions. The default value of "true" in the hook ensures + * that the permission is granted if nothing has linked into the hook to say otherwise. + * + * Note that each add_filter() below first checks if the permission has already + * been retracted by prior hook. This requires all that are attached to the hook + * to permit the action. + * + * Of course any of these may test more than one capability if that's desired. + */ diff --git a/setup/rolesAndCapabilities.php b/setup/rolesAndCapabilities.php new file mode 100644 index 0000000..06dce0a --- /dev/null +++ b/setup/rolesAndCapabilities.php @@ -0,0 +1,31 @@ + + * @license http://www.gaslightmedia.com Gaslightmedia + * @release rolesAndPermissions.php,v 1.0 2014/10/31 19:31:47 cscott Exp $ + * @link http://dev.gaslightmedia.com/ + */ + +/********************************************************************** + * NOTE: THIS IS A SAMPLE FILE - DO NOT USE UNMODIFIED + * + * Please change all references to sample, Sample, or SAMPLE to a name + * appropriate for your new Add-On. + * + * This file is used to add roles and capability. If none are required, + * this file should be omitted. + * + * Remove this message before using this file in production! + **********************************************************************/ + +/** + * NOTE: This file is only included in the activate.php process. + * It is not regularly used during operation. + */ diff --git a/setup/shortcodes.php b/setup/shortcodes.php new file mode 100644 index 0000000..dd7f9dc --- /dev/null +++ b/setup/shortcodes.php @@ -0,0 +1,77 @@ + + * @license http://www.gaslightmedia.com Gaslightmedia + * @release shortcodes.php,v 1.0 2014/10/31 19:31:47 cscott Exp $ + * @link http://dev.gaslightmedia.com/ + */ + +/********************************************************************** + * NOTE: THIS IS A SAMPLE FILE - DO NOT USE UNMODIFIED + * + * Please change all references to sample, Sample, or SAMPLE to a name + * appropriate for your new Add-On. + * + * This file is used to define shortcodes that will be handled by this + * add-0n. + * + * DO NOT DELETE THIS FILE EVEN IF THERE ARE NOT SHORTCODES + * + * Remove this message before using this file in production! + **********************************************************************/ + +/* + * Array of short-code + * + * This array lists all of the short-codes available from the main + * member plugin and all add-ons that provide short-code features. + * + * This array is merged with the data from any registered add-ons + * providing short-code features. The plugin providing the short-code + * is designated in the 'plugin' elemeent. + * + * A shortcode is unique to a particular plugin. To provide additional + * data and features to a short-code, an add-on should use filters + * provided by the short-code to insert data into the template array, + * to insert additional format into the template, or to insert + * text directly into the completed template output. + * + * The "attributes" array is a list of available attributes for this + * shortcode and their default values. If a database table is provided, + * then the value for each attribute is a table column where we get + * the default value. If no table is provided, then the value for + * each attribute is the actual default value for that attribute. + * In the case that the data is taken from the database table, the + * "id" for the table entry where the data is stored is assumed to + * be 1. + * + * Note that if the value for a particular attribute is false, then + * it is not read from the database even if the table is specified + * but might be supplied at run-time as an attribute in the short-code. + * All attributes that might be specified in the shortcode must be + * listed in the 'attributes' array below. If an attribute is not + * specified here, it can't be read from the short-code. + * + * The following is an explanation of this array. + * + * array( + * '{shortcode-slug} => array( + * 'plugin' => '{plugin (add-on) slug}', // Identifies which plugin is providing the short-code + * 'menu' => '{menu name}', // Menu name in this context is simply where to find the action + * 'action' => '{shortcode action name}, // Action used to execute this shortcode + * 'table' => '{table prefix}{table name}', // Database table where default attribute values are stored + * 'attributes' => array( // An array of all shortcode attributes (options) + * '{attr name}' => '{field name}', // Available attribute names and the database field names with the default value + * .... + * ), + * ... additional short-codes + * ) + * + */ diff --git a/setup/validActions.php b/setup/validActions.php new file mode 100644 index 0000000..5f5b3a2 --- /dev/null +++ b/setup/validActions.php @@ -0,0 +1,71 @@ + + * @license http://www.gaslightmedia.com Gaslightmedia + * @release admin.php,v 1.0 2014/10/31 19:31:47 cscott Exp $ + * @link http://dev.gaslightmedia.com/ + */ + +/********************************************************************** + * NOTE: THIS IS A SAMPLE FILE - DO NOT USE UNMODIFIED + * + * Please change all references to sample, Sample, or SAMPLE to a name + * appropriate for your new Add-On. + * + * This file is used to define valid actions for both admin and + * front-end pages. + * + * DO NOT DELETE THIS FILE EVEN IF THERE ARE NO ACTIONS + * + * Remove this message before using this file in production! + **********************************************************************/ + +/* + * Array of valid menu items and actions. + * + * The higher level elements are valid menu items. These correlate to + * actual menu or sub menu items that are hooks back to this controller + * class. + * + * The lower level items below each menu item are actions that may be specified + * by a "glmMembersAction" form field. + * + * The string after the action is the slug of the plugin where the model/view + * is to perform that action. + * + * This array is integrated into the valid actions array in the main GLM Member + * DB plugin when this plugin registers itself. + */ + +$glmMembersSampleAddOnValidActions = array( + 'adminActions' => array( +/* + 'members' => array( + 'sample' => GLM_MEMBERS_SAMPLE_PLUGIN_SLUG + ), + 'member' => array( + 'sample' => GLM_MEMBERS_SAMPLE_PLUGIN_SLUG + ), + 'management' => array( + 'sample' => GLM_MEMBERS_SAMPLE_PLUGIN_SLUG + ) +*/ + ), + 'frontActions' => array( +/* + 'sample' => array( + 'list' => GLM_MEMBERS_SAMPLE_PLUGIN_SLUG, + 'detail' => GLM_MEMBERS_SAMPLE_PLUGIN_SLUG + ) +*/ + ) +); + +?> \ No newline at end of file diff --git a/uninstall.php b/uninstall.php new file mode 100644 index 0000000..181a827 --- /dev/null +++ b/uninstall.php @@ -0,0 +1,36 @@ + + * @license http://www.gaslightmedia.com Gaslightmedia + * @release admin.php,v 1.0 2014/10/31 19:31:47 cscott Exp $ + * @link http://dev.gaslightmedia.com/ + */ + +/********************************************************************** + * NOTE: THIS IS A SAMPLE FILE - DO NOT USE UNMODIFIED + * + * Please change all references to sample, Sample, or SAMPLE to a name + * appropriate for your new Add-On. + * + * Remove this message before using this file in production! + **********************************************************************/ + +// Check that we're being called by WordPress. +if (!defined('ABSPATH')) { + die("Please do not call this code directly!"); +} + +//if uninstall not called from WordPress exit +if (!defined('WP_UNINSTALL_PLUGIN')) { + die("Sorry, uninstall must be called by WordPress!"); +} diff --git a/views/admin/readme.txt b/views/admin/readme.txt new file mode 100644 index 0000000..5a9d7ea --- /dev/null +++ b/views/admin/readme.txt @@ -0,0 +1,5 @@ +The admin controller uses views (templates) under this directory to generate final output. + +Typically you should add a directory here that matches the page where the view is used. + +Under that directory place the view (template) for the various actions. \ No newline at end of file diff --git a/views/front/readme.txt b/views/front/readme.txt new file mode 100644 index 0000000..1138d90 --- /dev/null +++ b/views/front/readme.txt @@ -0,0 +1,7 @@ +The front controller uses views (templates) under this directory to generate final output. + +Typically you should add a directory here that matches the category of actions that will use these views. + +Under that directory place the view (template) for the various actions. + +Views under this directory would normally be called due to processing of a shortcode. \ No newline at end of file