adminpage.class.php

<?php

/**
 * Abstraction of building new option pages in the WordPress ACP
 * 
 * This class deliver a simple way to add new pages to
 * the WordPress ACP and fill them with forms and stuff.
 * It also handles all the database stuff for you.
 * 
 * @author Markus Thšmmes (merguez@semantifiziert.de)
 * @copyright Copyright 2010, Markus Thšmmes
 * @version 1.3
 * @since 22.08.2010
 * 
 */

 if(!class_exists('AdminPage')) {
class AdminPage {
	/**
     * Contains the menu_slug for the current TopLeve-Menu
     * @var string
     */
	public $top;
	
	/**
     * Contains all arguments needed to build the page itself
     * @var array
     */
	protected $args;
	
	/**
     * Contains all the information needed to build the form structure of the page
     * @var array
     */
	private $boxes;
	
	/**
     * True if the table is opened, false if it is not opened
     * @var boolean
     */
	private $table = false;
	
	/**
     * Contains the HTML for building the contextual help
     * @var string
     */
	private $help;
	
	/**
     * Adds an input field to the current page
	 *
	 * Possible keys within $args:
	 *  > id (string) - This is what you need to get your variable from the database
	 *  > label (string) - Describes your field very shortly
	 *  > desc (string) (optional) - Further description for this element
	 *  > standard (string) (optional) - This is the standard value of your input
	 *  > size (string) (optional) - sets the width, can be: small, short, regular and large
	 *
     * @param array $args contains everything needed to build the field
     */
	public function addInput($args) {
		$default = array(
			'size' => 'regular',
		);
		$args = array_merge($default, $args);
		$args['type'] = 'input';
		$this->addField($args);
	}
	
	/**
     * Adds a textarea to the current page
	 *
	 * Possible keys within $args:
	 *  > id (string) - This is what you need to get your variable from the database
	 *  > label (string) - Describes your field very shortly
	 *  > desc (string) (optional) - Further description for this element
	 *  > standard (string) (optional) - This is the standard value of your field
	 *  > rows (integer) (optional) - The number of rows you want to have, standard: 5
	 *  > cols (integer) (optional) - The number of cols you want to have, standard: 30
	 *  > width (integer) (optional) - How wide should the textarea be?, standard:500
	 *
     * @param array $args contains everything needed to build the field
     */
	public function addTextarea($args) {
		$default = array(
			'rows' => 5,
			'cols' => 30,
			'width' => 500,
		);
		$args = array_merge($default, $args);
		$args['type'] = 'textarea';
		$this->addField($args);
	}
	
	/**
     * Adds a TinyMCE editor to the current page
	 *
	 * Possible keys within $args:
	 *  > id (string) - This is what you need to get your variable from the database
	 *  > label (string) - Describes your field very shortly
	 *  > desc (string) (optional) - Further description for this element
	 *  > standard (string) (optional) - This is the standard value of your input
	 *
     * @param array $args contains everything needed to build the field
     */
	public function addEditor($args) {
		$args['type'] = 'editor';
		$this->addField($args);
	}
	
	/**
     * Adds a heading to the current page
	 *
     * @param string $label simply the text for your heading
     */
	public function addTitle($label) {
		$args['type'] = 'title';
		$args['label'] = $label;
		$this->addField($args);
	}
	
	/**
     * Adds a sub-heading to the current page
	 *
     * @param string $label simply the text for your heading
     */
	public function addSubtitle($label) {
		$args['type'] = 'subtitle';
		$args['label'] = $label;
		$this->addField($args);
	}
	
	/**
     * Adds a paragraph to the current page
	 *
     * @param string $text the text you want to display
     */
	public function addParagraph($text) {
		$args['type'] = 'paragraph';
		$args['text'] = $text;
		$this->addField($args);
	}

	public function addSuccessMessage($text) {
		$args['type'] = 'success';
		$args['text'] = $text;
		$this->addField($args);
	}

	public function addErrorMessage($text) {
		$args['type'] = 'error';
		$args['text'] = $text;
		$this->addField($args);
	}
	
	/**
     * Adds a checkbox to the current page
	 *
	 * Possible keys within $args:
	 *  > id (string) - This is what you need to get your variable from the database
	 *  > label (string) - Describes your field very shortly
	 *  > desc (string) - Further description for this element
	 *  > standard (bool) - Define wether the checkbox should be checked our unchecked
	 *
     * @param array $args contains everything needed to build the field
     */
	public function addCheckbox($args) {
		$args['type'] = 'checkbox';
		$this->addField($args);
	}
	
	/**
     * Adds radiobuttons field to the current page
	 *
	 * Possible keys within $args:
	 *  > id (string) - This is what you need to get your variable from the database
	 *  > label (string) - Describes your field very shortly
	 *  > standard (string) (optional) - Define which of the options should be checked if there is nothing in the database
	 *  > options (array) - An array containing the options to choose from, written in this style: LABEL => VALUE
	 *
     * @param array $args contains everything needed to build the field
     */
	public function addRadiobuttons($args) {
		$args['type'] = 'radio';
		$this->addField($args);
	}
	
	/**
     * Adds a dropdown field to the current page
	 *
	 * Possible keys within $args:
	 *  > id (string) - This is what you need to get your variable from the database
	 *  > label (string) - Describes your field very shortly
	 *  > desc (string) (optional) - Describes your field very shortly
	 *  > standard (string) - Define which of the options should be checked if there is nothing in the database
	 *  > options (array) - An array containing the options to choose from, written in this style: LABEL => VALUE
	 *
     * @param array $args contains everything needed to build the field
     */
	public function addDropdown($args) {
		$args['type'] = 'dropdown';
		$this->addField($args);
	}
	
	/**
     * Adds an upload to the current page
	 *
	 * Possible keys within $args:
	 *  > id (string) - This is what you need to get your variable from the database
	 *  > label (string) - Describes your field very shortly
	 *  > desc (string) (optional) - Describes your field very shortly
	 *  > title (string) (optional) - If set, an input is added to the uploader where you can put additional info
	 *
     * @param array $args contains everything needed to build the field
     */
	public function addUpload($args) {
		$args['type'] = 'upload';
		$this->addField($args);
	}
	
	/**
     * Adds a slider to the current page
	 *
	 * Possible keys within $args:
	 *  > id (string) - This is what you need to get your variable from the database
	 *  > label (string) - Describes your field very shortly
	 *  > standard (integer|array) (optional) - The starting position of your slider, if it is an array, a range slider is build
	 *  > max (integer) - The maximum value of your slider
	 *  > min (integer) - The minimum value of your slider
	 *  > step (integer) - The stepsize of your slider
	 *
     * @param array $args contains everything needed to build the field
     */
	public function addSlider($args) {
		$default = array(
			'standard' => 0,
			'max' => 100,
			'min' => 0,
			'step' => 1,
		);
		$args = array_merge($default,$args);
		$args['type'] = 'slider';
		$this->addField($args);
	}
	
	/**
     * Adds a datepicker to the current page
	 *
	 * Possible keys within $args:
	 *  > id (string) - This is what you need to get your variable from the database
	 *  > label (string) - Describes your field very shortly
	 *  > desc (string) (optional) - Describes your field very shortly
	 *  > standard (string) (optional) - The standard date in the format: MM/DD/YYYY
	 *
     * @param array $args contains everything needed to build the field
     */
	public function addDate($args) {
		$args['type'] = 'date';
		$date = explode('/', $args['standard']);
		if(isset($date[2])) $args['standard'] = mktime(0,0,0,$date[0],$date[1],$date[2]);
		$this->addField($args);
	}
	
	/**
	 * Adds some contextual help (shows when you click the little 'help' tab)
	 *
	 * @param string $html contains the html code for your help
	 */
	public function addHelp($html) {
		$this->help = $html;
		add_action('admin_menu', array($this, 'renderHelp'));
	}
	
	/**
     * Does the repetive tasks of adding a field
	 * @access private
     */
	private function addField($args) {
		$this->buildOptions($args);
		$this->boxes[] = $args;
	}
	
	/**
     * Builds all the options with their standard values
	 * @access private
     */
	private function buildOptions($args) {
		$default = array(
			'standard' => '',
			'id' => 1
		);
		$args = array_merge($default, $args);
		@add_option($args['id'], $args['standard']);
	}
	
	/**
	 * Builds the contextual help for you
	 * @access private
	 */
	public function renderHelp() {
		add_contextual_help($this->args['slug'], $this->help);
	}
	
	/**
     * Outputs all the HTML needed for the new page
	 * @access private
     */
	public function outputHTML() {
		echo '<div class="wrap">';
		echo '<h2>'.$this->args['page_title'].'</h2>';
		echo '<form method="post" action="" enctype="multipart/form-data">';
		if($_POST['action'] == 'save') {
			echo '<div class="updated settings-error"><p><strong>'.__('Settings saved.').'</strong></p></div>';
			$this->save();
		} elseif($_GET['action'] == 'reset') {
			foreach($this->boxes as $box) {
				update_option($box['id'], $box['standard']);
			}
			header('Location: '.$_SERVER['HTTP_REFERER']) ;
		}
		echo '<style>.editorcontainer { -webkit-border-radius:6px; border:1px solid #DEDEDE;}</style>';
		echo '<link href="http://ajax.googleapis.com/ajax/libs/jqueryui/1.8.2/themes/base/jquery-ui.css" rel="stylesheet" />';
		echo '<script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4.2/jquery.min.js"></script>';
		echo '<script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jqueryui/1.8.2/jquery-ui.min.js"></script>';
		foreach($this->boxes as $box) {
			if($box['type'] != 'title' AND $box['type'] != 'paragraph' AND $box['type'] != 'subtitle' AND $box['type'] != 'success' AND $box['type'] != 'error') {
				if(!$this->table) {
					echo '<table class="form-table">';
					$this->table = true;
				}
				echo '<tr valign="top">';
				echo '<th><label for="'.$box['id'].'">'.$box['label'].':</label></th>';
			} else {
				if($this->table) {
					echo '</table>';
					$this->table = false;
				}
			}
			
			$data = get_option($box['id']);
			switch($box['type']) {
				case 'title':
					echo '<h3>'.$box['label'].'</h3>';
					break;
				case 'subtitle':
					echo '<h4>'.$box['label'].'</h4>';
					break;
				case 'paragraph':
					echo '<p>'.$box['text'].'</p>';
					break;
				case 'success':
					echo '<div id="message" class="updated"><p>'.$box['text'].'</p></div>';
					break;
				case 'error':
					echo '<div id="message" class="error"><p>'.$box['text'].'</p></div>';
					break;
				case 'input':
					$data = htmlspecialchars(stripslashes($data));
					echo '<td><input type="text" class="'.$box['size'].'-text" name="'.$box['id'].'" id="'.$box['id'].'" value="'.$data.'" /> <span class="description">'.$box['desc'].'</span></td>';
					break;
					
				case 'textarea':
					$data = stripslashes($data);
					echo '<td><textarea rows="'.$box['rows'].'" cols="'.$box['cols'].'" style="width:'.$box['width'].'px" name="'.$box['id'].'" id="'.$box['id'].'">'.$data.'</textarea> <br><span class="description">'.$box['desc'].'</span></td>';
					break;
					
				case 'editor':
					wp_tiny_mce();
					$data = stripslashes($data);
					echo '<td><div class="editorcontainer"><textarea class="theEditor" id="'.$box['id'].'" name="'.$box['id'].'">'.$data.'</textarea></div><span class="description">'.$box['desc'].'</span></td>';
					break;
				
				case 'checkbox':
					if($data == 'true') {
						$checked = 'checked="checked"';
					} else {
						$checked = '';
					}
					echo '<td><input type="checkbox" name="'.$box['id'].'" id="'.$box['id'].'" value="true" '.$checked.' /> <label for="'.$box['id'].'">'.$box['desc'].'</label></td>';
					break;
					
				case 'radio':
					echo '<td>';
					foreach($box['options'] as $label=>$value) {
						if($data == $value) {
							$checked = 'checked="checked"';
						} else {
							$checked = '';
						}
						echo '<input type="radio" name="'.$box['id'].'" id="'.$box['id'].'_'.$value.'" value="'.$value.'" '.$checked.' /> <label for="'.$box['id'].'_'.$value.'">'.$label.'</label><br>';
					}
					echo '</td>';
					break;
					
				case 'dropdown':
					echo '<td>';
					echo '<select name="'.$box['id'].'" id="'.$box['id'].'">';
					foreach($box['options'] as $label=>$value) {
						if($data == $value) {
							$selected = 'selected="selected"';
						} else {
							$selected = '';
						}
						echo '<option value="'.$value.'" '.$selected.'>'.$label.'</option>';
					}
					echo '</select> <span class="description">'.$box['desc'].'</span>';
					echo '</td>';
					break;
					
				case 'upload':
					echo '<td>';
					echo '<div style="-webkit-border-radius:6px; border:1px solid #DEDEDE; padding:10px; position:relative; background:#FFF;">';
					echo '<div style="float:left"><input type="file" name="'.$box['id'].'" id="'.$box['id'].'" /> <span class="description">'.$box['desc'].'</span>';
					if(isset($box['title'])) echo '<br><br><input type="text" class="regular-text" name="'.$box['id'].'_title" id="'.$box['id'].'_title" value="'.$data['title'].'" /> <span class="description">'.$box['title'].'</span>';
					echo '</div>';
					if(strpos($data['type'], 'image') !== false) {
						echo '<img height="75" src="'.$data['url'].'" style="float:right" />';
					} else {
						echo '<p style="float:right"><strong>'.__('Current').':</strong> '.$data['url'].'</p>';
					}
					echo '<div style="clear:both"></div>';
					echo '</div>';
					echo '</td>';
					break;
					
				case 'slider':
					$show = $data;
					if(is_array($show)) $show = implode('-',$show);
					echo '<td>';
					echo '<div style="width:30%" id="'.$box['id'].'-slider" class="ui-slider"></div>';
					echo '<div id="'.$box['id'].'-handle">'.$show.'</div>';
					echo '<input type="hidden" name="'.$box['id'].'" id="'.$box['id'].'" value="'.$show.'" />';
					echo '<script type="text/javascript">jQuery("#'.$box['id'].'-slider").slider({';
					if(!is_array($data)) {
						echo 'value: '.$data.',';
					} else {
						echo 'range: true,';
						echo 'values: ['.implode(',',$data).'],';
					}
					echo 'step:' .$box['step'].',';
					echo 'max: '.$box['max'].',';
					echo 'min: '.$box['min'].',';
					if(!is_array($data)) {
						echo 'slide: function(e,ui) { jQuery("#'.$box['id'].'-handle").text(ui.value); jQuery("#'.$box['id'].'").val(ui.value); },';
					} else {
						echo 'slide: function(e,ui) { jQuery("#'.$box['id'].'-handle").text(ui.values[0]+"-"+ui.values[1]); jQuery("#'.$box['id'].'").val(ui.values[0]+"-"+ui.values[1]); },';
					}
					echo '}); </script>';
					echo '</td>';
					break;
					
				case 'date':
					if(strlen($data) > 0) $data = date('m/d/Y',$data);
					echo '<td><input type="text" name="'.$box['id'].'" id="'.$box['id'].'" value="'.$data.'" /> <span class="description">'.$box['desc'].'</span></td>';
					echo '<script type="text/javascript">jQuery("#'.$box['id'].'").datepicker();</script>';
					break;
			}
			if($box['type'] != 'title' AND $box['type'] != 'paragraph' AND $box['type'] != 'subtitle' AND $box['type'] != 'success' AND $box['type'] != 'error' ) echo '</tr>';
		}
		if($this->table = true) echo '</table>';
		echo '<p class="submit"><input type="submit" name="Submit" class="button-primary" value="'.esc_attr(__('Save Changes')).'" /> <a href="'.$_SERVER['REQUEST_URI'].'&action=reset" class="button">Reset</a></p>';
		echo '<input type="hidden" name="action" value="save" />';
		echo '</form></div>';
	}
	
	/**
     * Puts all our data to the database
	 * @access private
     */
	private function save() {
		foreach($this->boxes as $box) {
			$data = $_POST[$box['id']];
			if($box['type'] == 'editor') {
				$data = wptexturize(wpautop($data));
			}
			if($box['type'] == 'checkbox') {
				if($data != 'true') {
					$data = 'false';
				}
			}
			if($box['type'] == 'upload') {
				if($_FILES[$box['id']]['size'] > 0) {
					$data = wp_handle_upload($_FILES[$box['id']], array('test_form' => false));
				} else {
					$data = get_option($box['id']);
				}
				$data['title'] = $_POST[$box['id'].'_title'];
			}
			if($box['type'] == 'slider') {
				if(strpos($data, '-') !== false) {
					$data = explode('-',$data);
				}
			}
			if($box['type'] == 'date') {
				$date = explode('/', $data);
				if(isset($date[2])) $data = mktime(0,0,0,$date[0],$date[1],$date[2]);
			}
			update_option($box['id'], $data);
		}
	}
	
	/**
     * Loads all the script and css files needed
	 * @access private
     */
	public function loadScripts() {
		wp_enqueue_script('common');
		wp_enqueue_script('jquery-color');
		wp_admin_css('thickbox');
		wp_print_scripts('post');
		wp_print_scripts('media-upload');
		wp_print_scripts('jquery');
		wp_print_scripts('jquery-ui-core');
		wp_print_scripts('jquery-ui-tabs');
		wp_print_scripts('tiny_mce');
		wp_print_scripts('editor');
		wp_print_scripts('editor-functions');
		add_thickbox();
		wp_admin_css();
		wp_enqueue_script('utils');
		do_action("admin_print_styles-post-php");
		do_action('admin_print_styles');
		remove_all_filters('mce_external_plugins');
	}
}
}

