Fix code style of Edit History
authorTim Düsterhus <duesterhus@woltlab.com>
Wed, 9 Jul 2014 20:16:58 +0000 (22:16 +0200)
committerTim Düsterhus <duesterhus@woltlab.com>
Wed, 9 Jul 2014 20:16:58 +0000 (22:16 +0200)
wcfsetup/install/files/lib/data/edit/history/entry/EditHistoryEntryAction.class.php
wcfsetup/install/files/lib/data/edit/history/entry/EditHistoryEntryEditor.class.php
wcfsetup/install/files/lib/data/edit/history/entry/EditHistoryEntryList.class.php
wcfsetup/install/files/lib/page/EditHistoryPage.class.php
wcfsetup/install/files/lib/system/edit/EditHistoryManager.class.php
wcfsetup/install/files/lib/system/edit/IHistorySavingObject.class.php

index bec522d0a0e2be545c65caa42151e84bc4f63fe9..c6bc6ba0f22e06d696d63d0324190758711b2e53 100644 (file)
@@ -4,19 +4,19 @@ use wcf\data\object\type\ObjectTypeCache;
 use wcf\data\AbstractDatabaseObjectAction;
 
 /**
-* Executes edit history entry-related actions.
-* 
-* @author      Tim Duesterhus
-* @copyright   2001-2014 WoltLab GmbH
-* @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
-* @package     com.woltlab.wcf
-* @subpackage  data.edit.history.entry
-* @category    Community Framework
-*/
+ * Executes edit history entry-related actions.
+ 
+ * @author     Tim Duesterhus
+ * @copyright  2001-2014 WoltLab GmbH
+ * @license    GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @package    com.woltlab.wcf
+ * @subpackage data.edit.history.entry
+ * @category   Community Framework
+ */
 class EditHistoryEntryAction extends AbstractDatabaseObjectAction {
        /**
-       * @see  \wcf\data\AbstractDatabaseObjectAction::$className
-       */
+        * @see \wcf\data\AbstractDatabaseObjectAction::$className
+        */
        protected $className = 'wcf\data\edit\history\entry\EditHistoryEntryEditor';
        
        /**
index 6f6d46c039fc973fcb8ab13e13b544e0ad2630cb..4344b593d81761335cda13042087b35ef978cd31 100644 (file)
@@ -3,18 +3,18 @@ namespace wcf\data\edit\history\entry;
 use wcf\data\DatabaseObjectEditor;
 
 /**
-* Extends the edit history entry object with functions to create, update and delete history entries.
-* 
-* @author      Tim Duesterhus
-* @copyright   2001-2014 WoltLab GmbH
-* @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
-* @package     com.woltlab.wcf
-* @subpackage  data.edit.history.entry
-* @category    Community Framework
-*/
+ * Extends the edit history entry object with functions to create, update and delete history entries.
+ 
+ * @author     Tim Duesterhus
+ * @copyright  2001-2014 WoltLab GmbH
+ * @license    GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @package    com.woltlab.wcf
+ * @subpackage data.edit.history.entry
+ * @category   Community Framework
+ */
 class EditHistoryEntryEditor extends DatabaseObjectEditor {
        /**
-       * @see  \wcf\data\DatabaseObjectEditor::$baseClass
-       */
+        * @see \wcf\data\DatabaseObjectEditor::$baseClass
+        */
        protected static $baseClass = 'wcf\data\edit\history\entry\EditHistoryEntry';
 }
index b86e47a6160184712fe8ae2981a4917dec3eef06..9645edbdbd2c8d0ace901cc366f3bf61ac7b705f 100644 (file)
@@ -3,18 +3,18 @@ namespace wcf\data\edit\history\entry;
 use wcf\data\DatabaseObjectList;
 
 /**
-* Represents a list of edit history entries.
-* 
-* @author      Tim Duesterhus
-* @copyright   2001-2014 WoltLab GmbH
-* @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
-* @package     com.woltlab.wcf
-* @subpackage  data.edit.history.entry
-* @category    Community Framework
-*/
+ * Represents a list of edit history entries.
+ 
+ * @author     Tim Duesterhus
+ * @copyright  2001-2014 WoltLab GmbH
+ * @license    GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @package    com.woltlab.wcf
+ * @subpackage data.edit.history.entry
+ * @category   Community Framework
+ */
 class EditHistoryEntryList extends DatabaseObjectList {
        /**
-       * @see  \wcf\data\DatabaseObjectList::$className
-       */
+        * @see \wcf\data\DatabaseObjectList::$className
+        */
        public $className = 'wcf\data\edit\history\entry\EditHistoryEntry';
 }
index 8dbd378b30bde604ce9861d5d18f4089b2667bb7..0536a2089b14f4a1fb22f4a77e25b30b1e3c0719 100644 (file)
@@ -123,8 +123,8 @@ class EditHistoryPage extends AbstractPage {
        }
        
        /**
-       * @see  \wcf\page\IPage::readData()
-       */
+        * @see \wcf\page\IPage::readData()
+        */
        public function readData() {
                parent::readData();
                
@@ -143,8 +143,8 @@ class EditHistoryPage extends AbstractPage {
        }
        
        /**
-       * @see  \wcf\page\IPage::assignVariables()
-       */
+        * @see \wcf\page\IPage::assignVariables()
+        */
        public function assignVariables() {
                parent::assignVariables();
                
index 2748a837ffbd8e496144c615efe452606ba39650..b08d4a4cba70bf361e881d1c4950be78cd2e0726 100644 (file)
@@ -6,36 +6,36 @@ use wcf\system\SingletonFactory;
 use wcf\system\WCF;
 
 /**
-* Manages the search index.
-* 
-* @author      Tim Duesterhus
-* @copyright   2001-2014 WoltLab GmbH
-* @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
-* @package     com.woltlab.wcf
-* @subpackage  system.search
-* @category    Community Framework
-*/
+ * Manages the edit history.
+ 
+ * @author     Tim Duesterhus
+ * @copyright  2001-2014 WoltLab GmbH
+ * @license    GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @package    com.woltlab.wcf
+ * @subpackage system.search
+ * @category   Community Framework
+ */
 class EditHistoryManager extends SingletonFactory {
        /**
-       * list of available object types
-       * @var  array
-       */
+        * list of available object types
+        * @var array
+        */
        protected $availableObjectTypes = array();
        
        /**
-       * @see  \wcf\system\SingletonFactory::init()
-       */
+        * @see \wcf\system\SingletonFactory::init()
+        */
        protected function init() {
                // get available object types
                $this->availableObjectTypes = ObjectTypeCache::getInstance()->getObjectTypes('com.woltlab.wcf.edit.historySavingObject');
        }
        
        /**
-       * Returns the id of the object type with the given name.
-       * 
-       * @param        string          $objectType
-       * @return       integer
-       */
+        * Returns the id of the object type with the given name.
+        
+        * @param       string          $objectType
+        * @return      integer
+        */
        public function getObjectTypeID($objectType) {
                if (!isset($this->availableObjectTypes[$objectType])) {
                        throw new SystemException("unknown object type '".$objectType."'");
@@ -45,16 +45,16 @@ class EditHistoryManager extends SingletonFactory {
        }
        
        /**
-       * Adds a new entry.
-       * 
-       * @param        string          $objectType
-       * @param        integer         $objectID
-       * @param        string          $message
-       * @param        integer         $time
-       * @param        integer         $userID
-       * @param        string          $username
-       * @param        string          $editReason
-       */
+        * Adds a new entry.
+        
+        * @param       string          $objectType
+        * @param       integer         $objectID
+        * @param       string          $message
+        * @param       integer         $time
+        * @param       integer         $userID
+        * @param       string          $username
+        * @param       string          $editReason
+        */
        public function add($objectType, $objectID, $message, $time, $userID, $username, $editReason) {
                // save new entry
                $sql = "INSERT INTO     wcf".WCF_N."_edit_history_entry
@@ -65,11 +65,11 @@ class EditHistoryManager extends SingletonFactory {
        }
        
        /**
-       * Deletes edit history entries.
-       * 
-       * @param        string          $objectType
-       * @param        array<integer>  $objectIDs
-       */
+        * Deletes edit history entries.
+        
+        * @param       string          $objectType
+        * @param       array<integer>  $objectIDs
+        */
        public function delete($objectType, array $objectIDs) {
                $objectTypeID = $this->getObjectTypeID($objectType);
                
index 7ce69c2849fd3357eb0180150138fbcf175d99f3..af86b7c91eea08e58817b710d6210de2ed1e5c2e 100644 (file)
@@ -5,15 +5,15 @@ use wcf\data\IDatabaseObjectProcessor;
 use wcf\data\IUserContent;
 
 /**
-* Represents an object that saves it's edit history.
-* 
-* @author      Tim Duesterhus
-* @copyright   2001-2014 WoltLab GmbH
-* @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
-* @package     com.woltlab.wcf
-* @subpackage  system.edit
-* @category    Community Framework
-*/
+ * Represents an object that saves it's edit history.
+ 
+ * @author     Tim Duesterhus
+ * @copyright  2001-2014 WoltLab GmbH
+ * @license    GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @package    com.woltlab.wcf
+ * @subpackage system.edit
+ * @category   Community Framework
+ */
 interface IHistorySavingObject extends IDatabaseObjectProcessor, IUserContent {
        /**
         * Reverts the object's text to the given EditHistoryEntry.