Fix code style issues in tutorial series code
authorMatthias Schmidt <gravatronics@live.com>
Fri, 28 May 2021 06:45:55 +0000 (08:45 +0200)
committerMatthias Schmidt <gravatronics@live.com>
Fri, 28 May 2021 06:45:55 +0000 (08:45 +0200)
15 files changed:
snippets/tutorial/tutorial-series/part-1/files/lib/acp/form/PersonAddForm.class.php
snippets/tutorial/tutorial-series/part-1/files/lib/data/person/Person.class.php
snippets/tutorial/tutorial-series/part-3/files/lib/acp/form/PersonAddForm.class.php
snippets/tutorial/tutorial-series/part-3/files/lib/data/person/Person.class.php
snippets/tutorial/tutorial-series/part-3/files/lib/page/PersonPage.class.php
snippets/tutorial/tutorial-series/part-4/files/lib/acp/form/PersonAddForm.class.php
snippets/tutorial/tutorial-series/part-4/files/lib/data/person/Person.class.php
snippets/tutorial/tutorial-series/part-4/files/lib/page/PersonPage.class.php
snippets/tutorial/tutorial-series/part-4/files/lib/system/box/PersonListBoxController.class.php
snippets/tutorial/tutorial-series/part-5/files/lib/acp/form/PersonAddForm.class.php
snippets/tutorial/tutorial-series/part-5/files/lib/data/person/Person.class.php
snippets/tutorial/tutorial-series/part-5/files/lib/data/person/information/PersonInformationAction.class.php
snippets/tutorial/tutorial-series/part-5/files/lib/page/PersonPage.class.php
snippets/tutorial/tutorial-series/part-5/files/lib/system/box/PersonListBoxController.class.php
snippets/tutorial/tutorial-series/part-5/files/lib/system/worker/PersonRebuildDataWorker.class.php

index 212155208a5998b3b05896cc327c3c5d6791da68..2d5490332c2f6fa809f09c19904fe664289fbe6b 100644 (file)
@@ -45,7 +45,7 @@ class PersonAddForm extends AbstractFormBuilderForm
     /**
      * @inheritDoc
      */
