Changeset 3955 for branches/plugin/bbpress.php

Timestamp:

06/12/2012 08:33:13 AM (14 years ago)

Author:

johnjamesjacoby

Message:

Code Improvement:

• Turn bbPress::extend into an stdClass in setup_globals.
• Add phpdoc to bbPress::data variable with verbose explanation of how it works.

File:

• branches/plugin/bbpress.php (modified) (5 diffs)

branches/plugin/bbpress.php

@@ -34 +34 @@
 final class bbPress {
 
-        /** Byref *****************************************************************/
+        /** Magic *****************************************************************/
+
+        /**
+         * bbPress uses many variables, most of which can be filtered to customize
+         * the way that it works. To prevent unauthorized access, these variables
+         * are stored in a private array that is magically updated using PHP 5.2+
+         * methods. This is to prevent third party plugins from tampering with
+         * essential information indirectly, which would cause issues later.
+         *
+         * @see bbPress::setup_globals()
+         * @var array
+         */
+        private $data;
+
+        /** Not Magic *************************************************************/
 
         /**
@@ -41 +55 @@
         public $current_user = false;
 
-        /** Arrays ****************************************************************/
+        /**
+         * @var obj Add-ons append to this (Akismet, BuddyPress, etc...)
+         */
+        public $extend;
 
         /**
@@ -49 +66 @@
 
         /**
-         * @var array Add-ons append to this (Akismet, BuddyPress, etc...)
-         */
-        public $extend       = array();
-
-        /**
          * @var array Overloads get_option()
          */
@@ -64 +76 @@
 
         /** Singleton *************************************************************/
-
-        /**
-         * @var array Magic data store to get and set various runtime information.
-         */
-        private $data;
 
         /**
@@ -229 +236 @@
                 /** Misc **************************************************************/
 
+                $this->extend         = new stdClass(); // Plugins add data here
                 $this->errors         = new WP_Error(); // Feedback
                 $this->tab_index      = apply_filters( 'bbp_default_tab_index', 100 );