Changeset 468 for trunk/lib/Version.inc.php

Timestamp:

Feb 20, 2014 3:03:59 AM (10 years ago)

Author:

anonymous

Message:

Completed integrating ^{/branches/eli_branch into} /trunk. Changes include:

• Removed closing ?> from end of files
• Upgrade old-style contructor methods to use construct() instead.
• Class properties and methods defined as public, private, static or protected
• Ensure code runs under E_ALL with only mysql_* deprecated warnings
• Search for the '@' symbol anywhere it might be used to supress runtime errors, then replace with proper error recovery.
• Run the php cli -l option to check files for syntax errors.
• Bring tests up-to-date with latest version and methods of PHPUnit

Location:

trunk

Files:

• . (modified) (1 prop)
• lib/Version.inc.php (modified) (18 diffs)

trunk/lib/Version.inc.php

@@ -4 +4 @@
  * For details visit the project site: <http://trac.strangecode.com/codebase/>
  * Copyright 2001-2012 Strangecode, LLC
- * 
+ *
  * This file is part of The Strangecode Codebase.
  *
@@ -11 +11 @@
  * Free Software Foundation, either version 3 of the License, or (at your option)
  * any later version.
- * 
+ *
  * The Strangecode Codebase is distributed in the hope that it will be useful, but
  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
  * details.
- * 
+ *
  * You should have received a copy of the GNU General Public License along with
  * The Strangecode Codebase. If not, see <http://www.gnu.org/licenses/>.
@@ -39 +39 @@
 class Version {
 
+    // A place to keep an object instance for the singleton pattern.
+    private static $instance = null;
+
     // Configuration of this object.
-    var $_params = array(
+    private $_params = array(
         'max_qty' => 100, // Never have more than this many versions of each record.
         'min_qty' => 25, // Keep at least this many versions of each record.
         'min_days' => 7, // Keep ALL versions within this many days, even if MORE than min_qty.
         'db_table' => 'version_tbl',
-        
+
         // Automatically create table and verify columns. Better set to false after site launch.
         // This value is overwritten by the $app->getParam('db_create_tables') setting if it is available.
@@ -54 +57 @@
 
     // Auth_SQL object from which to access a current user_id.
-    var $_auth;
+    private $_auth;
 
     /**
@@ -63 +66 @@
      * @static
      */
-    static function &getInstance($auth_object)
-    {
-        static $instance = null;
-
-        if ($instance === null) {
-            $instance = new Version($auth_object);
-        }
-
-        return $instance;
+    public static function &getInstance($auth_object)
+    {
+        if (self::$instance === null) {
+            self::$instance = new self($auth_object);
+        }
+
+        return self::$instance;
     }
 
@@ -79 +80 @@
      * @param mixed  $auth_object  An Auth_SQL object.
      */
-    function Version($auth_object)
+    public function __construct($auth_object)
     {
         $app =& App::getInstance();
@@ -102 +103 @@
      * @since   26 Aug 2005 17:09:36
      */
-    function initDB($recreate_db=false)
+    public function initDB($recreate_db=false)
     {
         $app =& App::getInstance();
@@ -155 +156 @@
      * @param  array $params   Array of param keys and values to set.
      */
-    function setParam($params=null)
+    public function setParam($params=null)
     {
         if (isset($params) && is_array($params)) {
@@ -170 +171 @@
      * @return mixed               Configured parameter value.
      */
-    function getParam($param)
+    public function getParam($param)
     {
         $app =& App::getInstance();
-    
+
         if (isset($this->_params[$param])) {
             return $this->_params[$param];
@@ -192 +193 @@
      * @return int                  The id for the version (mysql last insert id).
      */
-    function create($record_table, $record_key, $record_val, $title='', $notes='')
+    public function create($record_table, $record_key, $record_val, $title='', $notes='')
     {
         $app =& App::getInstance();
@@ -204 +205 @@
             return false;
         }
-        
+
         // Get previous version_number.
         $qid = $db->query("
@@ -253 +254 @@
      * @return int                  The id for the version (mysql last insert id).
      */
-    function restore($version_id)
+    public function restore($version_id)
     {
         $app =& App::getInstance();
@@ -314 +315 @@
      * @return mixed                Array of versions, or false if none.
      */
-    function deleteOld($record_table, $record_key, $record_val)
-    {
-        $db =& DB::getInstance();
-    
+    public function deleteOld($record_table, $record_key, $record_val)
+    {
+        $db =& DB::getInstance();
+
         $this->initDB();
 
@@ -381 +382 @@
      * @return mixed                Array of versions, or false if none.
      */
-    function getList($record_table, $record_key, $record_val)
-    {
-        $db =& DB::getInstance();
-    
+    public function getList($record_table, $record_key, $record_val)
+    {
+        $db =& DB::getInstance();
+
         $this->initDB();
 
         // Get versions of this record.
         $qid = $db->query("
-            SELECT 
+            SELECT
                 version_id,
                 saved_by_user_id,
@@ -418 +419 @@
      * @return mixed                Array of data saved in version, or false if none.
      */
-    function getVerson($version_id)
-    {
-        $db =& DB::getInstance();
-    
+    public function getVerson($version_id)
+    {
+        $db =& DB::getInstance();
+
         $this->initDB();
 
@@ -439 +440 @@
      * @return mixed                Array of data saved in version, or false if none.
      */
-    function getData($version_id)
-    {
-        $db =& DB::getInstance();
-    
+    public function getData($version_id)
+    {
+        $db =& DB::getInstance();
+
         $this->initDB();
 
@@ -465 +466 @@
      * @return mixed                Array of data saved in version, or false if none.
      */
-    function getCurrent($record_table, $record_key, $record_val)
-    {
-        $db =& DB::getInstance();
-    
+    public function getCurrent($record_table, $record_key, $record_val)
+    {
+        $db =& DB::getInstance();
+
         $this->initDB();
 
@@ -484 +485 @@
 
 } // End of class.
-?>