some code cleanup, add some docs

classes/Options/Privacy.php

@@ -38,7 +38,7 @@ protected function options_layout( $all = false ) {
 		$this->initialize();
 		$layout  = array( 'default' => true );
 		$warning = _x( '*** Turning off reporting a %1$s means you will not be notified of upgrades for that %1$s! ***', 'noun - singular', 'privacy-my-way' );
-		$extra_html = array( 'yes' => ' <span class="red"> ' . __( ' ( Recommended ) ', 'privacy-my-way' ) . '</span>' );
+		$extra_html = array( 'yes' => ' <span class="red"> ' . esc_html_x( ' ( Recommended ) ', 'Added to a string to indicate the recommended option', 'privacy-my-way' ) . '</span>' );
 		$layout['blog'] = array(
 			'default' => 'yes',
 			'label'   => __( 'Blog URL', 'privacy-my-way' ),
@@ -72,7 +72,6 @@ protected function options_layout( $all = false ) {
 			),
 		);
 		if ( ( is_multisite() && is_main_site() ) || $all ) {
-			$layout['blog']['change'] = 'showhidePosi( this, ".privacy-blog-option", "yes" );';
 			$layout['blog']['showhide'] = array(
 				'origin' => 'privacy-blog-active',
 				'target' => 'privacy-blog-option',
@@ -92,7 +91,6 @@ protected function options_layout( $all = false ) {
 					'target' => 'privacy-multi-option',
 					'show'   => 'yes',
 				),
-				'change'  => 'showhidePosi( this, ".privacy-multi-option", "yes" );',
 				'divcss'  => 'privacy-multi-active privacy-blog-option',
 			); //*/
 			$layout['install'] = array(
@@ -129,7 +127,11 @@ protected function options_layout( $all = false ) {
 				'filter' => __( 'Filter the plugin list that gets sent to WordPress.', 'privacy-my-way' ),
 				'none'   => __( 'Do not let them know about your plugins.', 'privacy-my-way' ),
 			),
-			'change'    => 'showhidePosi( this, ".privacy-plugin-filter", "filter" );',
+			'showhide'  => array(
+				'origin' => 'privacy-plugin-active',
+				'target' => 'privacy-plugin-filter',
+				'show'   => 'filter'
+			),
 			'divcss'    => 'privacy-plugin-active',
 		); //*/
 		$layout['install_default'] = array(
@@ -149,7 +151,7 @@ protected function options_layout( $all = false ) {
 			'preset'  => 'yes',
 			'label'   => __( 'Plugin List', 'privacy-my-way' ),
 			'text'    => sprintf( $warning, __( 'plugin', 'privacy-my-way' ) ),
-			'textcss' => 'red', // FIXME: bad css
+			'textcss' => 'red',
 			'render'  => 'radio_multiple',
 			'source'  => $this->get_plugin_list(),
 			'divcss'  => 'privacy-plugin-filter',
@@ -164,15 +166,19 @@ protected function options_layout( $all = false ) {
 				'filter' => __( 'Filter the theme list that gets sent to WordPress.', 'privacy-my-way' ),
 				'none'   => __( 'Do not let them know about your themes.', 'privacy-my-way' ),
 			),
-			'change'  => 'showhidePosi(this,".privacy-theme-filter","filter");',
+			'showhide' => array(
+				'origin' => 'privacy-theme-active',
+				'target' => 'privacy-theme-filter',
+				'show'   => 'filter',
+			),
 			'divcss'  => 'privacy-theme-active',
 		); //*/
 		$layout['theme_list'] = array(
 			'default' => $this->get_theme_defaults(),
 			'preset'  => 'yes',
 			'label'   => __( 'Theme List', 'privacy-my-way' ),
 			'text'    => sprintf( $warning, __( 'theme', 'privacy-my-way' ) ),
-			'textcss' => 'red', // FIXME: bad css
+			'textcss' => 'red',
 			'postext' => __( 'The WordPress twenty* themes that are installed will always be reported.', 'privacy-my-way' ),
 			'help'    => __( 'This plugin does not filter default WordPress themes.', 'privacy-my-way' ),
 			'render'  => 'radio_multiple',
@@ -223,7 +229,7 @@ protected function options_layout( $all = false ) {
 				'nodelete'  => __( 'Always retain the plugin data.', 'privacy-my-way' ),
 			),
 		);
-		return apply_filters( "tcc_options_layout_{$this->base}", $layout );
+		return $layout;
 	}
 
 

classes/privacy.php

@@ -51,7 +51,7 @@ public function __construct() {
 
 			add_filter( 'core_version_check_query_args', [ $this, 'core_version_check_query_args' ] );
 
-			#	These next two filters are multisite only
+			//  These next two filters are multisite only
 			add_filter( 'pre_site_option_blog_count', [ $this, 'pre_site_option_blog_count' ], 10, 3 );
 			add_filter( 'pre_site_option_user_count', [ $this, 'pre_site_option_user_count' ], 10, 3 );
 
@@ -433,7 +433,7 @@ public function plugins_site_transient( $value, $transient ) {
 			if ( $this->options['plugins'] === 'filter' ) {
 				foreach( $this->options['plugin_list'] as $plugin => $state ) {
 					if ( $state === 'no' ) {
-						if ( array_key_exists( $plugin, $value->checked ) ) {
+						if ( property_exists( $value, 'checked' ) && array_key_exists( $plugin, $value->checked ) ) {
 							unset( $value->checked[ $plugin ] );
 						}
 						if ( array_key_exists( $plugin, $value->response ) ) {

functions.php

@@ -1,9 +1,21 @@
 <?php
-
+/**
+ *  Contains functions required for the plugin.
+ *
+ * @package    Privacy_My_Way
+ * @subpackage Plugin
+ * @author     Richard Coffee <[email protected]>
+ * @copyright  2017 Richard Coffee
+ * @link       https://github.com/RichardCoffee/privacy-my-way/blob/master/functions.php
+ */
 defined( 'ABSPATH' ) || exit;
 
-include_once( 'includes/debugging.php' );
-
+/**
+ *  Class autoloader.
+ *
+ * @since 20170221
+ * @param string $class  Name of requested class.
+ */
 function pmw_privacy_class_loader( $class ) {
 	if ( substr( $class, 0, 4 ) === 'PMW_' ) {
 		$load = str_replace( '_', '/', substr( $class, ( strpos( $class, '_' ) + 1 ) ) );
@@ -15,6 +27,13 @@ function pmw_privacy_class_loader( $class ) {
 }
 spl_autoload_register( 'pmw_privacy_class_loader' ); //*/
 
+/**
+ *  Get plugin library class instance.
+ *
+ * @since 20170428
+ * @param bool $force_log  Force the library to log the next entry.
+ * @return object          The plugin library instance.
+ */
 function pmw( $force_log = false ) {
 	static $library;
 	if ( empty( $library ) ) {
@@ -26,22 +45,3 @@ function pmw( $force_log = false ) {
 	return $library;
 }
 
-/**
- * Echo an escaped attribute string
- *
- * @since 1.0.0
- *
- * @param string $string
- */
-if ( ! function_exists('e_esc_attr') ) {
-	function e_esc_attr( $string ) {
-		echo esc_attr( $string );
-	}
-}
-
-# http://stackoverflow.com/questions/14348470/is-ajax-in-wordpress
-if ( ! function_exists( 'is_ajax' ) ) {
-	function is_ajax() {
-		return ( defined( 'DOING_AJAX' ) && DOING_AJAX ) ? true : false;
-	}
-}

version.txt

@@ -1 +1 @@
-Last updated on: 20200319
+Last updated on: 20200323