-    public function createForm()
+    protected function createForm()
     {
         parent::createForm();
 
index 00ff194fe17136f8fc1826a37d41a282b4e32c3b..c19e21a2fdfda9d255af76ace4e7d80b47284385 100644 (file)
@@ -13,9 +13,9 @@ use wcf\system\request\IRouteController;
  * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  * @package WoltLabSuite\Core\Data\Person
  *
- * @property-read   integer     $personID   unique id of the person
- * @property-read   string      $firstName  first name of the person
- * @property-read   string      $lastName   last name of the person
+ * @property-read   int     $personID   unique id of the person
+ * @property-read   string  $firstName  first name of the person
+ * @property-read   string  $lastName   last name of the person
  */
 class Person extends DatabaseObject implements IRouteController
 {
index 565274d19956ec8a250678fddf71d2828db3cdf5..7ecf6f8789ef170b282fdd87cb6bbbe15e0830c3 100644 (file)
@@ -46,7 +46,7 @@ class PersonAddForm extends AbstractFormBuilderForm
     /**
      * @inheritDoc
      */
-    public function createForm()
+    protected function createForm()
     {
         parent::createForm();
 
index d5c6d16601a85b7ca35d4f05f0b96a1f8575af32..a6390e12a4abe48e544fc07f66ce108c460baa1f 100644 (file)
@@ -15,10 +15,10 @@ use wcf\system\request\LinkHandler;
  * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  * @package WoltLabSuite\Core\Data\Person
  *
- * @property-read   integer     $personID   unique id of the person
- * @property-read   string      $firstName  first name of the person
- * @property-read   string      $lastName   last name of the person
- * @property-read   int         $enableComments     is `1` if comments are enabled for the person, otherwise `0`
+ * @property-read   int     $personID   unique id of the person
+ * @property-read   string  $firstName  first name of the person
+ * @property-read   string  $lastName   last name of the person
+ * @property-read   int     $enableComments     is `1` if comments are enabled for the person, otherwise `0`
  */
 class Person extends DatabaseObject implements ITitledLinkObject
 {
index 24be70a83b3d55ecbd2e124fa0f88a8dce40a868..d70feda1bb372fa738e8f02f042aa07328a4b382 100644 (file)
@@ -2,6 +2,7 @@
 
 namespace wcf\page;
 
+use wcf\data\comment\StructuredCommentList;
 use wcf\data\person\Person;
 use wcf\system\comment\CommentHandler;
 use wcf\system\comment\manager\PersonCommentManager;
@@ -32,7 +33,7 @@ class PersonPage extends AbstractPage
 
     /**
      * id of the person comment object type
-     * @var integer
+     * @var int
      */
     public $commentObjectTypeID = 0;
 
@@ -44,7 +45,7 @@ class PersonPage extends AbstractPage
 
     /**
      * id of the shown person
-     * @var integer
+     * @var int
      */
     public $personID = 0;
 
index 565274d19956ec8a250678fddf71d2828db3cdf5..7ecf6f8789ef170b282fdd87cb6bbbe15e0830c3 100644 (file)
@@ -46,7 +46,7 @@ class PersonAddForm extends AbstractFormBuilderForm
     /**
      * @inheritDoc
      */
-    public function createForm()
+    protected function createForm()
     {
         parent::createForm();
 
index d5c6d16601a85b7ca35d4f05f0b96a1f8575af32..a6390e12a4abe48e544fc07f66ce108c460baa1f 100644 (file)
@@ -15,10 +15,10 @@ use wcf\system\request\LinkHandler;
  * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  * @package WoltLabSuite\Core\Data\Person
  *
- * @property-read   integer     $personID   unique id of the person
- * @property-read   string      $firstName  first name of the person
- * @property-read   string      $lastName   last name of the person
- * @property-read   int         $enableComments     is `1` if comments are enabled for the person, otherwise `0`
+ * @property-read   int     $personID   unique id of the person
+ * @property-read   string  $firstName  first name of the person
+ * @property-read   string  $lastName   last name of the person
+ * @property-read   int     $enableComments     is `1` if comments are enabled for the person, otherwise `0`
  */
 class Person extends DatabaseObject implements ITitledLinkObject
 {
index 24be70a83b3d55ecbd2e124fa0f88a8dce40a868..d70feda1bb372fa738e8f02f042aa07328a4b382 100644 (file)
@@ -2,6 +2,7 @@
 
 namespace wcf\page;
 
+use wcf\data\comment\StructuredCommentList;
 use wcf\data\person\Person;
 use wcf\system\comment\CommentHandler;
 use wcf\system\comment\manager\PersonCommentManager;
@@ -32,7 +33,7 @@ class PersonPage extends AbstractPage
 
     /**
      * id of the person comment object type
-     * @var integer
+     * @var int
      */
     public $commentObjectTypeID = 0;
 
@@ -44,7 +45,7 @@ class PersonPage extends AbstractPage
 
     /**
      * id of the shown person
-     * @var integer
+     * @var int
      */
     public $personID = 0;
 
index 95dc305cb9900a37ae409ea1f294819821127377..7d785a9c8b13b5b2ac59101c3284a28b9e7433fc 100644 (file)
@@ -50,7 +50,7 @@ class PersonListBoxController extends AbstractDatabaseObjectListBoxController
     /**
      * @inheritDoc
      */
-    public function getObjectList()
+    protected function getObjectList()
     {
         return new PersonList();
     }
index 565274d19956ec8a250678fddf71d2828db3cdf5..7ecf6f8789ef170b282fdd87cb6bbbe15e0830c3 100644 (file)
@@ -46,7 +46,7 @@ class PersonAddForm extends AbstractFormBuilderForm
     /**
      * @inheritDoc
      */
-    public function createForm()
+    protected function createForm()
     {
         parent::createForm();
 
index aca42237b6c7555e54375939294973acc4fdea71..bb382bdd24c97ee0762d9e6cff43b085ea475962 100644 (file)
@@ -17,14 +17,20 @@ use wcf\system\request\LinkHandler;
  * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  * @package WoltLabSuite\Core\Data\Person
  *
- * @property-read   integer     $personID   unique id of the person
- * @property-read   string      $firstName  first name of the person
- * @property-read   string      $lastName   last name of the person
- * @property-read   int         $informationCount   number of pieces of information added for the person
- * @property-read   int         $enableComments     is `1` if comments are enabled for the person, otherwise `0`
+ * @property-read   int     $personID   unique id of the person
+ * @property-read   string  $firstName  first name of the person
+ * @property-read   string  $lastName   last name of the person
+ * @property-read   int     $informationCount   number of pieces of information added for the person
+ * @property-read   int     $enableComments     is `1` if comments are enabled for the person, otherwise `0`
  */
 class Person extends DatabaseObject implements ITitledLinkObject
 {
+    /**
+     * all pieces of information added for the person.
+     * @var PersonInformation[]
+     */
+    protected $information;
+
     /**
      * Returns the first and last name of the person if a person object is treated as a string.
      *
index d6f74a94d93e6607f577aa12f015d62adc378818..83fcc862680c82fe8ac6b38e93214d90db39fef2 100644 (file)
@@ -14,6 +14,7 @@ use wcf\system\form\builder\container\wysiwyg\WysiwygFormContainer;
 use wcf\system\form\builder\DialogFormDocument;
 use wcf\system\html\input\HtmlInputProcessor;
 use wcf\system\WCF;
+use wcf\util\UserUtil;
 
 /**
  * Executes person information-related actions.
@@ -53,7 +54,7 @@ class PersonInformationAction extends AbstractDatabaseObjectAction
 
         if (LOG_IP_ADDRESS) {
             if (!isset($this->parameters['data']['ipAddress'])) {
-                $this->parameters['data']['ipAddress'] = WCF::getSession()->ipAddress;
+                $this->parameters['data']['ipAddress'] = UserUtil::getIpAddress();
             }
         } else {
             unset($this->parameters['data']['ipAddress']);
index 24be70a83b3d55ecbd2e124fa0f88a8dce40a868..d70feda1bb372fa738e8f02f042aa07328a4b382 100644 (file)
@@ -2,6 +2,7 @@
 
 namespace wcf\page;
 
+use wcf\data\comment\StructuredCommentList;
 use wcf\data\person\Person;
 use wcf\system\comment\CommentHandler;
 use wcf\system\comment\manager\PersonCommentManager;
@@ -32,7 +33,7 @@ class PersonPage extends AbstractPage
 
     /**
      * id of the person comment object type
-     * @var integer
+     * @var int
      */
     public $commentObjectTypeID = 0;
 
@@ -44,7 +45,7 @@ class PersonPage extends AbstractPage
 
     /**
      * id of the shown person
-     * @var integer
+     * @var int
      */
     public $personID = 0;
 
index 95dc305cb9900a37ae409ea1f294819821127377..7d785a9c8b13b5b2ac59101c3284a28b9e7433fc 100644 (file)
@@ -50,7 +50,7 @@ class PersonListBoxController extends AbstractDatabaseObjectListBoxController
     /**
      * @inheritDoc
      */
-    public function getObjectList()
+    protected function getObjectList()
     {
         return new PersonList();
     }
index 2dd1823f1e2d7ebca4d076c277f25ef3cd8c7fa8..e85c7324e88ea6327ef83362e3ff7a707e26c488 100644 (file)
@@ -47,7 +47,7 @@ class PersonRebuildDataWorker extends AbstractRebuildDataWorker
         if (!\count($this->objectList)) {
             return;
         }
-        
+
         $sql = "UPDATE  wcf" . WCF_N . "_person person
                 SET     informationCount = (
                             SELECT  COUNT(*)
@@ -56,7 +56,7 @@ class PersonRebuildDataWorker extends AbstractRebuildDataWorker
                         )
                 WHERE   person.personID = ?";
         $statement = WCF::getDB()->prepareStatement($sql);
-        
+
         WCF::getDB()->beginTransaction();
         foreach ($this->getObjectList() as $person) {
             $statement->execute([$person->personID]);