--- /dev/null
+<?php
+
+/**
+ * Gaslight Media Near-Me Add-On for GLM Associate
+ * Activate Plugin Tasks
+ *
+ * PHP version 5.5
+ *
+ * @category glmWordPressPlugin
+ * @package glmMembersNearMe
+ * @author Chuck Scott <cscott@gaslightmedia.com>
+ * @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/
+ */
+
+// 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 glmMembersNearMePluginActivate
+{
+
+ /**
+ * 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('glmMembersNearMePluginVersion', GLM_MEMBERS_NEARME_PLUGIN_VERSION);
+
+ // Set Roles and Capabilities for this plugin
+ require_once GLM_MEMBERS_NEARME_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);
+ }
+
+ }
+
+ }
+
+
+
+}
--- /dev/null
+Assets folder for things like images and other
+files that might need to be read directly.
\ No newline at end of file
--- /dev/null
+General class libraries developed specifically for this add-on should be placed in this directory.
+
+The lib directory should be considered instead for any standard class libraries not specifically developed for this add-on.
\ No newline at end of file
--- /dev/null
+;
+; Main Configuration File
+; {descrName}
+;
+; Place any static configuration parameters here.
+;
+
+[common]
--- /dev/null
+Add admin.css and/or front.css to this directory to have those registered automatically.
\ No newline at end of file
--- /dev/null
+<?php
+/**
+ * Gaslight Media Near-Me Add-On for GLM Associate
+ * Deactivate Plugin Tasks
+ *
+ * PHP version 5.5
+ *
+ * @category glmWordPressPlugin
+ * @package glmMembersNearMe
+ * @author Chuck Scott <cscott@gaslightmedia.com>
+ * @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/
+ */
+
+// 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 glmMembersNearMePluginDeactivate
+{
+
+ /**
+ * 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('glmMembersNearMePluginVersion');
+ }
+
+}
--- /dev/null
+<?php
+/**
+ * {DescrName}
+ *
+ * Set standard defined parameters
+ */
+
+// NOTE: Plugin & Database versions are defined in "/glm-member-db.php".
+
+define('GLM_MEMBERS_NEARME_PLUGIN_NAME', 'Gaslight Media Near-Me Add-On for GLM Associate');
+define('GLM_MEMBERS_NEARME_PLUGIN_SHORT_NAME', 'NearMe');
+define('GLM_MEMBERS_NEARME_PLUGIN_SLUG', 'glm-member-db-nearme');
+
+// Database table prefixes - change if using add-on tables
+global $wpdb;
+define('GLM_MEMBERS_NEARME_PLUGIN_DB_PREFIX', $wpdb->prefix.'glmMembersNearMe');
+define('GLM_MEMBERS_NEARME_PLUGIN_ACTIVE_DB_OPTION', 'glmMembersNearMeDbVersion');
+
+// Determine which system we're running on - If not provided, assume PRODUCTION
+$host = getenv('GLM_HOST_ID');
+if (trim($host) == '') {
+ $host = 'PRODUCTION';
+}
+define('GLM_MEMBERS_NEARME_PLUGIN_HOST', $host);
+
+// Determine current http/https protocol
+$pageProtocol = 'http';
+if (isset($_SERVER['SERVER_PORT']) && $_SERVER['SERVER_PORT'] == '443') {
+ $pageProtocol = 'https';
+}
+define('GLM_MEMBERS_NEARME_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();
+
+/*
+ * Create a copy of the plugin slug that can be used as a variable prefix used to keep
+ * global instances from clashing with instances in other plugins.
+ */
+$vprefix = str_replace('-', '_', GLM_MEMBERS_NEARME_PLUGIN_SLUG);
+define('GLM_MEMBERS_NEARME_PLUGIN_PREFIX', $vprefix.'_');
+
+// URLs
+define('GLM_MEMBERS_NEARME_SITE_BASE_URL', home_url('/') );
+define('GLM_MEMBERS_NEARME_PLUGIN_URL', plugin_dir_url(__FILE__));
+define('GLM_MEMBERS_NEARME_PLUGIN_ADMIN_URL', admin_url('admin.php'));
+define('GLM_MEMBERS_NEARME_PLUGIN_BASE_URL', WP_PLUGIN_URL.'/'.GLM_MEMBERS_NEARME_PLUGIN_SLUG);
+define('GLM_MEMBERS_NEARME_PLUGIN_CURRENT_URL', $urlParts['scheme'].'://'.$urlParts['host'].$pageUri[0]);
+
+// Directories
+define('GLM_MEMBERS_NEARME_PLUGIN_PATH', dirname(__FILE__));
+define('GLM_MEMBERS_NEARME_PLUGIN_SETUP_PATH', GLM_MEMBERS_NEARME_PLUGIN_PATH.'/setup');
+define('GLM_MEMBERS_NEARME_PLUGIN_DB_SCRIPTS', GLM_MEMBERS_NEARME_PLUGIN_SETUP_PATH.'/databaseScripts');
+define('GLM_MEMBERS_NEARME_PLUGIN_CLASS_PATH', GLM_MEMBERS_NEARME_PLUGIN_PATH.'/classes');
+define('GLM_MEMBERS_NEARME_PLUGIN_CONFIG_PATH', GLM_MEMBERS_NEARME_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_NEARME_PLUGIN_SLUG, '', GLM_MEMBERS_NEARME_PLUGIN_PATH);
+define('GLM_MEMBERS_NEARME_MAIN_PLUGIN_PATH', $pluginsPath.'/glm-member-db');
+define('GLM_MEMBERS_NEARME_PLUGIN_LIB_PATH', GLM_MEMBERS_NEARME_MAIN_PLUGIN_PATH.'/lib');
+
--- /dev/null
+<?php
+/**
+ * Plugin Name: GLM Members Database NearMe
+ * Plugin URI: http://www.gaslightmedia.com/
+ * Description: GLM Associate add-on that provides site users information on activities and offers near their current, or selected, location.
+ * Version: 0.0.1
+ * Author: Gaslight Media
+ * Author URI: http://www.gaslightmedia.com/
+ * License: GPL2
+ */
+
+/**
+ * Gaslight Media Near-Me Add-On for GLM Associate
+ * Index
+ *
+ * PHP version 5.5
+ *
+ * @category glmWordPressPluginChild
+ * @package glmMembersNearMeAddOn
+ * @author Chuck Scott <cscott@gaslightmedia.com>
+ * @license http://www.gaslightmedia.com Gaslightmedia
+ * @version 0.0.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_NEARME_PLUGIN_VERSION', '0.0.1');
+//define('GLM_MEMBERS_NEARME_PLUGIN_DB_VERSION', '0.0.1');
+
+// This is the minimum version of the GLM Members DB plugin require for this plugin.
+define('GLM_MEMBERS_NEARME_PLUGIN_MIN_MEMBERS_REQUIRED_VERSION', '2.8.0');
+
+// Check if plugin version is not current in WordPress option and if needed updated it
+if (GLM_MEMBERS_NEARME_PLUGIN_VERSION != get_option('glmMembersNearMePluginVersion')) {
+ update_option('glmMembersNearMePluginVersion', GLM_MEMBERS_NEARME_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';
+
+// Include defines to tell if a plugin is active
+include_once ABSPATH . 'wp-admin/includes/plugin.php';
+
+/*
+ * Do some preliminary sanity checks
+ */
+
+// Check if database version should be defined and it isn't - This would be a plugin/add-on setup issue
+if (is_file(GLM_MEMBERS_NEARME_PLUGIN_PATH.'/setup/databaseScripts/dbVersions.php') && !defined('GLM_MEMBERS_NEARME_PLUGIN_DB_VERSION')) {
+ die('You have database scripts but have not defined a current database version at the top of index.php for this plugin/add-on!');
+}
+
+/*
+ * Check installation, activation, and version of main Member DB plugin
+ */
+
+// Check for main plugin and that it's active
+function glmMembersNearMePluginRequired() {
+ echo '
+ <div class="error">
+ <p>The '.GLM_MEMBERS_NEARME_PLUGIN_NAME.' add-on requires the base GLM Member DB plugin to be installed and active!</p>
+ <p>The '.GLM_MEMBERS_NEARME_PLUGIN_NAME.' plugin has been de-activated.</p>
+ </div>
+ ';
+}
+$plugin_name = 'glm-member-db/index.php';
+$is_active = is_plugin_active($plugin_name);
+if ($is_active != '1') {
+ add_action( 'admin_notices', 'glmMembersNearMePluginRequired' );
+ deactivate_plugins('/'.GLM_MEMBERS_NEARME_PLUGIN_SLUG.'/index.php');
+}
+
+// Check for Minimum DB version for main Member DB
+function glmMembersNearMeMinVerRequired() {
+ echo '
+ <div class="error">
+ <p>The '.GLM_MEMBERS_NEARME_PLUGIN_NAME.' requires that the main GLM Member DB plugin version be no older than '
+ .GLM_MEMBERS_NEARME_PLUGIN_MIN_MEMBERS_REQUIRED_VERSION.'!<br>
+ '.GLM_MEMBERS_NEARME_MIN_VERSION_NOTE.'</p>
+ <p>The '.GLM_MEMBERS_NEARME_PLUGIN_NAME.' plugin has been de-activated.</p>
+ </div>
+ ';
+}
+$glmMembersDatabasePluginVersion = get_option('glmMembersDatabasePluginVersion');
+if (version_compare($glmMembersDatabasePluginVersion, GLM_MEMBERS_NEARME_PLUGIN_MIN_MEMBERS_REQUIRED_VERSION) < 0) {
+ define('GLM_MEMBERS_NEARME_MIN_VERSION_NOTE', "Members DB: $glmMembersDatabasePluginVersion, NearMe Requires: ".GLM_MEMBERS_NEARME_PLUGIN_MIN_MEMBERS_REQUIRED_VERSION);
+ add_action( 'admin_notices', 'glmMembersNearMeMinVerRequired');
+ deactivate_plugins('/'.GLM_MEMBERS_NEARME_PLUGIN_SLUG.'/'.GLM_MEMBERS_NEARME_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_NEARME_PLUGIN_SETUP_PATH.'/validActions.php';
+require_once GLM_MEMBERS_NEARME_PLUGIN_SETUP_PATH.'/shortcodes.php';
+if (is_file(GLM_MEMBERS_NEARME_PLUGIN_DB_SCRIPTS.'/dbVersions.php')) {
+ require_once GLM_MEMBERS_NEARME_PLUGIN_DB_SCRIPTS.'/dbVersions.php';
+}
+
+// Load Add-On Management Settings data
+/* None - Need to figure out a smooth way to do this.
+$glmMembersNearMeManagementSettings = $wpdb->get_row( "SELECT * FROM ".GLM_MEMBERS_NEARME_PLUGIN_DB_PREFIX."management WHERE id = 1", ARRAY_A );
+unset($glmMembersNearMeManagementSettings['id']);
+*/
+
+function glmMembersNearMeRegisterAddOn($addOns) {
+
+ // Add this add-on to the add-ons array
+ $addOns[GLM_MEMBERS_NEARME_PLUGIN_SLUG] = array(
+ 'dir' => GLM_MEMBERS_NEARME_PLUGIN_PATH,
+ 'name' => GLM_MEMBERS_NEARME_PLUGIN_NAME,
+ 'short_name' => GLM_MEMBERS_NEARME_PLUGIN_SHORT_NAME,
+ 'slug' => GLM_MEMBERS_NEARME_PLUGIN_SLUG,
+ 'actions' => $GLOBALS['glmMembersNearMeAddOnValidActions'],
+ 'config' => array(
+ ),
+ 'shortcodes' => $GLOBALS['glmMembersNearMeShortcodes'],
+ 'shortcodesDescription' => $GLOBALS['glmMembersNearMeShortcodesDescription']
+ );
+
+ // If we have database tables for this plugin/addon, provide that data also
+ if (isset($GLOBALS['glmMembersNearMeDbVersions'])) {
+ $addOns[GLM_MEMBERS_NEARME_PLUGIN_SLUG]['database'] = array(
+ 'dbPrefix' => GLM_MEMBERS_NEARME_PLUGIN_DB_PREFIX,
+ 'dbCurrentVersion' => GLM_MEMBERS_NEARME_PLUGIN_DB_VERSION,
+ 'dbActiveVersionOption' => GLM_MEMBERS_NEARME_PLUGIN_ACTIVE_DB_OPTION,
+ 'dbScriptPath' => GLM_MEMBERS_NEARME_PLUGIN_DB_SCRIPTS,
+ 'dbVersions' => $GLOBALS['glmMembersNearMeDbVersions']
+ );
+ } else {
+ $addOns[GLM_MEMBERS_NEARME_PLUGIN_SLUG]['database'] = false;
+ }
+
+ // Return the array with our data added
+ return $addOns;
+}
+add_filter('glm-member-db-register-addon','glmMembersNearMeRegisterAddOn', 10, 1);
+
+/*
+ * Plugin Update Support - uses Gaslight Media update server
+ */
+/* Not functional yet - Need to resolve JavaScript conflicts with this feature in other plugins
+require GLM_MEMBERS_NEARME_PLUGIN_LIB_PATH.'/opentools-update-checker/opentools-update-checker.php';
+${GLM_MEMBERS_NEARME_PLUGIN_PREFIX."updateChecker"} = new OpenToolsPluginUpdateChecker(
+ 'http://www.gaslightmedia.com/update_server/?action=get_metadata&slug='.GLM_MEMBERS_NEARME_PLUGIN_SLUG,
+ __FILE__,
+ GLM_MEMBERS_NEARME_PLUGIN_SLUG
+);
+
+${GLM_MEMBERS_NEARME_PLUGIN_PREFIX."updateChecker"}->declareCredentials(array(
+ 'license_key' => __('License Key:')
+));
+*/
+
+/*
+ *
+ * Activate and Deactivate hooks
+ *
+ */
+
+ // Activate
+ function glmMembersNearMePluginActivate ()
+ {
+ global $wpdb, $config;
+ require_once GLM_MEMBERS_NEARME_PLUGIN_PATH . '/activate.php';
+ new glmMembersNearMePluginActivate($wpdb, $config);
+ }
+ register_activation_hook(__FILE__, 'glmMembersNearMePluginActivate');
+
+ // Deactivate
+ function glmMembersNearMePluginDeactivate ()
+ {
+ global $wpdb, $config;
+ require_once GLM_MEMBERS_NEARME_PLUGIN_PATH . '/deactivate.php';
+ $x = new glmMembersNearMePluginDeactivate($wpdb, $config);
+ return false;
+ }
+ register_deactivation_hook(__FILE__, 'glmMembersNearMePluginDeactivate');
+
+/*
+ * Hooks for testing capabilities provided by this add-on
+ */
+require_once GLM_MEMBERS_NEARME_PLUGIN_SETUP_PATH.'/permissions.php';
+
--- /dev/null
+Add admin.js and/or front.js to this directory to have those registered automatically.
\ No newline at end of file
--- /dev/null
+Standard class libraries not specifically developed for this add-on should be placed here.
+
+The classes directory should be considered instead for class libraries developed specifically for this add-on.
--- /dev/null
+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
--- /dev/null
+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}
+
+* From a bash prompt, run "SETUP_SCRIPT"
+
+* 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
--- /dev/null
+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
--- /dev/null
+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
--- /dev/null
+=== Gaslight Media Near-Me Add-On for GLM Associate ===
+Contributors: cscott@gaslightmedia.com
+Donate link: http://www.gaslightmedia.com
+Tags: Gaslight Media,Plugin,NearMe
+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 Near-Me Add-On for GLM Associate.
+
+== Description ==
+
+The Gaslight Media Near-Me Add-On for GLM Associate 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
+
+
--- /dev/null
+<?php
+/**
+ * Gaslight Media Near-Me Add-On for GLM Associate
+ * GLM Members Misc Admin Hooks and Filters
+ *
+ * PHP version 5.5
+ *
+ * @category glmWordPressPlugin
+ * @package glmMembersDatabase
+ * @author Chuck Scott <cscott@gaslightmedia.com>
+ * @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/
+ */
+
+/*
+ * 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.
+ */
--- /dev/null
+<?php
+/**
+ * Gaslight Media Near-Me Add-On for GLM Associate
+ * GLM Members DB - NearMe - Admin Menus
+ *
+ * PHP version 5.5
+ *
+ * @category glmWordPressPlugin
+ * @package glmMembersDatabase
+ * @author Chuck Scott <cscott@gaslightmedia.com>
+ * @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/
+ */
+
+/*
+ * Added menus or sub-menus examples
+ *
+ * // Add a main menu item
+ * add_menu_page(
+ * 'GLM Sample', // Page Title
+ * 'GLM Sample', // Menu Title
+ * 'glm-members-members', // Capability
+ * 'glm-members-admin-menu-glm-sample', // Menu Slug
+ * function() {$this->controller('sample');}, // Called function - typically controller() with the menu name
+ * false, // Icon URL
+ * '92' // Menu Position
+ * );
+ *
+ * // Add a sub-menu item
+ * add_submenu_page(
+ * 'glm-members-admin-menu-sample', // 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.
+ *
+ * NOTE: The menu slug is the link for the page. It is also parsed by
+ * the controller and used to find the model to load. The
+ * "glm-members-admin-menu-" portion should not change, the last
+ * segment is the model directory name. By default the "index.php" file
+ * in that directory is executed. If the URL includes a "glm_action"
+ * parameter, then the model file called is in the same directory but
+ * is named the same as the "glm_action" parameter.
+ *
+ */
+
--- /dev/null
+<?php
+/**
+ * Gaslight Media Near-Me Add-On for GLM Associate
+ * GLM Members DB - NearMe - Admin Tabs
+ *
+ * PHP version 5.5
+ *
+ * @category glmWordPressPlugin
+ * @package glmMembersDatabase
+ * @author Chuck Scott <cscott@gaslightmedia.com>
+ * @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/
+ */
+
+/*
+ * 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;
+ * }
+ * );
+ *
+ */
+
--- /dev/null
+<?php
+/**
+ * Gaslight Media Near-Me Add-On for GLM Associate
+ * Misc Hooks and Filters
+ *
+ * PHP version 5.5
+ *
+ * @category glmWordPressPlugin
+ * @package glmMembersDatabase
+ * @author Chuck Scott <cscott@gaslightmedia.com>
+ * @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/
+ */
+
+/*
+ * 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. ***
+ */
--- /dev/null
+<!-- Hooks Help for {descrName} with Example
+
+ <tr><th colspan="3" class="glm-notice"><p>Sample Add-On</p></th></tr>
+
+ <tr><th colspan="3">User Permission Hooks</td></tr>
+
+ <tr>
+ <td>some_hook_name</td>
+ <td>FILTER or ACTION</td>
+ <td></td>
+ <td>
+ What this hook does.
+ </td>
+ </tr>
+
+-->
\ No newline at end of file
--- /dev/null
+<?php
+/**
+ * {descrName
+ * Permissions
+ *
+ * PHP version 5.5
+ *
+ * @category glmWordPressPlugin
+ * @package glmMembersDatabase
+ * @author Chuck Scott <cscott@gaslightmedia.com>
+ * @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/
+ */
+
+
+/*
+ * 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.
+ *
+ * Since we have capabilities that only exist if a particular add-on (such as Contacts)
+ * has been loaded and activated, it can be helpful to be able to test for a capability
+ * for the current user and permit some action if that capability doesn't exist. The
+ * main plugin therefore provides the following globally accessible function that will
+ * return true if the capability doesn't exist, otherwise it respects the capability.
+ *
+ * glmMembersUserCan('glm_members_edit_any_member', $permit);
+ *
+ * $permit is a boolean set before this function call for passing on permissions.
+*/
--- /dev/null
+<?php
+/**
+ * Gaslight Media Near-Me Add-On for GLM Associate
+ * Roles & Capabilities
+ *
+ * PHP version 5.5
+ *
+ * @category glmWordPressPlugin
+ * @package glmMembersNearMe
+ * @author Chuck Scott <cscott@gaslightmedia.com>
+ * @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 file is only included in the activate.php process.
+ * It is not regularly used during operation.
+ */
--- /dev/null
+<?php
+/**
+ * Gaslight Media Near-Me Add-On for GLM Associate
+ * Short Codes
+ *
+ * PHP version 5.5
+ *
+ * @category glmWordPressPlugin
+ * @package glmMembersNearMe
+ * @author Chuck Scott <cscott@gaslightmedia.com>
+ * @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/
+ */
+
+/*
+ * 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
+ * )
+ *
+ * Shortcode descriptions sample
+ *
+ * <tr>
+ * <th>[glm-members-sample-shortcode]</th>
+ * <td> </td>
+ * <td width="50%">
+ * Displays something related to this add-on.
+ * </td>
+ * </tr>
+ * <tr>
+ * <td> </td>
+ * <th>type="{types}"</th>
+ * <td>
+ * The "type" attribute is used to select the type of data to be displayed.
+ * Below is a list of available list types.
+ * <p>
+ * <table width="100%">
+ * <tr><th colspan=3">List Types</th></tr>
+ * <tr><td>one</td><td>Type One</td></tr>
+ * <tr><td>two</td><td>Type Two</td></tr>
+ * </table>
+ * </p>
+ * </td>
+ * </tr>
+ */
+
+$glmMembersNearMeShortcodes = array(
+);
+
+$glmMembersNearMeShortcodesDescription = '';
+
--- /dev/null
+<?php
+/**
+ * Gaslight Media Near-Me Add-On for GLM Associate
+ * Valid Actions
+ *
+ * PHP version 5.5
+ *
+ * @category glmWordPressPlugin
+ * @package glmMembersNearMe
+ * @author Chuck Scott <cscott@gaslightmedia.com>
+ * @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/
+ */
+
+/*
+ * 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.
+ *
+ * EXAMPLE
+ *
+ * $glmMembersNearMeAddOnValidActions = array(
+ * 'adminActions' => array(
+ * 'members' => array(
+ * 'sample' => GLM_MEMBERS_NEARME_PLUGIN_SLUG,
+ * ),
+ * 'sample' => array(
+ * 'index' => GLM_MEMBERS_NEARME_PLUGIN_SLUG,
+ * 'more' => GLM_MEMBERS_NEARME_PLUGIN_SLUG,
+ * ),
+ * 'info' => array(
+ * 'index' => GLM_MEMBERS_NEARME_PLUGIN_SLUG
+ * )
+ * ),
+ * 'frontActions' => array(
+ * 'sample' => array(
+ * 'list' => GLM_MEMBERS_NEARME_PLUGIN_SLUG,
+ * 'detail' => GLM_MEMBERS_NEARME_PLUGIN_SLUG
+ * )
+ * )
+ * );
+ *
+ *
+ *
+ *
+ */
+
+$glmMembersNearMeAddOnValidActions = array(
+ 'adminActions' => array(
+ ),
+ 'frontActions' => array(
+ )
+);
+
+?>
\ No newline at end of file
--- /dev/null
+<?php
+
+die('uninstall not configured - See plugin uninstall.php script!');
+
+/**
+ * Gaslight Media Near-Me Add-On for GLM Associate
+ * Uninstall Plugin
+ *
+ * PHP version 5.5
+ *
+ * @category glmWordPressPlugin
+ * @package glmMembersNearMe
+ * @author Chuck Scott <cscott@gaslightmedia.com>
+ * @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/
+ */
+
+// 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!");
+}
--- /dev/null
+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
--- /dev/null
+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