+ + + -
Tutorial Series Part 3: Person Page and Comments#

+ +
Part 3: Person Page and Comments#

In this part of our tutorial series, we will add a new front end page to our package that is dedicated to each person and shows their personal details. To make good use of this new page and introduce a new API of WoltLab Suite, we will add the opportunity for users to comment on the person using WoltLab Suiteâs reusable comment functionality.
Package Functionality#

@@ -1980,11 +2122,58 @@ To make good use of this new page and introduce a new API of WoltLab Suite, we w
In addition to the components used in part 1, we will use the objectType package installation plugin, use the comment API, create a runtime cache, and create a page handler.
Package Structure#

The complete package will have the following file structure (including the files from part 1):
-
âââ acpMenu.xml
+ 1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
+23
+24
+25
+26
+27
+28
+29
+30
+31
+32
+33
+34
+35
+36
+37
+38
+39
+40
+41
+42
+43
+44
+45 âââ acpMenu.xml
 âââ acptemplates
 â   âââ personAdd.tpl
 â   âââ personList.tpl
 âââ files
+â   âââ acp
+â   â   âââ database
+â   â       âââ install_com.woltlab.wcf.people.php
 â   âââ lib
 â       âââ acp
 â       â   âââ form
@@ -2011,7 +2200,6 @@ To make good use of this new page and introduce a new API of WoltLab Suite, we w
 â           âââ page
 â               âââ handler
 â                   âââ PersonPageHandler.class.php
-âââ install.sql
 âââ language
 â   âââ de.xml
 â   âââ en.xml
@@ -2024,13 +2212,46 @@ To make good use of this new page and introduce a new API of WoltLab Suite, we w
 â   âââ personList.tpl
 âââ userGroupOption.xml
 
+
 
-We will not mention every code change between the first part and this part, as we only want to focus on the important, new parts of the code. For example, there is a new Person::getLink() method and new language items have been added. For all changes, please refer to the source code on GitHub.
+We will not mention every code change between the first part and this part, as we only want to focus on the important, new parts of the code. For example, there is a new Person::getLink() method and new language items have been added. For all changes, please refer to the source code on GitHub.
 
 Runtime Cache#
 To reduce the number of database queries when different APIs require person objects, we implement a runtime cache for people:
-<?php
+
+    
+        files/lib/system/cache/runtime/PersonRuntimeCache.class.php
+        
+    
+     1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
+23
+24
+25
+26 <?php
+
 namespace wcf\system\cache\runtime;
+
 use wcf\data\person\Person;
 use wcf\data\person\PersonList;
 
@@ -2038,27 +2259,44 @@ To make good use of this new page and introduce a new API of WoltLab Suite, we w
  * Runtime cache implementation for people.
  *
  * @author  Matthias Schmidt
- * @copyright   2001-2019 WoltLab GmbH
+ * @copyright   2001-2021 WoltLab GmbH
  * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  * @package WoltLabSuite\Core\System\Cache\Runtime
- * @since   3.0
  *
  * @method  Person[]    getCachedObjects()
  * @method  Person      getObject($objectID)
  * @method  Person[]    getObjects(array $objectIDs)
  */
