diff --git a/classes/footnote.php b/classes/footnote.php deleted file mode 100644 index 57ab322..0000000 --- a/classes/footnote.php +++ /dev/null @@ -1,105 +0,0 @@ -a_obj_Settings = new Class_FootnotesSettings(); - } - - /* execute class function: init, admin_init and admin_menu */ - add_action( 'init', array( $this, 'init' ) ); - add_action( 'admin_init', array( $this, 'admin_init' ) ); - add_action( 'admin_menu', array( $this, 'admin_menu' ) ); - - /* register hook for activating the plugin */ - register_activation_hook( __FILE__, array( $this, 'activate' ) ); - /* register hook for deactivating the plugin */ - register_deactivation_hook( __FILE__, array( $this, 'deactivate' ) ); - /* register hook for uninstalling the plugin */ - register_uninstall_hook( __FILE__, array( __CLASS__, 'uninstall' ) ); - } - - /** - * activates the plugin - * @since 1.0 - */ - function activate() - { - // unused - } - - /** - * deactivates the plugin - * @since 1.0 - */ - function deactivate() - { - // unused - } - - /** - * uninstalls the plugin - * @since 1.0 - */ - function uninstall() - { - require_once( PLUGIN_DIR . '/includes/uninstall.php' ); - } - - /** - * initialize function - * called in the class constructor - * @since 1.0 - */ - function init() - { - // unused - } - - /** - * do admin init stuff - * called in the class constructor - * @since 1.0 - */ - function admin_init() - { - // unused - } - - /** - * do admin menu stuff - * called in the class constructor - * @since 1.0 - */ - function admin_menu() - { - // unused - } - -} /* class Class_Footnotes */ \ No newline at end of file diff --git a/classes/footnote_settings.php b/classes/footnote_settings.php deleted file mode 100644 index a58c773..0000000 --- a/classes/footnote_settings.php +++ /dev/null @@ -1,334 +0,0 @@ - 'yes', - FOOTNOTE_INPUTFIELD_REFERENCES_LABEL => 'References' - ); - /* - * resulting pagehook for adding a new sub menu page to the settings - * @since 1.0 - */ - var $a_str_Pagehook; - /* - * collection of settings values for this plugin - * @since 1.0 - */ - var $a_arr_Options; - /* - * collection of tabs for the settings page of this plugin - * @since 1.0 - */ - private $a_arr_SettingsTabs = array(); - - /** - * @constructor - * @since 1.0 - */ - function __construct() - { - /* loads and filters the settings for this plugin */ - $this->a_arr_Options = footnote_filter_options( FOOTNOTE_SETTINGS_CONTAINER ); - /* validates the settings of the plugin and replaces them with the default settings if invalid */ - add_option( FOOTNOTE_SETTINGS_CONTAINER, self::$a_arr_Default_Settings ); - - /* execute class includes on action-even: init, admin_init and admin_menu */ - add_action( 'init', array( $this, 'LoadScriptsAndStylesheets' ) ); - add_action( 'admin_init', array( $this, 'RegisterSettings' ) ); - - add_action( 'admin_init', array( $this, 'RegisterTab_General' ) ); - add_action( 'admin_init', array( $this, 'RegisterTab_HowTo' ) ); - - add_action( 'admin_menu', array( $this, 'AddSettingsMenuPanel' ) ); - } - - /** - * initialize settings page, loads scripts and stylesheets needed for the layout - * called in class constructor @ init - * @since 1.0 - */ - function LoadScriptsAndStylesheets() - { - /* add the jQuery plugin (already registered by WP) */ - wp_enqueue_script( 'jquery' ); - /* register public stylesheet */ - wp_register_style( 'footnote_public_style', plugins_url( '../css/footnote.css', __FILE__ ) ); - /* add public stylesheet */ - wp_enqueue_style( 'footnote_public_style' ); - /* register settings stylesheet */ - wp_register_style( 'footnote_settings_style', plugins_url( '../css/settings.css', __FILE__ ) ); - /* add settings stylesheet */ - wp_enqueue_style( 'footnote_settings_style' ); - } - - /** - * register the settings field in the database for the "save" function - * called in class constructor @ admin_init - * @since 1.0 - */ - function RegisterSettings() - { - register_setting( FOOTNOTE_SETTINGS_LABEL_GENERAL, FOOTNOTE_SETTINGS_CONTAINER ); - } - - /** - * sets the plugin's title for the admins settings menu - * called in class constructor @ admin_menu - * @since 1.0 - */ - function AddSettingsMenuPanel() - { - /* current user needs the permission to update plugins for further access */ - if ( !current_user_can( 'update_plugins' ) ) { - return; - } - /* submenu page title */ - $l_str_PageTitle = 'footnotes'; - /* submenu title */ - $l_str_MenuTitle = 'footnotes'; - /* Add a new submenu to the standard Settings panel */ - $this->a_str_Pagehook = add_options_page( $l_str_PageTitle, $l_str_MenuTitle, 'administrator', FOOTNOTES_SETTINGS_PAGE_ID, array( $this, 'OutputSettingsPage' ) ); - } - - /** - * Plugin Options page rendering goes here, checks - * for active tab and replaces key with the related - * settings key. Uses the plugin_options_tabs method - * to render the tabs. - * @since 1.0 - */ - function OutputSettingsPage() - { - /* gets active tag, or if nothing set the "general" tab will be set to active */ - $l_str_tab = isset( $_GET[ 'tab' ] ) ? $_GET[ 'tab' ] : FOOTNOTE_SETTINGS_LABEL_GENERAL; - /* outputs all tabs */ - echo '
'; - $this->OutputSettingsPageTabs(); - /* outputs a form with the content of the current active tab */ - echo '
'; - wp_nonce_field( 'update-options' ); - settings_fields( $l_str_tab ); - /* outputs the settings field of the current active tab */ - do_settings_sections( $l_str_tab ); - /* adds a submit button to the current page */ - submit_button(); - echo '
'; - echo '
'; - } - - /** - * Renders our tabs in the plugin options page, - * walks through the object's tabs array and prints - * them one by one. Provides the heading for the - * plugin_options_page method. - * @since 1.0 - */ - function OutputSettingsPageTabs() - { - /* gets active tag, or if nothing set the "general" tab will be set to active */ - $l_str_CurrentTab = isset( $_GET[ 'tab' ] ) ? $_GET[ 'tab' ] : FOOTNOTE_SETTINGS_LABEL_GENERAL; - screen_icon(); - echo ''; - } - - /** - * loads specific setting and returns an array with the keys [id, name, value] - * @since 1.0 - * @param $p_str_FieldID - * @return array - */ - protected function LoadSetting( $p_str_FieldID ) - { - $p_arr_Return = array(); - $p_arr_Return[ "id" ] = $this->getFieldID( $p_str_FieldID ); - $p_arr_Return[ "name" ] = $this->getFieldName( $p_str_FieldID ); - $p_arr_Return[ "value" ] = esc_attr( $this->getFieldValue( $p_str_FieldID ) ); - return $p_arr_Return; - } - - /** - * access settings field by name - * @since 1.0 - * @param string $p_str_FieldName - * @return string - */ - protected function getFieldName( $p_str_FieldName ) - { - return sprintf( '%s[%s]', FOOTNOTE_SETTINGS_CONTAINER, $p_str_FieldName ); - } - - /** - * access settings field by id - * @since 1.0 - * @param string $p_str_FieldID - * @return string - */ - protected function getFieldID( $p_str_FieldID ) - { - return sprintf( '%s[%s]', FOOTNOTE_SETTINGS_CONTAINER, $p_str_FieldID ); - - } - - /** - * get settings field value - * @since 1.0 - * @param string $p_str_Key - * @return string - */ - protected function getFieldValue( $p_str_Key ) - { - return $this->a_arr_Options[ $p_str_Key ]; - } - - /** - * initialize general settings tab - * called in class constructor @ admin_init - * @since 1.0 - */ - function RegisterTab_General() - { - $l_str_SectionName = "Footnote_Secion_Settings_General"; - /* add tab to the tab array */ - $this->a_arr_SettingsTabs[ FOOTNOTE_SETTINGS_LABEL_GENERAL ] = __( "General", FOOTNOTES_PLUGIN_NAME ); - /* register settings tab */ - add_settings_section( $l_str_SectionName, __( "Settings", FOOTNOTES_PLUGIN_NAME ), array( $this, 'RegisterTab_General_Description' ), FOOTNOTE_SETTINGS_LABEL_GENERAL ); - add_settings_field( 'Register_References_Label', __( "References label:", FOOTNOTES_PLUGIN_NAME ), array( $this, 'Register_References_Label' ), FOOTNOTE_SETTINGS_LABEL_GENERAL, $l_str_SectionName ); - add_settings_field( 'Register_Combine_Identical', __( "Combine identical footnotes:", FOOTNOTES_PLUGIN_NAME ), array( $this, 'Register_Combine_Identical' ), FOOTNOTE_SETTINGS_LABEL_GENERAL, $l_str_SectionName ); - } - - /** - * adds a desciption to the general settings tab - * called in RegisterTab_General - * @since 1.0 - */ - function RegisterTab_General_Description() - { - // unused description - } - - /** - * outputs the settings field for the "references label" - * @since 1.0 - */ - function Register_References_Label() - { - /* collect data for "combine identical" */ - $l_arr_Data = $this->LoadSetting( FOOTNOTE_INPUTFIELD_REFERENCES_LABEL ); - ?> - " - id="" - value=""/> - LoadSetting( FOOTNOTE_INPUTFIELD_COMBINE_IDENTICAL ); - ?> - - - - a_arr_SettingsTabs[ FOOTNOTE_SETTINGS_LABEL_HOWTO ] = __( "HowTo", FOOTNOTES_PLUGIN_NAME ); - /* register settings tab */ - add_settings_section( $l_str_SectionName, __( "HowTo", FOOTNOTES_PLUGIN_NAME ), array( $this, 'RegisterTab_HowTo_Description' ), FOOTNOTE_SETTINGS_LABEL_HOWTO ); - add_settings_field( 'Register_Howto_Box', "", array( $this, 'Register_Howto_Box' ), FOOTNOTE_SETTINGS_LABEL_HOWTO, $l_str_SectionName ); - } - - /** - * adds a descrption to the HowTo settings tab - * called int RegisterTab_HowTo - * @since 1.0 - */ - function RegisterTab_HowTo_Description() - { - echo __( "This is a brief introduction in how to use the plugin.", FOOTNOTES_PLUGIN_NAME ); - } - - /** - * outputs the content of the HowTo settings tab - * @since 1.0 - */ - function Register_Howto_Box() - { - ?> -
-
-

- - -

- -

- - -

- -
-

- - -      - -

-
- -

- ', '' ); ?> -

-
-
-