/wp-content/plugins/wp-pagenavi/scb/AdminPage.php
PHP | 463 lines | 284 code | 115 blank | 64 comment | 38 complexity | aa830c0935c95cfc166e755293ccf472 MD5 | raw file
- <?php
- /*
- Creates an admin page
- You must set $this->args and define the page_content() method
- */
- abstract class scbAdminPage {
- /** Page args
- * $toplevel string If not empty, will create a new top level menu
- * $icon string Path to an icon for the top level menu
- * $parent string ( default: options-general.php )
- * $capability string ( default: 'manage_options' )
- * $page_title string ( mandatory )
- * $menu_title string ( default: $page_title )
- * $page_slug string ( default: sanitized $page_title )
- * $nonce string ( default: $page_slug )
- * $action_link string|bool Text of the action link on the Plugins page ( default: 'Settings' )
- */
- protected $args;
- // URL to the current plugin directory.
- // Useful for adding css and js files
- protected $plugin_url;
- // Created at page init
- protected $pagehook;
- // scbOptions object holder
- // Normally, it's used for storing formdata
- protected $options;
- protected $option_name;
- // l10n
- protected $textdomain;
- // Formdata used for filling the form elements
- protected $formdata = array();
- // ____________REGISTRATION COMPONENT____________
- private static $registered = array();
- static function register( $class, $file, $options = null ) {
- if ( isset( self::$registered[$class] ) )
- return false;
- self::$registered[$class] = array( $file, $options );
- add_action( '_admin_menu', array( __CLASS__, '_pages_init' ) );
- return true;
- }
- static function replace( $old_class, $new_class ) {
- if ( ! isset( self::$registered[$old_class] ) )
- return false;
- self::$registered[$new_class] = self::$registered[$old_class];
- unset( self::$registered[$old_class] );
- return true;
- }
- static function remove( $class ) {
- if ( ! isset( self::$registered[$class] ) )
- return false;
- unset( self::$registered[$class] );
- return true;
- }
- static function _pages_init() {
- foreach ( self::$registered as $class => $args )
- new $class( $args[0], $args[1] );
- }
- // ____________MAIN METHODS____________
- // Constructor
- function __construct( $file, $options = NULL ) {
- if ( NULL !== $options ) {
- $this->options = $options;
- $this->formdata = $this->options->get();
- }
- $this->file = $file;
- $this->plugin_url = plugin_dir_url( $file );
- $this->setup();
- $this->check_args();
- if ( isset( $this->option_name ) ) {
- add_action( 'admin_init', array( $this, 'option_init' ) );
- if ( function_exists( 'settings_errors' ) )
- add_action( 'admin_notices', 'settings_errors' );
- }
- add_action( 'admin_menu', array( $this, 'page_init' ) );
- add_filter( 'contextual_help', array( $this, '_contextual_help' ), 10, 2 );
- if ( $this->args['action_link'] )
- add_filter( 'plugin_action_links_' . plugin_basename( $file ), array( $this, '_action_link' ) );
- }
- // This is where all the page args can be set
- function setup(){}
- // This is where the css and js go
- // Both wp_enqueue_*() and inline code can be added
- function page_head(){}
- // This is where the contextual help goes
- // @return string
- function page_help(){}
- // A generic page header
- function page_header() {
- echo "<div class='wrap'>\n";
- screen_icon();
- echo "<h2>" . $this->args['page_title'] . "</h2>\n";
- }
- // This is where the page content goes
- abstract function page_content();
- // A generic page footer
- function page_footer() {
- echo "</div>\n";
- }
- // This is where the form data should be validated
- function validate( $new_data, $old_data ) {
- return $new_data;
- }
- // Manually handle option saving ( use Settings API instead )
- function form_handler() {
- if ( empty( $_POST['action'] ) )
- return false;
- check_admin_referer( $this->nonce );
- $new_data = array();
- foreach ( array_keys( $this->formdata ) as $key )
- $new_data[$key] = @$_POST[$key];
- $new_data = stripslashes_deep( $new_data );
- $this->formdata = $this->validate( $new_data, $this->formdata );
- if ( isset( $this->options ) )
- $this->options->set( $this->formdata );
- $this->admin_msg();
- }
- // Manually generate a standard admin notice ( use Settings API instead )
- function admin_msg( $msg = '', $class = "updated" ) {
- if ( empty( $msg ) )
- $msg = __( 'Settings <strong>saved</strong>.', $this->textdomain );
- echo "<div class='$class fade'><p>$msg</p></div>\n";
- }
- // ____________UTILITIES____________
- // Generates a form submit button
- function submit_button( $value = '', $action = 'action', $class = "button" ) {
- if ( is_array( $value ) ) {
- extract( wp_parse_args( $value, array( 'value' => __( 'Save Changes', $this->textdomain ),
- 'action' => 'action',
- 'class' => 'button',
- 'ajax' => true ) ) );
- if ( ! $ajax )
- $class .= ' no-ajax';
- }
- else {
- if ( empty( $value ) )
- $value = __( 'Save Changes', $this->textdomain );
- }
- $input_args = array( 'type' => 'submit',
- 'names' => $action,
- 'values' => $value,
- 'extra' => '',
- 'desc' => false );
- if ( ! empty( $class ) )
- $input_args['extra'] = "class='{$class}'";
- $output = "<p class='submit'>\n" . scbForms::input( $input_args ) . "</p>\n";
- return $output;
- }
- /*
- Mimics scbForms::form_wrap()
- $this->form_wrap( $content ); // generates a form with a default submit button
- $this->form_wrap( $content, false ); // generates a form with no submit button
- // the second argument is sent to submit_button()
- $this->form_wrap( $content, array( 'text' => 'Save changes',
- 'name' => 'action',
- 'ajax' => true,
- ) );
- */
- function form_wrap( $content, $submit_button = true ) {
- if ( is_array( $submit_button ) ) {
- $content .= call_user_func( array( $this, 'submit_button' ), $submit_button );
- } elseif ( true === $submit_button ) {
- $content .= $this->submit_button();
- } elseif ( false !== strpos( $submit_button, '<input' ) ) {
- $content .= $submit_button;
- } elseif ( false !== $submit_button ) {
- $button_args = array_slice( func_get_args(), 1 );
- $content .= call_user_func_array( array( $this, 'submit_button' ), $button_args );
- }
- return scbForms::form_wrap( $content, $this->nonce );
- }
- // See scbForms::form()
- function form( $rows, $formdata = array() ) {
- return scbForms::form( $rows, $formdata, $this->nonce );
- }
- // Generates a table wrapped in a form
- function form_table( $rows, $formdata = array() ) {
- $output = '';
- foreach ( $rows as $row )
- $output .= $this->table_row( $row, $formdata );
- $output = $this->form_table_wrap( $output );
- return $output;
- }
- // Wraps the given content in a <form><table>
- function form_table_wrap( $content ) {
- $output = $this->table_wrap( $content );
- $output = $this->form_wrap( $output, $this->nonce );
- return $output;
- }
- // Generates a form table
- function table( $rows, $formdata = array() ) {
- $output = '';
- foreach ( $rows as $row )
- $output .= $this->table_row( $row, $formdata );
- $output = $this->table_wrap( $output );
- return $output;
- }
- // Generates a table row
- function table_row( $args, $formdata = array() ) {
- return $this->row_wrap( $args['title'], $this->input( $args, $formdata ) );
- }
- // Wraps the given content in a <table>
- function table_wrap( $content ) {
- return
- html( 'table class="form-table"', $content );
- }
- // Wraps the given content in a <tr><td>
- function row_wrap( $title, $content ) {
- return
- html( 'tr',
- html( 'th scope="row"', $title )
- .html( 'td', $content ) );
- }
- function input( $args, $formdata = array() ) {
- if ( empty( $formdata ) )
- $formdata = $this->formdata;
- if ( isset( $args['name_tree'] ) ) {
- $tree = ( array ) $args['name_tree'];
- unset( $args['name_tree'] );
- $value = $formdata;
- $name = $this->option_name;
- foreach ( $tree as $key ) {
- $value = $value[$key];
- $name .= '[' . $key . ']';
- }
- $args['name'] = $name;
- unset( $args['names'] );
- unset( $args['values'] );
- $formdata = array( $name => $value );
- }
- return scbForms::input( $args, $formdata );
- }
- // Mimic scbForms inheritance
- function __call( $method, $args ) {
- return call_user_func_array( array( 'scbForms', $method ), $args );
- }
- // Wraps a string in a <script> tag
- function js_wrap( $string ) {
- return "\n<script type='text/javascript'>\n" . $string . "\n</script>\n";
- }
- // Wraps a string in a <style> tag
- function css_wrap( $string ) {
- return "\n<style type='text/css'>\n" . $string . "\n</style>\n";
- }
- // ____________INTERNAL METHODS____________
- // Registers a page
- function page_init() {
- extract( $this->args );
- if ( ! $toplevel ) {
- $this->pagehook = add_submenu_page( $parent, $page_title, $menu_title, $capability, $page_slug, array( $this, '_page_content_hook' ) );
- } else {
- $func = 'add_' . $toplevel . '_page';
- $this->pagehook = $func( $page_title, $menu_title, $capability, $page_slug, array( $this, '_page_content_hook' ), $icon_url );
- }
- if ( ! $this->pagehook )
- return;
- if ( $ajax_submit ) {
- $this->ajax_response();
- add_action( 'admin_footer', array( $this, 'ajax_submit' ), 20 );
- }
- add_action( 'admin_print_styles-' . $this->pagehook, array( $this, 'page_head' ) );
- }
- function option_init() {
- register_setting( $this->option_name, $this->option_name, array( $this, 'validate' ) );
- }
- private function check_args() {
- if ( empty( $this->args['page_title'] ) )
- trigger_error( 'Page title cannot be empty', E_USER_WARNING );
- $this->args = wp_parse_args( $this->args, array(
- 'toplevel' => '',
- 'icon' => '',
- 'parent' => 'options-general.php',
- 'capability' => 'manage_options',
- 'menu_title' => $this->args['page_title'],
- 'page_slug' => '',
- 'nonce' => '',
- 'action_link' => __( 'Settings', $this->textdomain ),
- 'ajax_submit' => false,
- ) );
- if ( empty( $this->args['page_slug'] ) )
- $this->args['page_slug'] = sanitize_title_with_dashes( $this->args['menu_title'] );
- if ( empty( $this->args['nonce'] ) )
- $this->nonce = $this->args['page_slug'];
- }
- function _contextual_help( $help, $screen ) {
- if ( is_object( $screen ) )
- $screen = $screen->id;
- $actual_help = $this->page_help();
- if ( $screen == $this->pagehook && $actual_help )
- return $actual_help;
- return $help;
- }
- function ajax_response() {
- if ( ! isset( $_POST['_ajax_submit'] ) || $_POST['_ajax_submit'] != $this->pagehook )
- return;
- $this->form_handler();
- die;
- }
- function ajax_submit() {
- global $page_hook;
- if ( $page_hook != $this->pagehook )
- return;
- ?>
- <script type="text/javascript">
- jQuery( document ).ready( function( $ ){
- var $spinner = $( new Image() ).attr( 'src', '<?php echo admin_url( "images/wpspin_light.gif" ); ?>' );
- $( ':submit' ).click( function( ev ){
- var $submit = $( this );
- var $form = $submit.parents( 'form' );
- if ( $submit.hasClass( 'no-ajax' ) || $form.attr( 'method' ).toLowerCase() != 'post' )
- return true;
- var $this_spinner = $spinner.clone();
- $submit.before( $this_spinner ).hide();
- var data = $form.serializeArray();
- data.push( {name: $submit.attr( 'name' ), value: $submit.val()} );
- data.push( {name: '_ajax_submit', value: '<?php echo $this->pagehook; ?>'} );
- $.post( location.href, data, function( response ){
- var $prev = $( '.wrap > .updated, .wrap > .error' );
- var $msg = $( response ).hide().insertAfter( $( '.wrap h2' ) );
- if ( $prev.length > 0 )
- $prev.fadeOut( 'slow', function(){ $msg.fadeIn( 'slow' ); } );
- else
- $msg.fadeIn( 'slow' );
- $this_spinner.hide();
- $submit.show();
- } );
- ev.stopPropagation();
- ev.preventDefault();
- } );
- } );
- </script>
- <?php
- }
- function _page_content_hook() {
- $this->form_handler();
- $this->page_header();
- $this->page_content();
- $this->page_footer();
- }
- function _action_link( $links ) {
- $url = add_query_arg( 'page', $this->args['page_slug'], admin_url( $this->args['parent'] ) );
- $links[] = html_link( $url, $this->args['action_link'] );
- return $links;
- }
- }