if(!class_exists('TopPage')) {
class TopPage extends AdminPage {
	/**
     * Builds a new Top-Level-Menu
	 *
	 * Possible keys within $args:
	 *  > menu_title (string) - The name of the Top-Level-Menu
	 *  > page_title (string) - The name of the first page of the menu
	 *  > menu_slug (string) - A unique string identifying your new menu
	 *  > capability (string) (optional) - The capability needed to view the page
	 *  > icon_url (string) (optional) - URL to the icon, decorating the Top-Level-Menu
	 *  > position (string) (optional) - The position of the Menu in the ACP
	 *
     * @param array $args contains everything needed to build the menu
     */
	public function __construct($args) {
		$this->args = $args;
		$this->top = $this->args['menu_slug'];
		add_action('admin_menu', array($this, 'renderTopPage'));
		add_action('admin_head', array($this, 'loadScripts'));
	}
	
	/**
     * Does all the complicated stuff to build the menu and its first page
	 * @access private
     */
	public function renderTopPage() {
		$default = array(
			'capability' => 'edit_themes',
		);
		$this->args = array_merge($default, $this->args);
		@add_menu_page($this->args['page_title'], $this->args['menu_title'], $this->args['capability'], $this->args['menu_slug'], array($this, 'outputHTML'), $this->args['icon_url'], $this->args['position']);
		$this->args['slug'] = add_submenu_page($this->args['menu_slug'], $this->args['page_title'], $this->args['page_title'], $this->args['capability'], $this->args['menu_slug'], array($this, 'outputHTML'));
	}
}
}