-class PersonRuntimeCache extends AbstractRuntimeCache {
+class PersonRuntimeCache extends AbstractRuntimeCache
+{
     /**
      * @inheritDoc
      */
     protected $listClassName = PersonList::class;
 }
 
+
+
+
 Comments#
 To allow users to comment on people, we need to tell the system that people support comments.
 This is done by registering a com.woltlab.wcf.comment.commentableContent object type whose processor implements ICommentManager:
-<?xml version="1.0" encoding="UTF-8"?>
-<data xmlns="http://www.woltlab.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.woltlab.com http://www.woltlab.com/XSD/tornado/objectType.xsd">
+
+    
+        objectType.xml
+        
+    
+     1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10 <?xml version="1.0" encoding="UTF-8"?>
+<data xmlns="http://www.woltlab.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.woltlab.com http://www.woltlab.com/XSD/5.4/objectType.xsd">
     <import>
         <type>
             <name>com.woltlab.wcf.person.personComment</name>
@@ -2068,9 +2306,108 @@ This is done by registering a com.woltlab.wcf.comment.commentableContent</import>
 </data>
 

+
+
+
 The PersonCommentManager class extended ICommentManagerâs default implementation AbstractCommentManager:
-<?php
+
+    
+        files/lib/system/comment/manager/PersonCommentManager.class.php
+        
+    
+     1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
+23
+24
+25
+26
+27
+28
+29
+30
+31
+32
+33
+34
+35
+36
+37
+38
+39
+40
+41
+42
+43
+44
+45
+46
+47
+48
+49
+50
+51
+52
+53
+54
+55
+56
+57
+58
+59
+60
+61
+62
+63
+64
+65
+66
+67
+68
+69
+70
+71
+72
+73
+74
+75
+76
+77
+78
+79
+80
+81
+82
+83
+84
+85
+86
+87
+88
+89
+90 <?php
+
 namespace wcf\system\comment\manager;
+
 use wcf\data\person\Person;
 use wcf\data\person\PersonEditor;
 use wcf\system\cache\runtime\PersonRuntimeCache;
@@ -2080,11 +2417,12 @@ This is done by registering a com.woltlab.wcf.comment.commentableContent * Comment manager implementation for people.
  *
  * @author  Matthias Schmidt
- * @copyright   2001-2019 WoltLab GmbH
+ * @copyright   2001-2021 WoltLab GmbH
  * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  * @package WoltLabSuite\Core\System\Comment\Manager
  */
-class PersonCommentManager extends AbstractCommentManager {
+class PersonCommentManager extends AbstractCommentManager
+{
     /**
      * @inheritDoc
      */
@@ -2123,21 +2461,24 @@ This is done by registering a com.woltlab.wcf.comment.commentableContent/**
      * @inheritDoc
      */
-    public function getLink($objectTypeID, $objectID) {
+    public function getLink($objectTypeID, $objectID)
+    {
         return PersonRuntimeCache::getInstance()->getObject($objectID)->getLink();
     }
 
     /**
      * @inheritDoc
      */
-    public function isAccessible($objectID, $validateWritePermission = false) {
+    public function isAccessible($objectID, $validateWritePermission = false)
+    {
         return PersonRuntimeCache::getInstance()->getObject($objectID) !== null;
     }
 
     /**
      * @inheritDoc
      */
-    public function getTitle($objectTypeID, $objectID, $isResponse = false) {
+    public function getTitle($objectTypeID, $objectID, $isResponse = false)
+    {
         if ($isResponse) {
             return WCF::getLanguage()->get('wcf.person.commentResponse');
         }
@@ -2148,11 +2489,15 @@ This is done by registering a com.woltlab.wcf.comment.commentableContent/**
      * @inheritDoc
      */
-    public function updateCounter($objectID, $value) {
+    public function updateCounter($objectID, $value)
+    {
         (new PersonEditor(new Person($objectID)))->updateCounters(['comments' => $value]);
     }
 }
 

+
+
+
 
 First, the system is told the names of the permissions via the $permission* properties.
   More information about comment permissions can be found here.
@@ -2171,8 +2516,119 @@ With this option, comments on individual people can be disabled.
 

 Person Page#
 PersonPage#
-<?php
+
+    
+        files/lib/page/PersonPage.class.php
+        
+    
+      1
+  2
+  3
+  4
+  5
+  6
+  7
+  8
+  9
+ 10
+ 11
+ 12
+ 13
+ 14
+ 15
+ 16
+ 17
+ 18
+ 19
+ 20
+ 21
+ 22
+ 23
+ 24
+ 25
+ 26
+ 27
+ 28
+ 29
+ 30
+ 31
+ 32
+ 33
+ 34
+ 35
+ 36
+ 37
+ 38
+ 39
+ 40
+ 41
+ 42
+ 43
+ 44
+ 45
+ 46
+ 47
+ 48
+ 49
+ 50
+ 51
+ 52
+ 53
+ 54
+ 55
+ 56
+ 57
+ 58
+ 59
+ 60
+ 61
+ 62
+ 63
+ 64
+ 65
+ 66
+ 67
+ 68
+ 69
+ 70
+ 71
+ 72
+ 73
+ 74
+ 75
+ 76
+ 77
+ 78
+ 79
+ 80
+ 81
+ 82
+ 83
+ 84
+ 85
+ 86
+ 87
+ 88
+ 89
+ 90
+ 91
+ 92
+ 93
+ 94
+ 95
+ 96
+ 97
+ 98
+ 99
+100
+101
+102
+103
+104
+105 <?php
+
 namespace wcf\page;
+
 use wcf\data\person\Person;
 use wcf\system\comment\CommentHandler;
 use wcf\system\comment\manager\PersonCommentManager;
@@ -2181,13 +2637,14 @@ With this option, comments on individual people can be disabled.
 
 /**
  * Shows the details of a certain person.
- * 
+ *
  * @author  Matthias Schmidt
- * @copyright   2001-2019 WoltLab GmbH
+ * @copyright   2001-2021 WoltLab GmbH
  * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  * @package WoltLabSuite\Core\Page
  */
-class PersonPage extends AbstractPage {
+class PersonPage extends AbstractPage
+{
     /**
      * list of comments
      * @var StructuredCommentList
@@ -2221,7 +2678,8 @@ With this option, comments on individual people can be disabled.
     /**
      * @inheritDoc
      */
-    public function assignVariables() {
+    public function assignVariables()
+    {
         parent::assignVariables();
 
         WCF::getTPL()->assign([
@@ -2229,31 +2687,43 @@ With this option, comments on individual people can be disabled.
             'commentList' => $this->commentList,
             'commentObjectTypeID' => $this->commentObjectTypeID,
             'lastCommentTime' => $this->commentList ? $this->commentList->getMinCommentTime() : 0,
-            'likeData' => (MODULE_LIKE && $this->commentList) ? $this->commentList->getLikeData() : [],
-            'person' => $this->person
+            'likeData' => MODULE_LIKE && $this->commentList ? $this->commentList->getLikeData() : [],
+            'person' => $this->person,
         ]);
     }
 
     /**
      * @inheritDoc
      */
-    public function readData() {
+    public function readData()
+    {
         parent::readData();
 
         if ($this->person->enableComments) {
-            $this->commentObjectTypeID = CommentHandler::getInstance()->getObjectTypeID('com.woltlab.wcf.person.personComment');
-            $this->commentManager = CommentHandler::getInstance()->getObjectType($this->commentObjectTypeID)->getProcessor();
-            $this->commentList = CommentHandler::getInstance()->getCommentList($this->commentManager, $this->commentObjectTypeID, $this->person->personID);
+            $this->commentObjectTypeID = CommentHandler::getInstance()->getObjectTypeID(
+                'com.woltlab.wcf.person.personComment'
+            );
+            $this->commentManager = CommentHandler::getInstance()->getObjectType(
+                $this->commentObjectTypeID
+            )->getProcessor();
+            $this->commentList = CommentHandler::getInstance()->getCommentList(
+                $this->commentManager,
+                $this->commentObjectTypeID,
+                $this->person->personID
+            );
         }
     }
 
     /**
      * @inheritDoc
      */
-    public function readParameters() {
+    public function readParameters()
+    {
         parent::readParameters();
 
-        if (isset($_REQUEST['id'])) $this->personID = intval($_REQUEST['id']);
+        if (isset($_REQUEST['id'])) {
+            $this->personID = \intval($_REQUEST['id']);
+        }
         $this->person = new Person($this->personID);
         if (!$this->person->personID) {
             throw new IllegalLinkException();
@@ -2261,12 +2731,64 @@ With this option, comments on individual people can be disabled.
     }
 }
 
+
+
+
 The PersonPage class is similar to the PersonEditForm in the ACP in that it reads the id of the requested person from the request data and validates the id in readParameters().
 The rest of the code only handles fetching the list of comments on the requested person.
 In readData(), this list is fetched using CommentHandler::getCommentList() if comments are enabled for the person.
 The assignVariables() method assigns some additional template variables like $commentCanAdd, which is 1 if the active person can add comments and is 0 otherwise, $lastCommentTime, which contains the UNIX timestamp of the last comment, and $likeData, which contains data related to the likes for the disabled comments.
 person.tpl#
-{capture assign='pageTitle'}{$person} - {lang}wcf.person.list{/lang}{/capture}
+
+    
+        templates/person.tpl
+        
+    
+     1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
+23
+24
+25
+26
+27
+28
+29
+30
+31
+32
+33
+34
+35
+36
+37
+38
+39
+40
+41
+42
+43
+44
+45 {capture assign='pageTitle'}{$person} - {lang}wcf.person.list{/lang}{/capture}
 
 {capture assign='contentTitle'}{$person}{/capture}
 
@@ -2276,19 +2798,22 @@ The assignVariables() method assigns some additional template varia
     {if $commentList|count || $commentCanAdd}
         <section id="comments" class="section sectionContainerList">
             <header class="sectionHeader">
-                <h2 class="sectionTitle">{lang}wcf.person.comments{/lang}{if $person->comments} <span class="badge">{#$person->comments}</span>{/if}</h2>
+                <h2 class="sectionTitle">
+                    {lang}wcf.person.comments{/lang}
+                    {if $person->comments}<span class="badge">{#$person->comments}</span>{/if}
+                </h2>
             </header>
 
             {include file='__commentJavaScript' commentContainerID='personCommentList'}
 
             <div class="personComments">
-                <ul id="personCommentList" class="commentList containerList"
-                    data-can-add="{if $commentCanAdd}true{else}false{/if}" 
-                    data-object-id="{@$person->personID}"
-                    data-object-type-id="{@$commentObjectTypeID}"
-                    data-comments="{if $person->comments}{@$commentList->countObjects()}{else}0{/if}"
-                    data-last-comment-time="{@$lastCommentTime}"
-                >
+                <ul id="personCommentList" class="commentList containerList" {*
+                    *}data-can-add="{if $commentCanAdd}true{else}false{/if}" {*
+                    *}data-object-id="{@$person->personID}" {*
+                    *}data-object-type-id="{@$commentObjectTypeID}" {*
+                    *}data-comments="{if $person->comments}{@$commentList->countObjects()}{else}0{/if}" {*
+                    *}data-last-comment-time="{@$lastCommentTime}" {*
+                *}>
                     {include file='commentListAddComment' wysiwygSelector='personCommentListAddComment'}
                     {include file='commentList'}
                 </ul>
@@ -2309,14 +2834,48 @@ The assignVariables() method assigns some additional template varia
 
 {include file='footer'}
 
+
+
+
 For now, the person template is still very empty and only shows the comments in the content area.
 The template code shown for comments is very generic and used in this form in many locations as it only sets the header of the comment list and the container ul#personCommentList element for the comments shown by commentList template.
 The ul#personCommentList elements has five additional data- attributes required by the JavaScript API for comments for loading more comments or creating new ones.
 The commentListAddComment template adds the WYSIWYG support.
 The attribute wysiwygSelector should be the id of the comment list personCommentList with an additional AddComment suffix.
 page.xml#
-<?xml version="1.0" encoding="UTF-8"?>
-<data xmlns="http://www.woltlab.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.woltlab.com http://www.woltlab.com/XSD/tornado/page.xsd">
+
+    
+        page.xml
+        
+    
+     1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
+23
+24
+25
+26
+27 <?xml version="1.0" encoding="UTF-8"?>
+<data xmlns="http://www.woltlab.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.woltlab.com http://www.woltlab.com/XSD/5.4/page.xsd">
     <import>
         <page identifier="com.woltlab.wcf.people.PersonList">
             <pageType>system</pageType>
@@ -2343,6 +2902,9 @@ The attribute wysiwygSelector should be the id of the comment list
     </import>
 </data>
 
+
+
+
 The page.xml file has been extended for the new person page with identifier com.woltlab.wcf.people.Person.
 Compared to the pre-existing com.woltlab.wcf.people.PersonList page, there are four differences:
 
@@ -2354,8 +2916,118 @@ Compared to the pre-existing com.woltlab.wcf.people.PersonList page
    In general, the details page for any type of object that is listed on a different page has the list page as its parent.
 
 PersonPageHandler#
-<?php
+
+    
+        files/lib/system/page/handler/PersonPageHandler.class.php
+        
+    
+      1
+  2
+  3
+  4
+  5
+  6
+  7
+  8
+  9
+ 10
+ 11
+ 12
+ 13
+ 14
+ 15
+ 16
+ 17
+ 18
+ 19
+ 20
+ 21
+ 22
+ 23
+ 24
+ 25
+ 26
+ 27
+ 28
+ 29
+ 30
+ 31
+ 32
+ 33
+ 34
+ 35
+ 36
+ 37
+ 38
+ 39
+ 40
+ 41
+ 42
+ 43
+ 44
+ 45
+ 46
+ 47
+ 48
+ 49
+ 50
+ 51
+ 52
+ 53
+ 54
+ 55
+ 56
+ 57
+ 58
+ 59
+ 60
+ 61
+ 62
+ 63
+ 64
+ 65
+ 66
+ 67
+ 68
+ 69
+ 70
+ 71
+ 72
+ 73
+ 74
+ 75
+ 76
+ 77
+ 78
+ 79
+ 80
+ 81
+ 82
+ 83
+ 84
+ 85
+ 86
+ 87
+ 88
+ 89
+ 90
+ 91
+ 92
+ 93
+ 94
+ 95
+ 96
+ 97
+ 98
+ 99
+100
+101
+102
+103
+104 <?php
+
 namespace wcf\system\page\handler;
+
 use wcf\data\page\Page;
 use wcf\data\person\PersonList;
 use wcf\data\user\online\UserOnline;
@@ -2365,19 +3037,21 @@ Compared to the pre-existing com.woltlab.wcf.people.PersonList page
 
 /**
  * Page handler implementation for person page.
- * 
+ *
  * @author  Matthias Schmidt
  * @copyright   2001-2019 WoltLab GmbH
  * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  * @package WoltLabSuite\Core\System\Page\Handler
  */
-class PersonPageHandler extends AbstractLookupPageHandler implements IOnlineLocationPageHandler {
+class PersonPageHandler extends AbstractLookupPageHandler implements IOnlineLocationPageHandler
+{
     use TOnlineLocationPageHandler;
 
     /**
      * @inheritDoc
      */
-    public function getLink($objectID) {
+    public function getLink($objectID)
+    {
         return PersonRuntimeCache::getInstance()->getObject($objectID)->getLink();
     }
 
@@ -2390,7 +3064,8 @@ Compared to the pre-existing com.woltlab.wcf.people.PersonList page
      * @param   UserOnline  $user       user online object with request data
      * @return  string
      */
-    public function getOnlineLocation(Page $page, UserOnline $user) {
+    public function getOnlineLocation(Page $page, UserOnline $user)
+    {
         if ($user->pageObjectID === null) {
             return '';
         }
@@ -2400,20 +3075,22 @@ Compared to the pre-existing com.woltlab.wcf.people.PersonList page
             return '';
         }
 
-        return WCF::getLanguage()->getDynamicVariable('wcf.page.onlineLocation.'.$page->identifier, ['person' => $person]);
+        return WCF::getLanguage()->getDynamicVariable('wcf.page.onlineLocation.' . $page->identifier, ['person' => $person]);
     }
 
     /**
      * @inheritDoc
      */
-    public function isValid($objectID = null) {
+    public function isValid($objectID = null)
+    {
         return PersonRuntimeCache::getInstance()->getObject($objectID) !== null;
     }
 
     /**
      * @inheritDoc
      */
-    public function lookup($searchString) {
+    public function lookup($searchString)
+    {
         $conditionBuilder = new PreparedStatementConditionBuilder(false, 'OR');
         $conditionBuilder->add('person.firstName LIKE ?', ['%' . $searchString . '%']);
         $conditionBuilder->add('person.lastName LIKE ?', ['%' . $searchString . '%']);
@@ -2428,7 +3105,7 @@ Compared to the pre-existing com.woltlab.wcf.people.PersonList page
                 'image' => 'fa-user',
                 'link' => $person->getLink(),
                 'objectID' => $person->personID,
-                'title' => $person->getTitle()
+                'title' => $person->getTitle(),
             ];
         }
 
@@ -2438,19 +3115,23 @@ Compared to the pre-existing com.woltlab.wcf.people.PersonList page
     /**
      * Prepares fetching all necessary data for the textual description if a user is currently online
      * viewing this page.
-     * 
+     *
      * @see IOnlineLocationPageHandler::prepareOnlineLocation()
      *
      * @param   Page        $page       visited page
      * @param   UserOnline  $user       user online object with request data
      */
-    public function prepareOnlineLocation(/** @noinspection PhpUnusedParameterInspection */Page $page, UserOnline $user) {
+    public function prepareOnlineLocation(Page $page, UserOnline $user)
+    {
         if ($user->pageObjectID !== null) {
             PersonRuntimeCache::getInstance()->cacheObjectID($user->pageObjectID);
         }
     }
 }
 
+
+
+
 Like any page handler, the PersonPageHandler class has to implement the IMenuPageHandler interface, which should be done by extending the AbstractMenuPageHandler class.
 As we want  administrators to link to specific people in menus, for example, we have to also implement the ILookupPageHandler interface by extending the AbstractLookupPageHandler class.
 For the ILookupPageHandler interface, we need to implement three methods:
@@ -2474,7 +3155,20 @@ The IOnlineLocationPageHandler interface requires two methods to be
 
 
 This concludes the third part of our tutorial series after which each person has a dedicated page on which people can comment on the person.
-The complete source code of this part can be found on GitHub.
+The complete source code of this part can be found on GitHub.
+                
+                  
+                    
+
+
+
+  
+    
+      Last update: 2021-04-23
+    
+  
+
+                  
                 
               
               
@@ -2485,6 +3179,7 @@ The IOnlineLocationPageHandler interface requires two methods to be
Comments#

Person Page#

`PersonPage`#

`person.tpl`#

`page.xml`#

`PersonPageHandler`#
