Changeset 4259

Timestamp:

10/19/2016 02:27:58 AM (8 years ago)

Author:

tellyworth

Message:

Add readme-validator shortcode class, and tweak the Validator class a little to work on the front-end as well.

Fixes #2128

Location:

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory

Files:

• class-plugin-directory.php (modified) (1 diff)
• readme/class-validator.php (modified) (5 diffs)
• shortcodes/class-readme-validator.php (added)

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-plugin-directory.php

@@ -336 +336 @@
         add_shortcode( 'wporg-plugins-screenshots', array( __NAMESPACE__ . '\Shortcodes\Screenshots', 'display' ) );
         add_shortcode( 'wporg-plugins-reviews',     array( __NAMESPACE__ . '\Shortcodes\Reviews',     'display' ) );
+        add_shortcode( 'readme-validator',          array( __NAMESPACE__ . '\Shortcodes\Readme_Validator',     'display' ) );
     }
 

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme/class-validator.php

@@ -72 +72 @@
 
         $readme    = '';
-        $temp_file = Filesystem::temp_directory() . '/readme.txt';
-        $warnings  = array();
-        $notes     = array();
 
         if ( ! empty( $_REQUEST['readme_url'] ) ) {
@@ -98 +95 @@
         }
 
+        return $this->validate_content( $readme );
+    }
+
+    /**
+     * Validates content via a string paramater and adds feedback.
+     */
+    public function validate_content( $readme ) {
+
+        $temp_file = Filesystem::temp_directory() . '/readme.txt';
+        $errors    = array();
+        $warnings  = array();
+        $notes     = array();
+
         file_put_contents( $temp_file, $readme );
         $readme = new Parser( $temp_file );
@@ -105 +115 @@
             /* Translators: Plugin header tag; */
             add_settings_error( 'wporg-plugins-readme', 'readme-validator', sprintf( __( "Fatal Error:\nNo plugin name detected. Plugin names look like: %s", 'wporg-plugins' ), '<code>=== Plugin Name ===</code>' ) );
-            return;
+            $errors[] = array( 'error', sprintf( __( "Fatal Error:\nNo plugin name detected.    Plugin names look like: %s", 'wporg-plugins' ), '<code>=== Plugin Name ===</code>' ) );
+            return $errors;
         }
 
@@ -133 +144 @@
             $message .= "</ul>\n</div>";
 
-            add_settings_error( 'wporg-plugins-readme', 'readme-validator', $message, 'notice-warning' );
-            return;
+            if ( function_exists( 'add_settings_error' ) ) {
+                add_settings_error( 'wporg-plugins-readme', 'readme-validator', $message, 'notice-warning' );
+            }
+            return $message;
         }
 
@@ -165 +178 @@
             $message .= "</ul>\n</div>";
 
-            add_settings_error( 'wporg-plugins-readme', 'readme-validator', $message, 'notice-info' );
-            return;
+            if ( function_exists( 'add_settings_error' ) ) {
+                add_settings_error( 'wporg-plugins-readme', 'readme-validator', $message, 'notice-info' );
+            }
+            return $message;
         }
 
         /* Translators: File name; */
-        add_settings_error( 'wporg-plugins-readme', 'readme-validator', sprintf( __( 'Your %s rocks.  Seriously.  Flying colors.', 'wporg-plugins' ), '<code>readme.txt</code>' ), 'updated' );
-    }
+        if ( function_exists( 'add_settings_error' ) ) {
+            add_settings_error( 'wporg-plugins-readme', 'readme-validator', sprintf( __( 'Your %s rocks.  Seriously.  Flying colors.', 'wporg-plugins' ), '<code>readme.txt</code>' ), 'updated' );
+        }
+    }
+
 
     /**