settings.php

<?php

if( $_SERVER['SCRIPT_FILENAME'] == __FILE__ )
	die( 'Access denied.' );

if( !class_exists( 'BGMPSettings' ) )
{
	/**
	 * Registers and handles the plugin's settings
	 *
	 * @package BasicGoogleMapsPlacemarks
	 * @author Ian Dunn <ian@iandunn.name>
	 * @link http://wordpress.org/extend/plugins/basic-google-maps-placemarks/
	 */
	class BGMPSettings
	{
		public $mapWidth, $mapHeight, $mapAddress, $mapLatitude, $mapLongitude, $mapZoom, $mapType, $mapTypes, $mapTypeControl, $mapNavigationControl, $mapInfoWindowMaxWidth;
					
		/**
		 * Constructor
		 * @author Ian Dunn <ian@iandunn.name>
		 * @param object BasicGoogleMapsPlacemarks object
		 */
		public function __construct()
		{
			add_action( 'init',			array( $this, 'init' ), 9 );	// lower priority so that variables defined here will be available to other init callbacks
			add_action( 'init',			array( $this, 'updateMapCoordinates' ) );
			add_action( 'admin_menu',	array( $this, 'addSettingsPage' ) );
			add_action( 'admin_init',	array( $this, 'addSettings') );			// @todo - this may need to fire after admin_menu
			
			add_filter( 'plugin_action_links_basic-google-maps-placemarks/basic-google-maps-placemarks.php', array( $this, 'addSettingsLink' ) );
		}		
		
		/**
		 * Performs various initialization functions
		 * @author Ian Dunn <ian@iandunn.name>
		 */
		public function init()
		{
			// @todo saving this as a single array instead of separate options
			
			$this->mapWidth					= get_option( BasicGoogleMapsPlacemarks::PREFIX . 'map-width',				600 );
			$this->mapHeight				= get_option( BasicGoogleMapsPlacemarks::PREFIX . 'map-height',				400 );
			$this->mapAddress				= get_option( BasicGoogleMapsPlacemarks::PREFIX . 'map-address',			__( 'Seattle', 'bgmp' ) );
			$this->mapLatitude				= get_option( BasicGoogleMapsPlacemarks::PREFIX . 'map-latitude',			47.6062095 );
			$this->mapLongitude				= get_option( BasicGoogleMapsPlacemarks::PREFIX . 'map-longitude',			-122.3320708 );
			$this->mapZoom					= get_option( BasicGoogleMapsPlacemarks::PREFIX . 'map-zoom',				7 );
			$this->mapType					= get_option( BasicGoogleMapsPlacemarks::PREFIX . 'map-type',				'ROADMAP' );
			
			$this->mapTypes					= array(
				'ROADMAP'	=> __( 'Street Map', 'bgmp' ),
				'SATELLITE'	=> __( 'Satellite Images', 'bgmp' ),
				'HYBRID'	=> __( 'Hybrid', 'bgmp' ),
				'TERRAIN'	=> __( 'Terrain', 'bgmp' )
			);
			
			$this->mapTypeControl			= get_option( BasicGoogleMapsPlacemarks::PREFIX . 'map-type-control',		'off' );
			$this->mapNavigationControl		= get_option( BasicGoogleMapsPlacemarks::PREFIX . 'map-navigation-control',	'DEFAULT' );
			$this->mapInfoWindowMaxWidth	= get_option( BasicGoogleMapsPlacemarks::PREFIX . 'map-info-window-width',	500 );
			
			$this->markerClustering			= get_option( BasicGoogleMapsPlacemarks::PREFIX . 'marker-clustering', 		'' );
			$this->clusterMaxZoom			= get_option( BasicGoogleMapsPlacemarks::PREFIX . 'cluster-max-zoom', 		'7' );
			$this->clusterGridSize			= get_option( BasicGoogleMapsPlacemarks::PREFIX . 'cluster-grid-size', 		'40' );
			$this->clusterStyle				= get_option( BasicGoogleMapsPlacemarks::PREFIX . 'cluster-style', 			'default' );
			
			// @todo - this isn't DRY, same values in BGMP::singleActivate() and upgrade()
		}
		
		/**
		 * Get the map center coordinates from the address and update the database values
		 * The latitude/longitude need to be updated when the address changes, but there's no way to do that with the settings API
		 *
		 * @author Ian Dunn <ian@iandunn.name>
		 */
		public function updateMapCoordinates()
		{
			// @todo - this could be done during a settings validation callback?
			global $bgmp;
			
			$haveCoordinates = true;
			
			if( isset( $_POST[ BasicGoogleMapsPlacemarks::PREFIX . 'map-address' ] ) )
			{
				if( empty( $_POST[ BasicGoogleMapsPlacemarks::PREFIX . 'map-address' ] ) )
					$haveCoordinates = false;
				else
				{
					$coordinates = $bgmp->geocode( $_POST[ BasicGoogleMapsPlacemarks::PREFIX . 'map-address'] );
				
					if( !$coordinates )
						$haveCoordinates = false;
				}
				
				if( $haveCoordinates )
				{
					update_option( BasicGoogleMapsPlacemarks::PREFIX . 'map-latitude', $coordinates['latitude'] );
					update_option( BasicGoogleMapsPlacemarks::PREFIX . 'map-longitude', $coordinates['longitude'] );
				}
				else
				{
					// @todo - can't call protected from this class - $this->bgmp->enqueueMessage('That address couldn\'t be geocoded, please make sure that it\'s correct.', 'error' );
					
					update_option( BasicGoogleMapsPlacemarks::PREFIX . 'map-latitude', '' );	// @todo - update these
					update_option( BasicGoogleMapsPlacemarks::PREFIX . 'map-longitude', '' );
				}
			}
		}
		
		/**
		 * Adds a page to Settings menu
		 * @author Ian Dunn <ian@iandunn.name>
		 */
		public function addSettingsPage()
		{
			add_options_page( BGMP_NAME .' Settings', BGMP_NAME, 'manage_options', BasicGoogleMapsPlacemarks::PREFIX . 'settings', array( $this, 'markupSettingsPage' ) );
			add_meta_box( BasicGoogleMapsPlacemarks::PREFIX . 'rasr-plug', __( 'Re-Abolish Slavery', 'bgmp' ), array( $this, 'markupRASRMetaBox' ), 'settings_page_' . BasicGoogleMapsPlacemarks::PREFIX .'settings', 'side' );
		}
		
		/**
		 * Creates the markup for the settings page
		 * @author Ian Dunn <ian@iandunn.name>
		 */
		public function markupSettingsPage()
		{
			$rasrMetaBoxID = BasicGoogleMapsPlacemarks::PREFIX . 'rasr-plug';
			$rasrMetaBoxPage = BasicGoogleMapsPlacemarks::PREFIX . 'settings';	// @todo better var name
			$hidden = get_hidden_meta_boxes( $rasrMetaBoxPage );
			$hidden_class = in_array( $rasrMetaBoxPage, $hidden ) ? ' hide-if-js' : '';
			
			// @todo some of above may not be needed
			
			if( current_user_can( 'manage_options' ) )
				require_once( dirname(__FILE__) . '/views/settings.php' );
			else
				wp_die( 'Access denied.' );
		}
		
		/**
		 * Creates the markup for the Re-Abolish Slavery Ribbon meta box
		 * @author Ian Dunn <ian@iandunn.name>
		 */
		public function markupRASRMetaBox()
		{
			require_once( dirname(__FILE__) . '/views/meta-re-abolish-slavery.php' );
		}
		
		/**
		 * Adds a 'Settings' link to the Plugins page
		 * @author Ian Dunn <ian@iandunn.name>
		 * @param array $links The links currently mapped to the plugin
		 * @return array
		 */
		public function addSettingsLink( $links )
		{
			array_unshift( $links, '<a href="http://wordpress.org/extend/plugins/basic-google-maps-placemarks/faq/">'. __( 'Help', 'bgmp' ) .'</a>' );
			array_unshift( $links, '<a href="options-general.php?page='. BasicGoogleMapsPlacemarks::PREFIX . 'settings">'. __( 'Settings', 'bgmp' ) .'</a>' );
			
			return $links; 
		}
		
		/**
		 * Adds our custom settings to the admin Settings pages
		 * We intentionally don't register the map-latitude and map-longitude settings because they're set by updateMapCoordinates()
		 *
		 * @author Ian Dunn <ian@iandunn.name>
		 */
		public function addSettings()
		{
			add_settings_section( BasicGoogleMapsPlacemarks::PREFIX . 'map-settings',				'', array( $this, 'markupSettingsSections' ), BasicGoogleMapsPlacemarks::PREFIX . 'settings' );
			add_settings_section( BasicGoogleMapsPlacemarks::PREFIX . 'marker-cluster-settings',	'', array( $this, 'markupSettingsSections' ), BasicGoogleMapsPlacemarks::PREFIX . 'settings' );
			
			
			// Map Settings
			add_settings_field( BasicGoogleMapsPlacemarks::PREFIX . 'map-width',				__( 'Map Width', 'bgmp' ),					array( $this, 'markupMapSettingsFields' ),	BasicGoogleMapsPlacemarks::PREFIX . 'settings', BasicGoogleMapsPlacemarks::PREFIX . 'map-settings',	 array( 'label_for' => BasicGoogleMapsPlacemarks::PREFIX . 'map-width' ) );
			add_settings_field( BasicGoogleMapsPlacemarks::PREFIX . 'map-height',				__( 'Map Height', 'bgmp' ),					array( $this, 'markupMapSettingsFields' ),	BasicGoogleMapsPlacemarks::PREFIX . 'settings', BasicGoogleMapsPlacemarks::PREFIX . 'map-settings',	 array( 'label_for' => BasicGoogleMapsPlacemarks::PREFIX . 'map-height' ) );
			add_settings_field( BasicGoogleMapsPlacemarks::PREFIX . 'map-address',				__( 'Map Center Address', 'bgmp' ),			array( $this, 'markupMapSettingsFields' ),	BasicGoogleMapsPlacemarks::PREFIX . 'settings', BasicGoogleMapsPlacemarks::PREFIX . 'map-settings',	 array( 'label_for' => BasicGoogleMapsPlacemarks::PREFIX . 'map-address' ) );
			add_settings_field( BasicGoogleMapsPlacemarks::PREFIX . 'map-zoom',					__( 'Zoom', 'bgmp' ),						array( $this, 'markupMapSettingsFields' ),	BasicGoogleMapsPlacemarks::PREFIX . 'settings', BasicGoogleMapsPlacemarks::PREFIX . 'map-settings',	 array( 'label_for' => BasicGoogleMapsPlacemarks::PREFIX . 'map-zoom' ) );
			add_settings_field( BasicGoogleMapsPlacemarks::PREFIX . 'map-type',					__( 'Map Type', 'bgmp' ),					array( $this, 'markupMapSettingsFields' ),	BasicGoogleMapsPlacemarks::PREFIX . 'settings', BasicGoogleMapsPlacemarks::PREFIX . 'map-settings',	 array( 'label_for' => BasicGoogleMapsPlacemarks::PREFIX . 'map-type' ) );			
			add_settings_field( BasicGoogleMapsPlacemarks::PREFIX . 'map-type-control',			__( 'Type Control', 'bgmp' ),				array( $this, 'markupMapSettingsFields' ),	BasicGoogleMapsPlacemarks::PREFIX . 'settings', BasicGoogleMapsPlacemarks::PREFIX . 'map-settings',	 array( 'label_for' => BasicGoogleMapsPlacemarks::PREFIX . 'map-type-control' ) );
			add_settings_field( BasicGoogleMapsPlacemarks::PREFIX . 'map-navigation-control',	__( 'Navigation Control', 'bgmp' ),			array( $this, 'markupMapSettingsFields' ),	BasicGoogleMapsPlacemarks::PREFIX . 'settings', BasicGoogleMapsPlacemarks::PREFIX . 'map-settings',	 array( 'label_for' => BasicGoogleMapsPlacemarks::PREFIX . 'map-navigation-control' ) );
			add_settings_field( BasicGoogleMapsPlacemarks::PREFIX . 'map-info-window-width',	__( 'Info. Window Maximum Width', 'bgmp' ),	array( $this, 'markupMapSettingsFields' ),	BasicGoogleMapsPlacemarks::PREFIX . 'settings', BasicGoogleMapsPlacemarks::PREFIX . 'map-settings',	 array( 'label_for' => BasicGoogleMapsPlacemarks::PREFIX . 'map-info-window-width' ) );
			
			register_setting( BasicGoogleMapsPlacemarks::PREFIX . 'settings', BasicGoogleMapsPlacemarks::PREFIX . 'map-width' );
			register_setting( BasicGoogleMapsPlacemarks::PREFIX . 'settings', BasicGoogleMapsPlacemarks::PREFIX . 'map-height' );
			register_setting( BasicGoogleMapsPlacemarks::PREFIX . 'settings', BasicGoogleMapsPlacemarks::PREFIX . 'map-address' );
			register_setting( BasicGoogleMapsPlacemarks::PREFIX . 'settings', BasicGoogleMapsPlacemarks::PREFIX . 'map-zoom' );
			register_setting( BasicGoogleMapsPlacemarks::PREFIX . 'settings', BasicGoogleMapsPlacemarks::PREFIX . 'map-type' );
			register_setting( BasicGoogleMapsPlacemarks::PREFIX . 'settings', BasicGoogleMapsPlacemarks::PREFIX . 'map-type-control' );
			register_setting( BasicGoogleMapsPlacemarks::PREFIX . 'settings', BasicGoogleMapsPlacemarks::PREFIX . 'map-navigation-control' );
			register_setting( BasicGoogleMapsPlacemarks::PREFIX . 'settings', BasicGoogleMapsPlacemarks::PREFIX . 'map-info-window-width' );
			
			
			// Marker Clustering
			add_settings_field( BasicGoogleMapsPlacemarks::PREFIX . 'marker-clustering',	__( 'Marker Clustering', 'bgmp' ),	array( $this, 'markupMarkerClusterFields' ),	BasicGoogleMapsPlacemarks::PREFIX . 'settings', BasicGoogleMapsPlacemarks::PREFIX . 'marker-cluster-settings',	 array( 'label_for' => BasicGoogleMapsPlacemarks::PREFIX . 'marker-clustering' ) );
			add_settings_field( BasicGoogleMapsPlacemarks::PREFIX . 'cluster-max-zoom',		__( 'Max Zoom', 'bgmp' ),			array( $this, 'markupMarkerClusterFields' ),	BasicGoogleMapsPlacemarks::PREFIX . 'settings', BasicGoogleMapsPlacemarks::PREFIX . 'marker-cluster-settings',	 array( 'label_for' => BasicGoogleMapsPlacemarks::PREFIX . 'cluster-max-zoom' ) );
			add_settings_field( BasicGoogleMapsPlacemarks::PREFIX . 'cluster-grid-size',	__( 'Grid Size', 'bgmp' ),			array( $this, 'markupMarkerClusterFields' ),	BasicGoogleMapsPlacemarks::PREFIX . 'settings', BasicGoogleMapsPlacemarks::PREFIX . 'marker-cluster-settings',	 array( 'label_for' => BasicGoogleMapsPlacemarks::PREFIX . 'cluster-grid-size' ) );
			add_settings_field( BasicGoogleMapsPlacemarks::PREFIX . 'cluster-style',		__( 'Style', 'bgmp' ),				array( $this, 'markupMarkerClusterFields' ),	BasicGoogleMapsPlacemarks::PREFIX . 'settings', BasicGoogleMapsPlacemarks::PREFIX . 'marker-cluster-settings',	 array( 'label_for' => BasicGoogleMapsPlacemarks::PREFIX . 'cluster-style' ) );
			
			register_setting( BasicGoogleMapsPlacemarks::PREFIX . 'settings', BasicGoogleMapsPlacemarks::PREFIX . 'marker-clustering' );
			register_setting( BasicGoogleMapsPlacemarks::PREFIX . 'settings', BasicGoogleMapsPlacemarks::PREFIX . 'cluster-max-zoom' );
			register_setting( BasicGoogleMapsPlacemarks::PREFIX . 'settings', BasicGoogleMapsPlacemarks::PREFIX . 'cluster-grid-size' );
			register_setting( BasicGoogleMapsPlacemarks::PREFIX . 'settings', BasicGoogleMapsPlacemarks::PREFIX . 'cluster-style' );
			
			
			// @todo - add input validation  -- http://ottopress.com/2009/wordpress-settings-api-tutorial/
		}
		
		/**
		 * Adds the markup for the  section introduction text to the Settings page
		 * @author Ian Dunn <ian@iandunn.name>
		 * @param array $section
		 */
		public function markupSettingsSections( $section )
		{
			// @todo move this to an external view file
			
			switch( $section[ 'id' ] )
			{
				case BasicGoogleMapsPlacemarks::PREFIX . 'map-settings':
					echo '<h3>'. __( 'Map Settings', 'bgmp' ) .'</h3>';
					echo '<p>'. __( 'The map(s) will use these settings as defaults, but you can override them on individual maps using shortcode arguments. See <a href="http://wordpress.org/extend/plugins/basic-google-maps-placemarks/installation/">the Installation page</a> for details.', 'bgmp' ) .'</p>';
				break;
				
				case BasicGoogleMapsPlacemarks::PREFIX . 'marker-cluster-settings':
					echo '<h3>'. __( 'Marker Clustering', 'bgmp' ) .'</h3>';
					echo '<p>'. __( 'You can group large numbers of markers into a single cluster by enabling the Cluster Markers option.', 'bgmp' ) .'</p>';
				break;
			}
		}
		
		/**
		 * Adds the markup for the all of the fields in the Map Settings section
		 * @author Ian Dunn <ian@iandunn.name>
		 * @param array $field
		 */
		public function markupMapSettingsFields( $field )
		{
			// @todo move this to an external view file
			
			switch( $field[ 'label_for' ] )
			{
				case BasicGoogleMapsPlacemarks::PREFIX . 'map-width':
					echo '<input id="'. BasicGoogleMapsPlacemarks::PREFIX .'map-width" name="'. BasicGoogleMapsPlacemarks::PREFIX .'map-width" type="text" value="'. $this->mapWidth .'" class="small-text" /> ';
					_e( 'pixels', 'bgmp' );
				break;
				
				case BasicGoogleMapsPlacemarks::PREFIX . 'map-height':
					echo '<input id="'. BasicGoogleMapsPlacemarks::PREFIX .'map-height" name="'. BasicGoogleMapsPlacemarks::PREFIX .'map-height" type="text" value="'. $this->mapHeight .'" class="small-text" /> ';
					_e( 'pixels', 'bgmp' );
				break;
				
				case BasicGoogleMapsPlacemarks::PREFIX . 'map-address':
					echo '<input id="'. BasicGoogleMapsPlacemarks::PREFIX .'map-address" name="'. BasicGoogleMapsPlacemarks::PREFIX .'map-address" type="text" value="'. $this->mapAddress .'" class="regular-text" />';
			
					if( $this->mapAddress && !BasicGoogleMapsPlacemarks::validateCoordinates( $this->mapAddress ) && $this->mapLatitude && $this->mapLongitude )
						echo ' <em>('. __( 'Geocoded to:', 'bgmp' ) .' '. $this->mapLatitude .', '. $this->mapLongitude .')</em>';
						
					elseif( $this->mapAddress && ( !$this->mapLatitude || !$this->mapLongitude ) )
						echo " <em>". __( "(Error geocoding address. Please make sure it's correct and try again.)", 'bgmp' ) ."</em>";
							
					echo '<p class="description">'. __( 'You can type in anything that you would type into a Google Maps search field, from a full address to an intersection, landmark, city, zip code or latitude/longitude coordinates.', 'bgmp' ) .'</p>';
				break;
					
				case BasicGoogleMapsPlacemarks::PREFIX . 'map-zoom':
					echo '<input id="'. BasicGoogleMapsPlacemarks::PREFIX .'map-zoom" name="'. BasicGoogleMapsPlacemarks::PREFIX .'map-zoom" type="text" value="'. $this->mapZoom .'" class="small-text" /> ';
					printf( __( '%d (farthest) to %d (closest)', 'bgmp' ), BasicGoogleMapsPlacemarks::ZOOM_MIN, BasicGoogleMapsPlacemarks::ZOOM_MAX );
				break;
					
				case BasicGoogleMapsPlacemarks::PREFIX . 'map-type':
					echo '<select id="'. BasicGoogleMapsPlacemarks::PREFIX .'map-type" name="'. BasicGoogleMapsPlacemarks::PREFIX .'map-type">';
			
					foreach( $this->mapTypes as $code => $label )
						echo '<option value="'. $code .'" '. ( $this->mapType == $code ? 'selected="selected"' : '' ) .'>'. $label .'</option>';
					
					echo '</select>';
				break;
					
				case BasicGoogleMapsPlacemarks::PREFIX . 'map-type-control':
					echo '<select id="'. BasicGoogleMapsPlacemarks::PREFIX .'map-type-control" name="'. BasicGoogleMapsPlacemarks::PREFIX .'map-type-control">
						<option value="off" '. ( $this->mapTypeControl == 'off' ? 'selected="selected"' : '' ) .'>'. __( 'Off', 'bgmp' ) .'</option>
						<option value="DEFAULT" '. ( $this->mapTypeControl == 'DEFAULT' ? 'selected="selected"' : '' ) .'>'. __( 'Automatic', 'bgmp' ) .'</option>
						<option value="HORIZONTAL_BAR" '. ( $this->mapTypeControl == 'HORIZONTAL_BAR' ? 'selected="selected"' : '' ) .'>'. __( 'Horizontal Bar', 'bgmp' ) .'</option>
						<option value="DROPDOWN_MENU" '. ( $this->mapTypeControl == 'DROPDOWN_MENU' ? 'selected="selected"' : '' ) .'>'. __( 'Dropdown Menu', 'bgmp' ) .'</option>
					</select>';
					// @todo use selected()
					
					echo '<p class="description">' . esc_html__( ' "Automatic" will automatically switch to the appropriate control based on the window size and other factors.', 'bgmp' ) . '</p>';
				break;
					
				case BasicGoogleMapsPlacemarks::PREFIX . 'map-navigation-control':
					echo '<select id="'. BasicGoogleMapsPlacemarks::PREFIX .'map-navigation-control" name="'. BasicGoogleMapsPlacemarks::PREFIX .'map-navigation-control">
						<option value="off" '. ( $this->mapNavigationControl == 'DEFAULT' ? 'selected="selected"' : '' ) .'>'. __( 'Off', 'bgmp' ) .'</option>
						<option value="DEFAULT" '. ( $this->mapNavigationControl == 'DEFAULT' ? 'selected="selected"' : '' ) .'>'. __( 'Automatic', 'bgmp' ) .'</option>
						<option value="SMALL" '. ( $this->mapNavigationControl == 'SMALL' ? 'selected="selected"' : '' ) .'>'. __( 'Small', 'bgmp' ) .'</option>
						<option value="ANDROID" '. ( $this->mapNavigationControl == 'ANDROID' ? 'selected="selected"' : '' ) .'>'. __( 'Android', 'bgmp' ) .'</option>
						<option value="ZOOM_PAN" '. ( $this->mapNavigationControl == 'ZOOM_PAN' ? 'selected="selected"' : '' ) .'>'. __( 'Zoom/Pan', 'bgmp' ) .'</option>
					</select>';
					// @todo use selected()
						
					echo '<p class="description">' . esc_html__( ' "Automatic" will automatically switch to the appropriate control based on the window size and other factors.', 'bgmp' ) . '</p>';
				break;
					
				case BasicGoogleMapsPlacemarks::PREFIX . 'map-info-window-width':
					echo '<input id="'. BasicGoogleMapsPlacemarks::PREFIX .'map-info-window-width" name="'. BasicGoogleMapsPlacemarks::PREFIX .'map-info-window-width" type="text" value="'. $this->mapInfoWindowMaxWidth .'" class="small-text" /> ';
					_e( 'pixels', 'bgmp' );
				break;
			}
		}

		/**
		 * Adds the markup for the all of the fields in the Map Settings section
		 * @author Ian Dunn <ian@iandunn.name>
		 * @param array $field
		 */
		public function markupMarkerClusterFields( $field )
		{
			require( dirname( __FILE__ ) .'/views/settings-marker-clusterer.php' );
		}
	} // end BGMPSettings
}

?>