Changeset 2501 for sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme-parser/compat.php

Timestamp:

02/15/2016 06:28:02 AM (10 years ago)

Author:

obenland

Message:

W.org Plugins: Code reformatting.

• Splitting out classes in their own files.
• Let the automated code formatter run over the plugin.

It should break too many things.

See #1584.

File:

• sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme-parser/compat.php (modified) (1 diff)

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme-parser/compat.php

@@ -1 +1 @@
 <?php
+/**
+ * WordPress.org Plugin Readme Parser.
+ *
+ * @package WPorg_Plugin_Directory
+ */
 
-if ( !defined('WORDPRESS_README_MARKDOWN') ) {
-    define('WORDPRESS_README_MARKDOWN', dirname(__FILE__) . '/markdown.php');
+if ( ! defined( 'WORDPRESS_README_MARKDOWN' ) ) {
+    define( 'WORDPRESS_README_MARKDOWN', dirname( __FILE__ ) . '/markdown.php' );
 }
 
-require_once(dirname(__FILE__) . '/ReadmeParser.php');
+require_once( dirname( __FILE__ ) . '/ReadmeParser.php' );
 
-class _WordPress_org_Readme extends Baikonur_ReadmeParser {
-    public static function parse_readme($file) {
-        $contents = file($file);
-        return self::parse_readme_contents($contents);
+/**
+ * Class WPorg_Readme
+ */
+class WPorg_Readme extends Baikonur_ReadmeParser {
+
+    /**
+     * @access public
+     *
+     * @param string $file File name.
+     * @return array
+     */
+    public static function parse_readme( $file ) {
+        $contents = file( $file );
+
+        return self::parse_readme_contents( $contents );
     }
 
-    public static function parse_readme_contents($contents) {
-        if (empty($contents)) {
+    /**
+     * @access public
+     *
+     * @param array $contents
+     * @return array
+     */
+    public static function parse_readme_contents( $contents ) {
+        if ( empty( $contents ) ) {
             return array();
         }
 
-        $result = parent::parse_readme_contents($contents);
-        foreach ($result->sections as &$section) {
-            $section = self::filter_text($section);
-        }
-        if (!empty($result->upgrade_notice)) {
-            foreach ($result->upgrade_notice as &$notice) {
-                $notice = self::sanitize_text($notice);
-            }
-        }
-        if (!empty($result->screenshots)) {
-            foreach ($result->screenshots as &$shot) {
-                $shot = self::filter_text($shot);
-            }
+        $result = parent::parse_readme_contents( $contents );
+        $result->sections = array_map( array( 'WPorg_Readme', 'filter_text' ), $result->sections );
+
+        if ( ! empty( $result->upgrade_notice ) ) {
+            $result->upgrade_notice = array_map( array( 'WPorg_Readme', 'sanitize_text' ), $result->upgrade_notice );
         }
 
-        if (!empty($result->remaining_content)) {
-            $result->remaining_content = implode("\n", $result->remaining_content);
-            $result->remaining_content = self::filter_text(str_replace("</h3>\n\n", "</h3>\n", $result->remaining_content));
+        if ( ! empty( $result->screenshots ) ) {
+            $result->screenshots = array_map( array( 'WPorg_Readme', 'filter_text' ), $result->screenshots );
         }
-        else {
+
+        if ( ! empty( $result->remaining_content ) ) {
+            $result->remaining_content = implode( "\n", $result->remaining_content );
+            $result->remaining_content = self::filter_text( str_replace( "</h3>\n\n", "</h3>\n", $result->remaining_content ) );
+        } else {
             $result->remaining_content = '';
         }
 
-        $result->name = self::sanitize_text($result->name);
+        $result->name = self::sanitize_text( $result->name );
         //$result->short_description = self::sanitize_text($result->short_description);
-        $result->donate_link = esc_url($result->donate_link);
+        $result->donate_link = esc_url( $result->donate_link );
 
         $result->requires_at_least = $result->requires;
-        $result->tested_up_to = $result->tested;
-        unset($result->requires, $result->tested);
-        $result = ((array) $result);
-        return $result;
+        $result->tested_up_to      = $result->tested;
+
+        unset( $result->requires, $result->tested );
+
+        return (array) $result;
     }
 
-    protected static function trim_short_desc(&$desc) {
-        $desc = self::sanitize_text($desc);
-        return parent::trim_short_desc($desc);
+    /**
+     * @access protected
+     *
+     * @param string $desc
+     * @return string
+     */
+    protected static function trim_short_desc( &$desc ) {
+        $desc = self::sanitize_text( $desc );
+        parent::trim_short_desc( $desc );
+
+        return $desc;
     }
 
+    /**
+     * @access protected
+     *
+     * @param string $text
+     * @return string
+     */
     protected static function sanitize_text( $text ) { // not fancy
-        $text = strip_tags($text);
-        $text = esc_html($text);
-        $text = trim($text);
+        $text = strip_tags( $text );
+        $text = esc_html( $text );
+        $text = trim( $text );
+
         return $text;
     }
 
+    /**
+     * @access protected
+     *
+     * @param string $text
+     * @return string
+     */
     protected static function filter_text( $text ) {
-        $text = trim($text);
+        $text = trim( $text );
         //$text = self::code_trick($text); // A better parser than Markdown's for: backticks -> CODE
 
         $allowed = array(
-            'a' => array(
-                'href' => array(),
+            'a'          => array(
+                'href'  => array(),
                 'title' => array(),
-                'rel' => array()),
-            'blockquote' => array('cite' => array()),
-            'br' => array(),
-            'p' => array(),
-            'code' => array(),
-            'pre' => array(),
-            'em' => array(),
-            'strong' => array(),
-            'ul' => array(),
-            'ol' => array(),
-            'li' => array(),
-            'h3' => array(),
-            'h4' => array()
+                'rel'   => array()
+            ),
+            'blockquote' => array( 'cite' => array() ),
+            'br'         => array(),
+            'p'          => array(),
+            'code'       => array(),
+            'pre'        => array(),
+            'em'         => array(),
+            'strong'     => array(),
+            'ul'         => array(),
+            'ol'         => array(),
+            'li'         => array(),
+            'h3'         => array(),
+            'h4'         => array(),
         );
 
-        $text = balanceTags($text);
+        $text = balanceTags( $text );
 
         $text = wp_kses( $text, $allowed );
-        $text = trim($text);
+        $text = trim( $text );
+
         return $text;
     }