if(!class_exists('SubPage')) {
class SubPage extends AdminPage {
	/**
     * Builds a new Top-Level-Menu
	 *
	 * Possible keys within $args:
	 *  > page_title (string) - The name of this page
	 *  > capability (string) (optional) - The capability needed to view the page
	 *
	 * @param string|object $top contains the name of the parent Top-Level-Menu or a TopPage object
     * @param array|string $args contains everything needed to build the menu, if just a string it's the name of the page
     */
	public function __construct($top, $args) {
		if(is_object($top)) {
			$this->top = $top->top;
		} else {
			switch($top) {
				case 'posts':
					$this->top = 'edit.php';
					break;
				
				case 'dashboard':
					$this->top = 'index.php';
					break;
				
				case 'media':
					$this->top = 'upload.php';
					break;
				
				case 'links':
					$this->top = 'link-manager.php';
					break;
				
				case 'pages':
					$this->top = 'edit.php?post_type=page';
					break;
				
				case 'comments':
					$this->top = 'edit-comments.php';
					break;
				
				case 'theme':
					$this->top = 'themes.php';
					break;
				
				case 'plugins':
					$this->top = 'plugins.php';
					break;
				
				case 'users':
					$this->top = 'users.php';
					break;
				
				case 'tools':
					$this->top = 'tools.php';
					break;
				
				case 'settings':
					$this->top = 'options-general.php';
					break;
			
				default:
					if(post_type_exists($top)) {
						$this->top = 'edit.php?post_type='.$top;
					} else {
						$this->top = $top;
					}
			}
		}
		if(is_array($args)) {
			$this->args = $args;
		} else {
			$array['page_title'] = $args;
			$this->args = $array;
		}
		add_action('admin_menu', array($this, 'renderSubPage'));
		add_action('admin_head', array($this, 'loadScripts'));
	}
	
	/**
     * Does all the complicated stuff to build the page
	 * @access private
     */
	public function renderSubPage() {
		$default = array(
			'capability' => 'edit_themes',
		);
		$this->args = array_merge($default, $this->args);
		$this->args['slug'] = add_submenu_page($this->top, $this->args['page_title'], $this->args['page_title'], $this->args['capability'], $this->createSlug(), array($this, 'outputHTML'));
	}
	
	/**
     * Creates an unique slug out of the page_title and the current menu_slug
	 * @access private
     */
	private function createSlug() {
		$slug = $this->args['page_title'];
		$slug = strtolower($slug);
		$slug = str_replace(' ','_',$slug);
		return $this->top.'_'.$slug;
	}
}
}

?>