Fix code style issues in tutorial series code

Matthias Schmidt · Matthias Schmidt · commit a6f1280ffe59 · 2021-05-28T08:45:55.000+02:00
diff --git a/snippets/tutorial/tutorial-series/part-1/files/lib/acp/form/PersonAddForm.class.php b/snippets/tutorial/tutorial-series/part-1/files/lib/acp/form/PersonAddForm.class.php
@@ -45,7 +45,7 @@ class PersonAddForm extends AbstractFormBuilderForm
     /**
      * @inheritDoc
      */
-    public function createForm()
+    protected function createForm()
     {
         parent::createForm();
 
diff --git a/snippets/tutorial/tutorial-series/part-1/files/lib/data/person/Person.class.php b/snippets/tutorial/tutorial-series/part-1/files/lib/data/person/Person.class.php
@@ -13,9 +13,9 @@
  * @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
 {
diff --git a/snippets/tutorial/tutorial-series/part-3/files/lib/acp/form/PersonAddForm.class.php b/snippets/tutorial/tutorial-series/part-3/files/lib/acp/form/PersonAddForm.class.php
@@ -46,7 +46,7 @@ class PersonAddForm extends AbstractFormBuilderForm
     /**
      * @inheritDoc
      */
-    public function createForm()
+    protected function createForm()
     {
         parent::createForm();
 
diff --git a/snippets/tutorial/tutorial-series/part-3/files/lib/data/person/Person.class.php b/snippets/tutorial/tutorial-series/part-3/files/lib/data/person/Person.class.php
@@ -15,10 +15,10 @@
  * @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
 {
diff --git a/snippets/tutorial/tutorial-series/part-3/files/lib/page/PersonPage.class.php b/snippets/tutorial/tutorial-series/part-3/files/lib/page/PersonPage.class.php
@@ -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;
 
diff --git a/snippets/tutorial/tutorial-series/part-4/files/lib/acp/form/PersonAddForm.class.php b/snippets/tutorial/tutorial-series/part-4/files/lib/acp/form/PersonAddForm.class.php
@@ -46,7 +46,7 @@ class PersonAddForm extends AbstractFormBuilderForm
     /**
      * @inheritDoc
      */
-    public function createForm()
+    protected function createForm()
     {
         parent::createForm();
 
diff --git a/snippets/tutorial/tutorial-series/part-4/files/lib/data/person/Person.class.php b/snippets/tutorial/tutorial-series/part-4/files/lib/data/person/Person.class.php
@@ -15,10 +15,10 @@
  * @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
 {
diff --git a/snippets/tutorial/tutorial-series/part-4/files/lib/page/PersonPage.class.php b/snippets/tutorial/tutorial-series/part-4/files/lib/page/PersonPage.class.php
@@ -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;
 
diff --git a/snippets/tutorial/tutorial-series/part-4/files/lib/system/box/PersonListBoxController.class.php b/snippets/tutorial/tutorial-series/part-4/files/lib/system/box/PersonListBoxController.class.php
@@ -50,7 +50,7 @@ class PersonListBoxController extends AbstractDatabaseObjectListBoxController
     /**
      * @inheritDoc
      */
-    public function getObjectList()
+    protected function getObjectList()
     {
         return new PersonList();
     }
diff --git a/snippets/tutorial/tutorial-series/part-5/files/lib/acp/form/PersonAddForm.class.php b/snippets/tutorial/tutorial-series/part-5/files/lib/acp/form/PersonAddForm.class.php
@@ -46,7 +46,7 @@ class PersonAddForm extends AbstractFormBuilderForm
     /**
      * @inheritDoc
      */
-    public function createForm()
+    protected function createForm()
     {
         parent::createForm();
 
diff --git a/snippets/tutorial/tutorial-series/part-5/files/lib/data/person/Person.class.php b/snippets/tutorial/tutorial-series/part-5/files/lib/data/person/Person.class.php
@@ -17,14 +17,20 @@
  * @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.
      *
diff --git a/snippets/tutorial/tutorial-series/part-5/files/lib/data/person/information/PersonInformationAction.class.php b/snippets/tutorial/tutorial-series/part-5/files/lib/data/person/information/PersonInformationAction.class.php
@@ -14,6 +14,7 @@
 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 @@ public function create()
 
         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']);
diff --git a/snippets/tutorial/tutorial-series/part-5/files/lib/page/PersonPage.class.php b/snippets/tutorial/tutorial-series/part-5/files/lib/page/PersonPage.class.php
@@ -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;
 
diff --git a/snippets/tutorial/tutorial-series/part-5/files/lib/system/box/PersonListBoxController.class.php b/snippets/tutorial/tutorial-series/part-5/files/lib/system/box/PersonListBoxController.class.php
@@ -50,7 +50,7 @@ class PersonListBoxController extends AbstractDatabaseObjectListBoxController
     /**
      * @inheritDoc
      */
-    public function getObjectList()
+    protected function getObjectList()
     {
         return new PersonList();
     }
diff --git a/snippets/tutorial/tutorial-series/part-5/files/lib/system/worker/PersonRebuildDataWorker.class.php b/snippets/tutorial/tutorial-series/part-5/files/lib/system/worker/PersonRebuildDataWorker.class.php
@@ -47,7 +47,7 @@ public function execute()
         if (!\count($this->objectList)) {
             return;
         }
-        
+
         $sql = "UPDATE  wcf" . WCF_N . "_person person
                 SET     informationCount = (
                             SELECT  COUNT(*)
@@ -56,7 +56,7 @@ public function execute()
                         )
                 WHERE   person.personID = ?";
         $statement = WCF::getDB()->prepareStatement($sql);
-        
+
         WCF::getDB()->beginTransaction();
         foreach ($this->getObjectList() as $person) {
             $statement->execute([$person->personID]);

Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ class PersonAddForm extends AbstractFormBuilderForm`
`45`	`45`	`/**`
`46`	`46`	`* @inheritDoc`
`47`	`47`	`*/`
`48`		`- public function createForm()`
	`48`	`+ protected function createForm()`
`49`	`49`	`{`
`50`	`50`	`parent::createForm();`
`51`	`51`
Original file line number	Diff line number	Diff line change
`@@ -13,9 +13,9 @@`
`13`	`13`	`* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>`
`14`	`14`	`* @package WoltLabSuite\Core\Data\Person`
`15`	`15`	`*`
`16`		`- * @property-read integer $personID unique id of the person`
`17`		`- * @property-read string $firstName first name of the person`
`18`		`- * @property-read string $lastName last name of the person`
	`16`	`+ * @property-read int $personID unique id of the person`
	`17`	`+ * @property-read string $firstName first name of the person`
	`18`	`+ * @property-read string $lastName last name of the person`
`19`	`19`	`*/`
`20`	`20`	`class Person extends DatabaseObject implements IRouteController`
`21`	`21`	`{`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ class PersonAddForm extends AbstractFormBuilderForm`
`46`	`46`	`/**`
`47`	`47`	`* @inheritDoc`
`48`	`48`	`*/`
`49`		`- public function createForm()`
	`49`	`+ protected function createForm()`
`50`	`50`	`{`
`51`	`51`	`parent::createForm();`
`52`	`52`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ class PersonListBoxController extends AbstractDatabaseObjectListBoxController`
`50`	`50`	`/**`
`51`	`51`	`* @inheritDoc`
`52`	`52`	`*/`
`53`		`- public function getObjectList()`
	`53`	`+ protected function getObjectList()`
`54`	`54`	`{`
`55`	`55`	`return new PersonList();`
`56`	`56`	`}`