- <link rel="shortcut icon" href="../../../assets/default.favicon.ico">
- <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.0.3">
+ <link rel="canonical" href="https://docs.woltlab.com/5.4/tutorial/series/part_3/">
+
+ <link rel="icon" href="../../../assets/default.favicon.ico">
+ <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.1.3">
- <link rel="stylesheet" href="../../../assets/stylesheets/main.1655a90d.min.css">
+ <link rel="stylesheet" href="../../../assets/stylesheets/main.e35208c4.min.css">
- <link rel="stylesheet" href="../../../assets/stylesheets/palette.7fa14f5b.min.css">
+ <link rel="stylesheet" href="../../../assets/stylesheets/palette.ef6f36e2.min.css">
-
+
+
<link rel="stylesheet" href="../../../stylesheets/extra.css">
<body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent="">
-
+ <script>function __prefix(e){return new URL("../../..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
+
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
- <a href="#tutorial-series-part-3-person-page-and-comments" class="md-skip">
+ <a href="#part-3-person-page-and-comments" class="md-skip">
Skip to content
</a>
</div>
-
-
-<header class="md-header" data-md-component="header">
+ <header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
- <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation">
+ <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
<img src="../../../assets/logo.png" alt="logo">
</div>
</div>
</div>
- <div class="md-header__options">
-
- </div>
+
+
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
</label>
<button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
- <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
</button>
</form>
<div class="md-search__output">
</div>
+ <div class="md-header__source">
+
+<a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
+ <div class="md-source__icon md-icon">
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
+ </div>
+ <div class="md-source__repository">
+ GitHub
+ </div>
+</a>
+ </div>
+
</nav>
</header>
-
-
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
- <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation">
+ <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
<img src="../../../assets/logo.png" alt="logo">
WoltLab Suite Documentation
</label>
+ <div class="md-nav__source">
+
+<a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
+ <div class="md-source__icon md-icon">
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
+ </div>
+ <div class="md-source__repository">
+ GitHub
+ </div>
+</a>
+ </div>
+
<ul class="md-nav__list" data-md-scrollfix>
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+ <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_1" type="checkbox" id="__nav_2_5_1" >
+
+ <label class="md-nav__link" for="__nav_2_5_1">
+ Caches
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+ <nav class="md-nav" aria-label="Caches" data-md-level="3">
+ <label class="md-nav__title" for="__nav_2_5_1">
+ <span class="md-nav__icon md-icon"></span>
+ Caches
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
<li class="md-nav__item">
<a href="../../../php/api/caches/" class="md-nav__link">
- Caches
+ Overview
</a>
</li>
+ <li class="md-nav__item">
+ <a href="../../../php/api/caches_persistent-caches/" class="md-nav__link">
+ Persistent Caches
+ </a>
+ </li>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../php/api/caches_runtime-caches/" class="md-nav__link">
+ Runtime Caches
+ </a>
+ </li>
+
+
+
+ </ul>
+ </nav>
+ </li>
+
+
+
+
+
+
+
<li class="md-nav__item">
<a href="../../../php/api/comments/" class="md-nav__link">
Comments
+ <li class="md-nav__item">
+ <a href="../../../view/template-plugins/" class="md-nav__link">
+ Template Plugins
+ </a>
+ </li>
+
+
+
+
+
+
+
<li class="md-nav__item">
<a href="../../../view/css/" class="md-nav__link">
CSS
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4">
- JavaScript API
+ TypeScript and JavaScript API
<span class="md-nav__icon md-icon"></span>
</label>
- <nav class="md-nav" aria-label="JavaScript API" data-md-level="1">
+ <nav class="md-nav" aria-label="TypeScript and JavaScript API" data-md-level="1">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
- JavaScript API
+ TypeScript and JavaScript API
</label>
<ul class="md-nav__list" data-md-scrollfix>
+ <li class="md-nav__item">
+ <a href="../../../javascript/typescript/" class="md-nav__link">
+ TypeScript
+ </a>
+ </li>
+
+
+
+
+
+
+
<li class="md-nav__item md-nav__item--nested">
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_2" type="checkbox" id="__nav_4_2" >
+ <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
- <label class="md-nav__link" for="__nav_4_2">
+ <label class="md-nav__link" for="__nav_4_3">
New API
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="New API" data-md-level="2">
- <label class="md-nav__title" for="__nav_4_2">
+ <label class="md-nav__title" for="__nav_4_3">
<span class="md-nav__icon md-icon"></span>
New API
</label>
+ <li class="md-nav__item">
+ <a href="../../../package/pip/database/" class="md-nav__link">
+ database
+ </a>
+ </li>
+
+
+
+
+
+
+
<li class="md-nav__item">
<a href="../../../package/pip/event-listener/" class="md-nav__link">
eventListener
<li class="md-nav__item">
<a href="../../../migration/wsc53/javascript/" class="md-nav__link">
- JavaScript
+ TypeScript and JavaScript
</a>
</li>
<input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
+
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../part_4/" class="md-nav__link">
+ Part 4
+ </a>
+ </li>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../part_5/" class="md-nav__link">
+ Part 5
+ </a>
+ </li>
+
+
+
</ul>
</nav>
</li>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
+
<article class="md-content__inner md-typeset">
+ <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/tutorial/series/part_3.md" title="Edit this page" class="md-content__button md-icon">
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
+ </a>
+
- <h1 id="tutorial-series-part-3-person-page-and-comments">Tutorial Series Part 3: Person Page and Comments<a class="headerlink" href="#tutorial-series-part-3-person-page-and-comments" title="Permanent link">#</a></h1>
+ <h1 id="part-3-person-page-and-comments">Part 3: Person Page and Comments<a class="headerlink" href="#part-3-person-page-and-comments" title="Permanent link">#</a></h1>
<p>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.</p>
<h2 id="package-functionality">Package Functionality<a class="headerlink" href="#package-functionality" title="Permanent link">#</a></h2>
<p>In addition to the components used in <a href="../part_1/">part 1</a>, we will use the <a href="../../../package/pip/object-type/">objectType package installation plugin</a>, use the <a href="../../../php/api/comments/">comment API</a>, create a <a href="../../../php/api/caches_runtime-caches/">runtime cache</a>, and create a page handler.</p>
<h2 id="package-structure">Package Structure<a class="headerlink" href="#package-structure" title="Permanent link">#</a></h2>
<p>The complete package will have the following file structure (including the files from <a href="../part_1/">part 1</a>):</p>
-<div class="highlight"><pre><span></span><code>├── acpMenu.xml
+<table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
+<span class="normal"> 2</span>
+<span class="normal"> 3</span>
+<span class="normal"> 4</span>
+<span class="normal"> 5</span>
+<span class="normal"> 6</span>
+<span class="normal"> 7</span>
+<span class="normal"> 8</span>
+<span class="normal"> 9</span>
+<span class="normal">10</span>
+<span class="normal">11</span>
+<span class="normal">12</span>
+<span class="normal">13</span>
+<span class="normal">14</span>
+<span class="normal">15</span>
+<span class="normal">16</span>
+<span class="normal">17</span>
+<span class="normal">18</span>
+<span class="normal">19</span>
+<span class="normal">20</span>
+<span class="normal">21</span>
+<span class="normal">22</span>
+<span class="normal">23</span>
+<span class="normal">24</span>
+<span class="normal">25</span>
+<span class="normal">26</span>
+<span class="normal">27</span>
+<span class="normal">28</span>
+<span class="normal">29</span>
+<span class="normal">30</span>
+<span class="normal">31</span>
+<span class="normal">32</span>
+<span class="normal">33</span>
+<span class="normal">34</span>
+<span class="normal">35</span>
+<span class="normal">36</span>
+<span class="normal">37</span>
+<span class="normal">38</span>
+<span class="normal">39</span>
+<span class="normal">40</span>
+<span class="normal">41</span>
+<span class="normal">42</span>
+<span class="normal">43</span>
+<span class="normal">44</span>
+<span class="normal">45</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code>├── acpMenu.xml
├── acptemplates
│ ├── personAdd.tpl
│ └── personList.tpl
├── files
+│ ├── acp
+│ │ └── database
+│ │ └── install_com.woltlab.wcf.people.php
│ └── lib
│ ├── acp
│ │ ├── form
│ └── page
│ └── handler
│ └── PersonPageHandler.class.php
-├── install.sql
├── language
│ ├── de.xml
│ └── en.xml
│ └── personList.tpl
└── userGroupOption.xml
</code></pre></div>
-
+</td></tr></table>
<div class="admonition warning">
-<p class="admonition-title">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 <code>Person::getLink()</code> method and new language items have been added. For all changes, please refer to the <a href="https://github.com/WoltLab/woltlab.github.io/tree/master/_includes/tutorial/tutorial-series/part-3">source code on GitHub</a>.</p>
+<p class="admonition-title">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 <code>Person::getLink()</code> method and new language items have been added. For all changes, please refer to the <a href="https://github.com/WoltLab/docs.woltlab.com/tree/5.4/snippets/tutorial/tutorial-series/part-3">source code on GitHub</a>.</p>
</div>
<h2 id="runtime-cache">Runtime Cache<a class="headerlink" href="#runtime-cache" title="Permanent link">#</a></h2>
<p>To reduce the number of database queries when different APIs require person objects, we implement a <a href="../../../php/api/caches_runtime-caches/">runtime cache</a> for people:</p>
-<div class="highlight"><pre><span></span><code><span class="o"><?</span><span class="nx">php</span>
+<div class="titledCodeBox">
+ <div class="codeBoxTitle">
+ <code>files/lib/system/cache/runtime/PersonRuntimeCache.class.php</code>
+ <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/5.4/snippets/tutorial/tutorial-series/part-3/files/lib/system/cache/runtime/PersonRuntimeCache.class.php" title="View on GitHub"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5z"/></svg></span></a>
+ </div>
+ <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
+<span class="normal"> 2</span>
+<span class="normal"> 3</span>
+<span class="normal"> 4</span>
+<span class="normal"> 5</span>
+<span class="normal"> 6</span>
+<span class="normal"> 7</span>
+<span class="normal"> 8</span>
+<span class="normal"> 9</span>
+<span class="normal">10</span>
+<span class="normal">11</span>
+<span class="normal">12</span>
+<span class="normal">13</span>
+<span class="normal">14</span>
+<span class="normal">15</span>
+<span class="normal">16</span>
+<span class="normal">17</span>
+<span class="normal">18</span>
+<span class="normal">19</span>
+<span class="normal">20</span>
+<span class="normal">21</span>
+<span class="normal">22</span>
+<span class="normal">23</span>
+<span class="normal">24</span>
+<span class="normal">25</span>
+<span class="normal">26</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="o"><?</span><span class="nx">php</span>
+
<span class="k">namespace</span> <span class="nx">wcf\system\cache\runtime</span><span class="p">;</span>
+
<span class="k">use</span> <span class="nx">wcf\data\person\Person</span><span class="p">;</span>
<span class="k">use</span> <span class="nx">wcf\data\person\PersonList</span><span class="p">;</span>
<span class="sd"> * Runtime cache implementation for people.</span>
<span class="sd"> *</span>
<span class="sd"> * @author Matthias Schmidt</span>
-<span class="sd"> * @copyright 2001-2019 WoltLab GmbH</span>
+<span class="sd"> * @copyright 2001-2021 WoltLab GmbH</span>
<span class="sd"> * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php></span>
<span class="sd"> * @package WoltLabSuite\Core\System\Cache\Runtime</span>
-<span class="sd"> * @since 3.0</span>
<span class="sd"> *</span>
<span class="sd"> * @method Person[] getCachedObjects()</span>
<span class="sd"> * @method Person getObject($objectID)</span>
<span class="sd"> * @method Person[] getObjects(array $objectIDs)</span>
<span class="sd"> */</span>
-<span class="k">class</span> <span class="nc">PersonRuntimeCache</span> <span class="k">extends</span> <span class="nx">AbstractRuntimeCache</span> <span class="p">{</span>
+<span class="k">class</span> <span class="nc">PersonRuntimeCache</span> <span class="k">extends</span> <span class="nx">AbstractRuntimeCache</span>
+<span class="p">{</span>
<span class="sd">/**</span>
<span class="sd"> * @inheritDoc</span>
<span class="sd"> */</span>
<span class="k">protected</span> <span class="nv">$listClassName</span> <span class="o">=</span> <span class="nx">PersonList</span><span class="o">::</span><span class="na">class</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div>
+</td></tr></table>
+</div>
<h2 id="comments">Comments<a class="headerlink" href="#comments" title="Permanent link">#</a></h2>
<p>To allow users to comment on people, we need to tell the system that people support comments.
This is done by registering a <code>com.woltlab.wcf.comment.commentableContent</code> object type whose processor implements <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/comment/manager/ICommentManager.class.php">ICommentManager</a>:</p>
-<div class="highlight"><pre><span></span><code><span class="cp"><?xml version="1.0" encoding="UTF-8"?></span>
-<span class="nt"><data</span> <span class="na">xmlns=</span><span class="s">"http://www.woltlab.com"</span> <span class="na">xmlns:xsi=</span><span class="s">"http://www.w3.org/2001/XMLSchema-instance"</span> <span class="na">xsi:schemaLocation=</span><span class="s">"http://www.woltlab.com http://www.woltlab.com/XSD/tornado/objectType.xsd"</span><span class="nt">></span>
+<div class="titledCodeBox">
+ <div class="codeBoxTitle">
+ <code>objectType.xml</code>
+ <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/5.4/snippets/tutorial/tutorial-series/part-3/objectType.xml" title="View on GitHub"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5z"/></svg></span></a>
+ </div>
+ <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
+<span class="normal"> 2</span>
+<span class="normal"> 3</span>
+<span class="normal"> 4</span>
+<span class="normal"> 5</span>
+<span class="normal"> 6</span>
+<span class="normal"> 7</span>
+<span class="normal"> 8</span>
+<span class="normal"> 9</span>
+<span class="normal">10</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="cp"><?xml version="1.0" encoding="UTF-8"?></span>
+<span class="nt"><data</span> <span class="na">xmlns=</span><span class="s">"http://www.woltlab.com"</span> <span class="na">xmlns:xsi=</span><span class="s">"http://www.w3.org/2001/XMLSchema-instance"</span> <span class="na">xsi:schemaLocation=</span><span class="s">"http://www.woltlab.com http://www.woltlab.com/XSD/5.4/objectType.xsd"</span><span class="nt">></span>
<span class="nt"><import></span>
<span class="nt"><type></span>
<span class="nt"><name></span>com.woltlab.wcf.person.personComment<span class="nt"></name></span>
<span class="nt"></import></span>
<span class="nt"></data></span>
</code></pre></div>
+</td></tr></table>
+</div>
<p>The <code>PersonCommentManager</code> class extended <code>ICommentManager</code>’s default implementation <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/comment/manager/AbstractCommentManager.class.php">AbstractCommentManager</a>:</p>
-<div class="highlight"><pre><span></span><code><span class="o"><?</span><span class="nx">php</span>
+<div class="titledCodeBox">
+ <div class="codeBoxTitle">
+ <code>files/lib/system/comment/manager/PersonCommentManager.class.php</code>
+ <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/5.4/snippets/tutorial/tutorial-series/part-3/files/lib/system/comment/manager/PersonCommentManager.class.php" title="View on GitHub"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5z"/></svg></span></a>
+ </div>
+ <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
+<span class="normal"> 2</span>
+<span class="normal"> 3</span>
+<span class="normal"> 4</span>
+<span class="normal"> 5</span>
+<span class="normal"> 6</span>
+<span class="normal"> 7</span>
+<span class="normal"> 8</span>
+<span class="normal"> 9</span>
+<span class="normal">10</span>
+<span class="normal">11</span>
+<span class="normal">12</span>
+<span class="normal">13</span>
+<span class="normal">14</span>
+<span class="normal">15</span>
+<span class="normal">16</span>
+<span class="normal">17</span>
+<span class="normal">18</span>
+<span class="normal">19</span>
+<span class="normal">20</span>
+<span class="normal">21</span>
+<span class="normal">22</span>
+<span class="normal">23</span>
+<span class="normal">24</span>
+<span class="normal">25</span>
+<span class="normal">26</span>
+<span class="normal">27</span>
+<span class="normal">28</span>
+<span class="normal">29</span>
+<span class="normal">30</span>
+<span class="normal">31</span>
+<span class="normal">32</span>
+<span class="normal">33</span>
+<span class="normal">34</span>
+<span class="normal">35</span>
+<span class="normal">36</span>
+<span class="normal">37</span>
+<span class="normal">38</span>
+<span class="normal">39</span>
+<span class="normal">40</span>
+<span class="normal">41</span>
+<span class="normal">42</span>
+<span class="normal">43</span>
+<span class="normal">44</span>
+<span class="normal">45</span>
+<span class="normal">46</span>
+<span class="normal">47</span>
+<span class="normal">48</span>
+<span class="normal">49</span>
+<span class="normal">50</span>
+<span class="normal">51</span>
+<span class="normal">52</span>
+<span class="normal">53</span>
+<span class="normal">54</span>
+<span class="normal">55</span>
+<span class="normal">56</span>
+<span class="normal">57</span>
+<span class="normal">58</span>
+<span class="normal">59</span>
+<span class="normal">60</span>
+<span class="normal">61</span>
+<span class="normal">62</span>
+<span class="normal">63</span>
+<span class="normal">64</span>
+<span class="normal">65</span>
+<span class="normal">66</span>
+<span class="normal">67</span>
+<span class="normal">68</span>
+<span class="normal">69</span>
+<span class="normal">70</span>
+<span class="normal">71</span>
+<span class="normal">72</span>
+<span class="normal">73</span>
+<span class="normal">74</span>
+<span class="normal">75</span>
+<span class="normal">76</span>
+<span class="normal">77</span>
+<span class="normal">78</span>
+<span class="normal">79</span>
+<span class="normal">80</span>
+<span class="normal">81</span>
+<span class="normal">82</span>
+<span class="normal">83</span>
+<span class="normal">84</span>
+<span class="normal">85</span>
+<span class="normal">86</span>
+<span class="normal">87</span>
+<span class="normal">88</span>
+<span class="normal">89</span>
+<span class="normal">90</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="o"><?</span><span class="nx">php</span>
+
<span class="k">namespace</span> <span class="nx">wcf\system\comment\manager</span><span class="p">;</span>
+
<span class="k">use</span> <span class="nx">wcf\data\person\Person</span><span class="p">;</span>
<span class="k">use</span> <span class="nx">wcf\data\person\PersonEditor</span><span class="p">;</span>
<span class="k">use</span> <span class="nx">wcf\system\cache\runtime\PersonRuntimeCache</span><span class="p">;</span>
<span class="sd"> * Comment manager implementation for people.</span>
<span class="sd"> *</span>
<span class="sd"> * @author Matthias Schmidt</span>
-<span class="sd"> * @copyright 2001-2019 WoltLab GmbH</span>
+<span class="sd"> * @copyright 2001-2021 WoltLab GmbH</span>
<span class="sd"> * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php></span>
<span class="sd"> * @package WoltLabSuite\Core\System\Comment\Manager</span>
<span class="sd"> */</span>
-<span class="k">class</span> <span class="nc">PersonCommentManager</span> <span class="k">extends</span> <span class="nx">AbstractCommentManager</span> <span class="p">{</span>
+<span class="k">class</span> <span class="nc">PersonCommentManager</span> <span class="k">extends</span> <span class="nx">AbstractCommentManager</span>
+<span class="p">{</span>
<span class="sd">/**</span>
<span class="sd"> * @inheritDoc</span>
<span class="sd"> */</span>
<span class="sd">/**</span>
<span class="sd"> * @inheritDoc</span>
<span class="sd"> */</span>
- <span class="k">public</span> <span class="k">function</span> <span class="nf">getLink</span><span class="p">(</span><span class="nv">$objectTypeID</span><span class="p">,</span> <span class="nv">$objectID</span><span class="p">)</span> <span class="p">{</span>
+ <span class="k">public</span> <span class="k">function</span> <span class="nf">getLink</span><span class="p">(</span><span class="nv">$objectTypeID</span><span class="p">,</span> <span class="nv">$objectID</span><span class="p">)</span>
+ <span class="p">{</span>
<span class="k">return</span> <span class="nx">PersonRuntimeCache</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-></span><span class="na">getObject</span><span class="p">(</span><span class="nv">$objectID</span><span class="p">)</span><span class="o">-></span><span class="na">getLink</span><span class="p">();</span>
<span class="p">}</span>
<span class="sd">/**</span>
<span class="sd"> * @inheritDoc</span>
<span class="sd"> */</span>
- <span class="k">public</span> <span class="k">function</span> <span class="nf">isAccessible</span><span class="p">(</span><span class="nv">$objectID</span><span class="p">,</span> <span class="nv">$validateWritePermission</span> <span class="o">=</span> <span class="k">false</span><span class="p">)</span> <span class="p">{</span>
+ <span class="k">public</span> <span class="k">function</span> <span class="nf">isAccessible</span><span class="p">(</span><span class="nv">$objectID</span><span class="p">,</span> <span class="nv">$validateWritePermission</span> <span class="o">=</span> <span class="k">false</span><span class="p">)</span>
+ <span class="p">{</span>
<span class="k">return</span> <span class="nx">PersonRuntimeCache</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-></span><span class="na">getObject</span><span class="p">(</span><span class="nv">$objectID</span><span class="p">)</span> <span class="o">!==</span> <span class="k">null</span><span class="p">;</span>
<span class="p">}</span>
<span class="sd">/**</span>
<span class="sd"> * @inheritDoc</span>
<span class="sd"> */</span>
- <span class="k">public</span> <span class="k">function</span> <span class="nf">getTitle</span><span class="p">(</span><span class="nv">$objectTypeID</span><span class="p">,</span> <span class="nv">$objectID</span><span class="p">,</span> <span class="nv">$isResponse</span> <span class="o">=</span> <span class="k">false</span><span class="p">)</span> <span class="p">{</span>
+ <span class="k">public</span> <span class="k">function</span> <span class="nf">getTitle</span><span class="p">(</span><span class="nv">$objectTypeID</span><span class="p">,</span> <span class="nv">$objectID</span><span class="p">,</span> <span class="nv">$isResponse</span> <span class="o">=</span> <span class="k">false</span><span class="p">)</span>
+ <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nv">$isResponse</span><span class="p">)</span> <span class="p">{</span>
<span class="k">return</span> <span class="nx">WCF</span><span class="o">::</span><span class="na">getLanguage</span><span class="p">()</span><span class="o">-></span><span class="na">get</span><span class="p">(</span><span class="s1">'wcf.person.commentResponse'</span><span class="p">);</span>
<span class="p">}</span>
<span class="sd">/**</span>
<span class="sd"> * @inheritDoc</span>
<span class="sd"> */</span>
- <span class="k">public</span> <span class="k">function</span> <span class="nf">updateCounter</span><span class="p">(</span><span class="nv">$objectID</span><span class="p">,</span> <span class="nv">$value</span><span class="p">)</span> <span class="p">{</span>
+ <span class="k">public</span> <span class="k">function</span> <span class="nf">updateCounter</span><span class="p">(</span><span class="nv">$objectID</span><span class="p">,</span> <span class="nv">$value</span><span class="p">)</span>
+ <span class="p">{</span>
<span class="p">(</span><span class="k">new</span> <span class="nx">PersonEditor</span><span class="p">(</span><span class="k">new</span> <span class="nx">Person</span><span class="p">(</span><span class="nv">$objectID</span><span class="p">)))</span><span class="o">-></span><span class="na">updateCounters</span><span class="p">([</span><span class="s1">'comments'</span> <span class="o">=></span> <span class="nv">$value</span><span class="p">]);</span>
<span class="p">}</span>
<span class="p">}</span>
</code></pre></div>
+</td></tr></table>
+</div>
<ul>
<li>First, the system is told the names of the permissions via the <code>$permission*</code> properties.
</div>
<h2 id="person-page">Person Page<a class="headerlink" href="#person-page" title="Permanent link">#</a></h2>
<h3 id="personpage"><code>PersonPage</code><a class="headerlink" href="#personpage" title="Permanent link">#</a></h3>
-<div class="highlight"><pre><span></span><code><span class="o"><?</span><span class="nx">php</span>
+<div class="titledCodeBox">
+ <div class="codeBoxTitle">
+ <code>files/lib/page/PersonPage.class.php</code>
+ <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/5.4/snippets/tutorial/tutorial-series/part-3/files/lib/page/PersonPage.class.php" title="View on GitHub"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5z"/></svg></span></a>
+ </div>
+ <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
+<span class="normal"> 2</span>
+<span class="normal"> 3</span>
+<span class="normal"> 4</span>
+<span class="normal"> 5</span>
+<span class="normal"> 6</span>
+<span class="normal"> 7</span>
+<span class="normal"> 8</span>
+<span class="normal"> 9</span>
+<span class="normal"> 10</span>
+<span class="normal"> 11</span>
+<span class="normal"> 12</span>
+<span class="normal"> 13</span>
+<span class="normal"> 14</span>
+<span class="normal"> 15</span>
+<span class="normal"> 16</span>
+<span class="normal"> 17</span>
+<span class="normal"> 18</span>
+<span class="normal"> 19</span>
+<span class="normal"> 20</span>
+<span class="normal"> 21</span>
+<span class="normal"> 22</span>
+<span class="normal"> 23</span>
+<span class="normal"> 24</span>
+<span class="normal"> 25</span>
+<span class="normal"> 26</span>
+<span class="normal"> 27</span>
+<span class="normal"> 28</span>
+<span class="normal"> 29</span>
+<span class="normal"> 30</span>
+<span class="normal"> 31</span>
+<span class="normal"> 32</span>
+<span class="normal"> 33</span>
+<span class="normal"> 34</span>
+<span class="normal"> 35</span>
+<span class="normal"> 36</span>
+<span class="normal"> 37</span>
+<span class="normal"> 38</span>
+<span class="normal"> 39</span>
+<span class="normal"> 40</span>
+<span class="normal"> 41</span>
+<span class="normal"> 42</span>
+<span class="normal"> 43</span>
+<span class="normal"> 44</span>
+<span class="normal"> 45</span>
+<span class="normal"> 46</span>
+<span class="normal"> 47</span>
+<span class="normal"> 48</span>
+<span class="normal"> 49</span>
+<span class="normal"> 50</span>
+<span class="normal"> 51</span>
+<span class="normal"> 52</span>
+<span class="normal"> 53</span>
+<span class="normal"> 54</span>
+<span class="normal"> 55</span>
+<span class="normal"> 56</span>
+<span class="normal"> 57</span>
+<span class="normal"> 58</span>
+<span class="normal"> 59</span>
+<span class="normal"> 60</span>
+<span class="normal"> 61</span>
+<span class="normal"> 62</span>
+<span class="normal"> 63</span>
+<span class="normal"> 64</span>
+<span class="normal"> 65</span>
+<span class="normal"> 66</span>
+<span class="normal"> 67</span>
+<span class="normal"> 68</span>
+<span class="normal"> 69</span>
+<span class="normal"> 70</span>
+<span class="normal"> 71</span>
+<span class="normal"> 72</span>
+<span class="normal"> 73</span>
+<span class="normal"> 74</span>
+<span class="normal"> 75</span>
+<span class="normal"> 76</span>
+<span class="normal"> 77</span>
+<span class="normal"> 78</span>
+<span class="normal"> 79</span>
+<span class="normal"> 80</span>
+<span class="normal"> 81</span>
+<span class="normal"> 82</span>
+<span class="normal"> 83</span>
+<span class="normal"> 84</span>
+<span class="normal"> 85</span>
+<span class="normal"> 86</span>
+<span class="normal"> 87</span>
+<span class="normal"> 88</span>
+<span class="normal"> 89</span>
+<span class="normal"> 90</span>
+<span class="normal"> 91</span>
+<span class="normal"> 92</span>
+<span class="normal"> 93</span>
+<span class="normal"> 94</span>
+<span class="normal"> 95</span>
+<span class="normal"> 96</span>
+<span class="normal"> 97</span>
+<span class="normal"> 98</span>
+<span class="normal"> 99</span>
+<span class="normal">100</span>
+<span class="normal">101</span>
+<span class="normal">102</span>
+<span class="normal">103</span>
+<span class="normal">104</span>
+<span class="normal">105</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="o"><?</span><span class="nx">php</span>
+
<span class="k">namespace</span> <span class="nx">wcf\page</span><span class="p">;</span>
+
<span class="k">use</span> <span class="nx">wcf\data\person\Person</span><span class="p">;</span>
<span class="k">use</span> <span class="nx">wcf\system\comment\CommentHandler</span><span class="p">;</span>
<span class="k">use</span> <span class="nx">wcf\system\comment\manager\PersonCommentManager</span><span class="p">;</span>
<span class="sd">/**</span>
<span class="sd"> * Shows the details of a certain person.</span>
-<span class="sd"> * </span>
+<span class="sd"> *</span>
<span class="sd"> * @author Matthias Schmidt</span>
-<span class="sd"> * @copyright 2001-2019 WoltLab GmbH</span>
+<span class="sd"> * @copyright 2001-2021 WoltLab GmbH</span>
<span class="sd"> * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php></span>
<span class="sd"> * @package WoltLabSuite\Core\Page</span>
<span class="sd"> */</span>
-<span class="k">class</span> <span class="nc">PersonPage</span> <span class="k">extends</span> <span class="nx">AbstractPage</span> <span class="p">{</span>
+<span class="k">class</span> <span class="nc">PersonPage</span> <span class="k">extends</span> <span class="nx">AbstractPage</span>
+<span class="p">{</span>
<span class="sd">/**</span>
<span class="sd"> * list of comments</span>
<span class="sd"> * @var StructuredCommentList</span>
<span class="sd">/**</span>
<span class="sd"> * @inheritDoc</span>
<span class="sd"> */</span>
- <span class="k">public</span> <span class="k">function</span> <span class="nf">assignVariables</span><span class="p">()</span> <span class="p">{</span>
+ <span class="k">public</span> <span class="k">function</span> <span class="nf">assignVariables</span><span class="p">()</span>
+ <span class="p">{</span>
<span class="k">parent</span><span class="o">::</span><span class="na">assignVariables</span><span class="p">();</span>
<span class="nx">WCF</span><span class="o">::</span><span class="na">getTPL</span><span class="p">()</span><span class="o">-></span><span class="na">assign</span><span class="p">([</span>
<span class="s1">'commentList'</span> <span class="o">=></span> <span class="nv">$this</span><span class="o">-></span><span class="na">commentList</span><span class="p">,</span>
<span class="s1">'commentObjectTypeID'</span> <span class="o">=></span> <span class="nv">$this</span><span class="o">-></span><span class="na">commentObjectTypeID</span><span class="p">,</span>
<span class="s1">'lastCommentTime'</span> <span class="o">=></span> <span class="nv">$this</span><span class="o">-></span><span class="na">commentList</span> <span class="o">?</span> <span class="nv">$this</span><span class="o">-></span><span class="na">commentList</span><span class="o">-></span><span class="na">getMinCommentTime</span><span class="p">()</span> <span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s1">'likeData'</span> <span class="o">=></span> <span class="p">(</span><span class="nx">MODULE_LIKE</span> <span class="o">&&</span> <span class="nv">$this</span><span class="o">-></span><span class="na">commentList</span><span class="p">)</span> <span class="o">?</span> <span class="nv">$this</span><span class="o">-></span><span class="na">commentList</span><span class="o">-></span><span class="na">getLikeData</span><span class="p">()</span> <span class="o">:</span> <span class="p">[],</span>
- <span class="s1">'person'</span> <span class="o">=></span> <span class="nv">$this</span><span class="o">-></span><span class="na">person</span>
+ <span class="s1">'likeData'</span> <span class="o">=></span> <span class="nx">MODULE_LIKE</span> <span class="o">&&</span> <span class="nv">$this</span><span class="o">-></span><span class="na">commentList</span> <span class="o">?</span> <span class="nv">$this</span><span class="o">-></span><span class="na">commentList</span><span class="o">-></span><span class="na">getLikeData</span><span class="p">()</span> <span class="o">:</span> <span class="p">[],</span>
+ <span class="s1">'person'</span> <span class="o">=></span> <span class="nv">$this</span><span class="o">-></span><span class="na">person</span><span class="p">,</span>
<span class="p">]);</span>
<span class="p">}</span>
<span class="sd">/**</span>
<span class="sd"> * @inheritDoc</span>
<span class="sd"> */</span>
- <span class="k">public</span> <span class="k">function</span> <span class="nf">readData</span><span class="p">()</span> <span class="p">{</span>
+ <span class="k">public</span> <span class="k">function</span> <span class="nf">readData</span><span class="p">()</span>
+ <span class="p">{</span>
<span class="k">parent</span><span class="o">::</span><span class="na">readData</span><span class="p">();</span>
<span class="k">if</span> <span class="p">(</span><span class="nv">$this</span><span class="o">-></span><span class="na">person</span><span class="o">-></span><span class="na">enableComments</span><span class="p">)</span> <span class="p">{</span>
- <span class="nv">$this</span><span class="o">-></span><span class="na">commentObjectTypeID</span> <span class="o">=</span> <span class="nx">CommentHandler</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-></span><span class="na">getObjectTypeID</span><span class="p">(</span><span class="s1">'com.woltlab.wcf.person.personComment'</span><span class="p">);</span>
- <span class="nv">$this</span><span class="o">-></span><span class="na">commentManager</span> <span class="o">=</span> <span class="nx">CommentHandler</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-></span><span class="na">getObjectType</span><span class="p">(</span><span class="nv">$this</span><span class="o">-></span><span class="na">commentObjectTypeID</span><span class="p">)</span><span class="o">-></span><span class="na">getProcessor</span><span class="p">();</span>
- <span class="nv">$this</span><span class="o">-></span><span class="na">commentList</span> <span class="o">=</span> <span class="nx">CommentHandler</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-></span><span class="na">getCommentList</span><span class="p">(</span><span class="nv">$this</span><span class="o">-></span><span class="na">commentManager</span><span class="p">,</span> <span class="nv">$this</span><span class="o">-></span><span class="na">commentObjectTypeID</span><span class="p">,</span> <span class="nv">$this</span><span class="o">-></span><span class="na">person</span><span class="o">-></span><span class="na">personID</span><span class="p">);</span>
+ <span class="nv">$this</span><span class="o">-></span><span class="na">commentObjectTypeID</span> <span class="o">=</span> <span class="nx">CommentHandler</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-></span><span class="na">getObjectTypeID</span><span class="p">(</span>
+ <span class="s1">'com.woltlab.wcf.person.personComment'</span>
+ <span class="p">);</span>
+ <span class="nv">$this</span><span class="o">-></span><span class="na">commentManager</span> <span class="o">=</span> <span class="nx">CommentHandler</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-></span><span class="na">getObjectType</span><span class="p">(</span>
+ <span class="nv">$this</span><span class="o">-></span><span class="na">commentObjectTypeID</span>
+ <span class="p">)</span><span class="o">-></span><span class="na">getProcessor</span><span class="p">();</span>
+ <span class="nv">$this</span><span class="o">-></span><span class="na">commentList</span> <span class="o">=</span> <span class="nx">CommentHandler</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-></span><span class="na">getCommentList</span><span class="p">(</span>
+ <span class="nv">$this</span><span class="o">-></span><span class="na">commentManager</span><span class="p">,</span>
+ <span class="nv">$this</span><span class="o">-></span><span class="na">commentObjectTypeID</span><span class="p">,</span>
+ <span class="nv">$this</span><span class="o">-></span><span class="na">person</span><span class="o">-></span><span class="na">personID</span>
+ <span class="p">);</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="sd">/**</span>
<span class="sd"> * @inheritDoc</span>
<span class="sd"> */</span>
- <span class="k">public</span> <span class="k">function</span> <span class="nf">readParameters</span><span class="p">()</span> <span class="p">{</span>
+ <span class="k">public</span> <span class="k">function</span> <span class="nf">readParameters</span><span class="p">()</span>
+ <span class="p">{</span>
<span class="k">parent</span><span class="o">::</span><span class="na">readParameters</span><span class="p">();</span>
- <span class="k">if</span> <span class="p">(</span><span class="nb">isset</span><span class="p">(</span><span class="nv">$_REQUEST</span><span class="p">[</span><span class="s1">'id'</span><span class="p">]))</span> <span class="nv">$this</span><span class="o">-></span><span class="na">personID</span> <span class="o">=</span> <span class="nb">intval</span><span class="p">(</span><span class="nv">$_REQUEST</span><span class="p">[</span><span class="s1">'id'</span><span class="p">]);</span>
+ <span class="k">if</span> <span class="p">(</span><span class="nb">isset</span><span class="p">(</span><span class="nv">$_REQUEST</span><span class="p">[</span><span class="s1">'id'</span><span class="p">]))</span> <span class="p">{</span>
+ <span class="nv">$this</span><span class="o">-></span><span class="na">personID</span> <span class="o">=</span> <span class="nx">\intval</span><span class="p">(</span><span class="nv">$_REQUEST</span><span class="p">[</span><span class="s1">'id'</span><span class="p">]);</span>
+ <span class="p">}</span>
<span class="nv">$this</span><span class="o">-></span><span class="na">person</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Person</span><span class="p">(</span><span class="nv">$this</span><span class="o">-></span><span class="na">personID</span><span class="p">);</span>
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nv">$this</span><span class="o">-></span><span class="na">person</span><span class="o">-></span><span class="na">personID</span><span class="p">)</span> <span class="p">{</span>
<span class="k">throw</span> <span class="k">new</span> <span class="nx">IllegalLinkException</span><span class="p">();</span>
<span class="p">}</span>
<span class="p">}</span>
</code></pre></div>
+</td></tr></table>
+</div>
<p>The <code>PersonPage</code> class is similar to the <code>PersonEditForm</code> in the ACP in that it reads the id of the requested person from the request data and validates the id in <code>readParameters()</code>.
The rest of the code only handles fetching the list of comments on the requested person.
In <code>readData()</code>, this list is fetched using <code>CommentHandler::getCommentList()</code> if comments are enabled for the person.
The <code>assignVariables()</code> method assigns some additional template variables like <code>$commentCanAdd</code>, which is <code>1</code> if the active person can add comments and is <code>0</code> otherwise, <code>$lastCommentTime</code>, which contains the UNIX timestamp of the last comment, and <code>$likeData</code>, which contains data related to the likes for the disabled comments.</p>
<h3 id="persontpl"><code>person.tpl</code><a class="headerlink" href="#persontpl" title="Permanent link">#</a></h3>
-<div class="highlight"><pre><span></span><code>{capture assign='pageTitle'}{$person} - {lang}wcf.person.list{/lang}{/capture}
+<div class="titledCodeBox">
+ <div class="codeBoxTitle">
+ <code>templates/person.tpl</code>
+ <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/5.4/snippets/tutorial/tutorial-series/part-3/templates/person.tpl" title="View on GitHub"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5z"/></svg></span></a>
+ </div>
+ <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
+<span class="normal"> 2</span>
+<span class="normal"> 3</span>
+<span class="normal"> 4</span>
+<span class="normal"> 5</span>
+<span class="normal"> 6</span>
+<span class="normal"> 7</span>
+<span class="normal"> 8</span>
+<span class="normal"> 9</span>
+<span class="normal">10</span>
+<span class="normal">11</span>
+<span class="normal">12</span>
+<span class="normal">13</span>
+<span class="normal">14</span>
+<span class="normal">15</span>
+<span class="normal">16</span>
+<span class="normal">17</span>
+<span class="normal">18</span>
+<span class="normal">19</span>
+<span class="normal">20</span>
+<span class="normal">21</span>
+<span class="normal">22</span>
+<span class="normal">23</span>
+<span class="normal">24</span>
+<span class="normal">25</span>
+<span class="normal">26</span>
+<span class="normal">27</span>
+<span class="normal">28</span>
+<span class="normal">29</span>
+<span class="normal">30</span>
+<span class="normal">31</span>
+<span class="normal">32</span>
+<span class="normal">33</span>
+<span class="normal">34</span>
+<span class="normal">35</span>
+<span class="normal">36</span>
+<span class="normal">37</span>
+<span class="normal">38</span>
+<span class="normal">39</span>
+<span class="normal">40</span>
+<span class="normal">41</span>
+<span class="normal">42</span>
+<span class="normal">43</span>
+<span class="normal">44</span>
+<span class="normal">45</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code>{capture assign='pageTitle'}{$person} - {lang}wcf.person.list{/lang}{/capture}
{capture assign='contentTitle'}{$person}{/capture}
{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>
{include file='footer'}
</code></pre></div>
+</td></tr></table>
+</div>
<p>For now, the <code>person</code> 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 <code>ul#personCommentList</code> element for the comments shown by <code>commentList</code> template.
The <code>commentListAddComment</code> template adds the WYSIWYG support.
The attribute <code>wysiwygSelector</code> should be the id of the comment list <code>personCommentList</code> with an additional <code>AddComment</code> suffix.</p>
<h3 id="pagexml"><code>page.xml</code><a class="headerlink" href="#pagexml" title="Permanent link">#</a></h3>
-<div class="highlight"><pre><span></span><code><span class="cp"><?xml version="1.0" encoding="UTF-8"?></span>
-<span class="nt"><data</span> <span class="na">xmlns=</span><span class="s">"http://www.woltlab.com"</span> <span class="na">xmlns:xsi=</span><span class="s">"http://www.w3.org/2001/XMLSchema-instance"</span> <span class="na">xsi:schemaLocation=</span><span class="s">"http://www.woltlab.com http://www.woltlab.com/XSD/tornado/page.xsd"</span><span class="nt">></span>
+<div class="titledCodeBox">
+ <div class="codeBoxTitle">
+ <code>page.xml</code>
+ <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/5.4/snippets/tutorial/tutorial-series/part-3/page.xml" title="View on GitHub"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5z"/></svg></span></a>
+ </div>
+ <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
+<span class="normal"> 2</span>
+<span class="normal"> 3</span>
+<span class="normal"> 4</span>
+<span class="normal"> 5</span>
+<span class="normal"> 6</span>
+<span class="normal"> 7</span>
+<span class="normal"> 8</span>
+<span class="normal"> 9</span>
+<span class="normal">10</span>
+<span class="normal">11</span>
+<span class="normal">12</span>
+<span class="normal">13</span>
+<span class="normal">14</span>
+<span class="normal">15</span>
+<span class="normal">16</span>
+<span class="normal">17</span>
+<span class="normal">18</span>
+<span class="normal">19</span>
+<span class="normal">20</span>
+<span class="normal">21</span>
+<span class="normal">22</span>
+<span class="normal">23</span>
+<span class="normal">24</span>
+<span class="normal">25</span>
+<span class="normal">26</span>
+<span class="normal">27</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="cp"><?xml version="1.0" encoding="UTF-8"?></span>
+<span class="nt"><data</span> <span class="na">xmlns=</span><span class="s">"http://www.woltlab.com"</span> <span class="na">xmlns:xsi=</span><span class="s">"http://www.w3.org/2001/XMLSchema-instance"</span> <span class="na">xsi:schemaLocation=</span><span class="s">"http://www.woltlab.com http://www.woltlab.com/XSD/5.4/page.xsd"</span><span class="nt">></span>
<span class="nt"><import></span>
<span class="nt"><page</span> <span class="na">identifier=</span><span class="s">"com.woltlab.wcf.people.PersonList"</span><span class="nt">></span>
<span class="nt"><pageType></span>system<span class="nt"></pageType></span>
<span class="nt"></import></span>
<span class="nt"></data></span>
</code></pre></div>
+</td></tr></table>
+</div>
<p>The <code>page.xml</code> file has been extended for the new person page with identifier <code>com.woltlab.wcf.people.Person</code>.
Compared to the pre-existing <code>com.woltlab.wcf.people.PersonList</code> page, there are four differences:</p>
In general, the details page for any type of object that is listed on a different page has the list page as its parent.</li>
</ol>
<h3 id="personpagehandler"><code>PersonPageHandler</code><a class="headerlink" href="#personpagehandler" title="Permanent link">#</a></h3>
-<div class="highlight"><pre><span></span><code><span class="o"><?</span><span class="nx">php</span>
+<div class="titledCodeBox">
+ <div class="codeBoxTitle">
+ <code>files/lib/system/page/handler/PersonPageHandler.class.php</code>
+ <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/5.4/snippets/tutorial/tutorial-series/part-3/files/lib/system/page/handler/PersonPageHandler.class.php" title="View on GitHub"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5z"/></svg></span></a>
+ </div>
+ <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
+<span class="normal"> 2</span>
+<span class="normal"> 3</span>
+<span class="normal"> 4</span>
+<span class="normal"> 5</span>
+<span class="normal"> 6</span>
+<span class="normal"> 7</span>
+<span class="normal"> 8</span>
+<span class="normal"> 9</span>
+<span class="normal"> 10</span>
+<span class="normal"> 11</span>
+<span class="normal"> 12</span>
+<span class="normal"> 13</span>
+<span class="normal"> 14</span>
+<span class="normal"> 15</span>
+<span class="normal"> 16</span>
+<span class="normal"> 17</span>
+<span class="normal"> 18</span>
+<span class="normal"> 19</span>
+<span class="normal"> 20</span>
+<span class="normal"> 21</span>
+<span class="normal"> 22</span>
+<span class="normal"> 23</span>
+<span class="normal"> 24</span>
+<span class="normal"> 25</span>
+<span class="normal"> 26</span>
+<span class="normal"> 27</span>
+<span class="normal"> 28</span>
+<span class="normal"> 29</span>
+<span class="normal"> 30</span>
+<span class="normal"> 31</span>
+<span class="normal"> 32</span>
+<span class="normal"> 33</span>
+<span class="normal"> 34</span>
+<span class="normal"> 35</span>
+<span class="normal"> 36</span>
+<span class="normal"> 37</span>
+<span class="normal"> 38</span>
+<span class="normal"> 39</span>
+<span class="normal"> 40</span>
+<span class="normal"> 41</span>
+<span class="normal"> 42</span>
+<span class="normal"> 43</span>
+<span class="normal"> 44</span>
+<span class="normal"> 45</span>
+<span class="normal"> 46</span>
+<span class="normal"> 47</span>
+<span class="normal"> 48</span>
+<span class="normal"> 49</span>
+<span class="normal"> 50</span>
+<span class="normal"> 51</span>
+<span class="normal"> 52</span>
+<span class="normal"> 53</span>
+<span class="normal"> 54</span>
+<span class="normal"> 55</span>
+<span class="normal"> 56</span>
+<span class="normal"> 57</span>
+<span class="normal"> 58</span>
+<span class="normal"> 59</span>
+<span class="normal"> 60</span>
+<span class="normal"> 61</span>
+<span class="normal"> 62</span>
+<span class="normal"> 63</span>
+<span class="normal"> 64</span>
+<span class="normal"> 65</span>
+<span class="normal"> 66</span>
+<span class="normal"> 67</span>
+<span class="normal"> 68</span>
+<span class="normal"> 69</span>
+<span class="normal"> 70</span>
+<span class="normal"> 71</span>
+<span class="normal"> 72</span>
+<span class="normal"> 73</span>
+<span class="normal"> 74</span>
+<span class="normal"> 75</span>
+<span class="normal"> 76</span>
+<span class="normal"> 77</span>
+<span class="normal"> 78</span>
+<span class="normal"> 79</span>
+<span class="normal"> 80</span>
+<span class="normal"> 81</span>
+<span class="normal"> 82</span>
+<span class="normal"> 83</span>
+<span class="normal"> 84</span>
+<span class="normal"> 85</span>
+<span class="normal"> 86</span>
+<span class="normal"> 87</span>
+<span class="normal"> 88</span>
+<span class="normal"> 89</span>
+<span class="normal"> 90</span>
+<span class="normal"> 91</span>
+<span class="normal"> 92</span>
+<span class="normal"> 93</span>
+<span class="normal"> 94</span>
+<span class="normal"> 95</span>
+<span class="normal"> 96</span>
+<span class="normal"> 97</span>
+<span class="normal"> 98</span>
+<span class="normal"> 99</span>
+<span class="normal">100</span>
+<span class="normal">101</span>
+<span class="normal">102</span>
+<span class="normal">103</span>
+<span class="normal">104</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="o"><?</span><span class="nx">php</span>
+
<span class="k">namespace</span> <span class="nx">wcf\system\page\handler</span><span class="p">;</span>
+
<span class="k">use</span> <span class="nx">wcf\data\page\Page</span><span class="p">;</span>
<span class="k">use</span> <span class="nx">wcf\data\person\PersonList</span><span class="p">;</span>
<span class="k">use</span> <span class="nx">wcf\data\user\online\UserOnline</span><span class="p">;</span>
<span class="sd">/**</span>
<span class="sd"> * Page handler implementation for person page.</span>
-<span class="sd"> * </span>
+<span class="sd"> *</span>
<span class="sd"> * @author Matthias Schmidt</span>
<span class="sd"> * @copyright 2001-2019 WoltLab GmbH</span>
<span class="sd"> * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php></span>
<span class="sd"> * @package WoltLabSuite\Core\System\Page\Handler</span>
<span class="sd"> */</span>
-<span class="k">class</span> <span class="nc">PersonPageHandler</span> <span class="k">extends</span> <span class="nx">AbstractLookupPageHandler</span> <span class="k">implements</span> <span class="nx">IOnlineLocationPageHandler</span> <span class="p">{</span>
+<span class="k">class</span> <span class="nc">PersonPageHandler</span> <span class="k">extends</span> <span class="nx">AbstractLookupPageHandler</span> <span class="k">implements</span> <span class="nx">IOnlineLocationPageHandler</span>
+<span class="p">{</span>
<span class="k">use</span> <span class="nx">TOnlineLocationPageHandler</span><span class="p">;</span>
<span class="sd">/**</span>
<span class="sd"> * @inheritDoc</span>
<span class="sd"> */</span>
- <span class="k">public</span> <span class="k">function</span> <span class="nf">getLink</span><span class="p">(</span><span class="nv">$objectID</span><span class="p">)</span> <span class="p">{</span>
+ <span class="k">public</span> <span class="k">function</span> <span class="nf">getLink</span><span class="p">(</span><span class="nv">$objectID</span><span class="p">)</span>
+ <span class="p">{</span>
<span class="k">return</span> <span class="nx">PersonRuntimeCache</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-></span><span class="na">getObject</span><span class="p">(</span><span class="nv">$objectID</span><span class="p">)</span><span class="o">-></span><span class="na">getLink</span><span class="p">();</span>
<span class="p">}</span>
<span class="sd"> * @param UserOnline $user user online object with request data</span>
<span class="sd"> * @return string</span>
<span class="sd"> */</span>
- <span class="k">public</span> <span class="k">function</span> <span class="nf">getOnlineLocation</span><span class="p">(</span><span class="nx">Page</span> <span class="nv">$page</span><span class="p">,</span> <span class="nx">UserOnline</span> <span class="nv">$user</span><span class="p">)</span> <span class="p">{</span>
+ <span class="k">public</span> <span class="k">function</span> <span class="nf">getOnlineLocation</span><span class="p">(</span><span class="nx">Page</span> <span class="nv">$page</span><span class="p">,</span> <span class="nx">UserOnline</span> <span class="nv">$user</span><span class="p">)</span>
+ <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nv">$user</span><span class="o">-></span><span class="na">pageObjectID</span> <span class="o">===</span> <span class="k">null</span><span class="p">)</span> <span class="p">{</span>
<span class="k">return</span> <span class="s1">''</span><span class="p">;</span>
<span class="p">}</span>
<span class="k">return</span> <span class="s1">''</span><span class="p">;</span>
<span class="p">}</span>
- <span class="k">return</span> <span class="nx">WCF</span><span class="o">::</span><span class="na">getLanguage</span><span class="p">()</span><span class="o">-></span><span class="na">getDynamicVariable</span><span class="p">(</span><span class="s1">'wcf.page.onlineLocation.'</span><span class="o">.</span><span class="nv">$page</span><span class="o">-></span><span class="na">identifier</span><span class="p">,</span> <span class="p">[</span><span class="s1">'person'</span> <span class="o">=></span> <span class="nv">$person</span><span class="p">]);</span>
+ <span class="k">return</span> <span class="nx">WCF</span><span class="o">::</span><span class="na">getLanguage</span><span class="p">()</span><span class="o">-></span><span class="na">getDynamicVariable</span><span class="p">(</span><span class="s1">'wcf.page.onlineLocation.'</span> <span class="o">.</span> <span class="nv">$page</span><span class="o">-></span><span class="na">identifier</span><span class="p">,</span> <span class="p">[</span><span class="s1">'person'</span> <span class="o">=></span> <span class="nv">$person</span><span class="p">]);</span>
<span class="p">}</span>
<span class="sd">/**</span>
<span class="sd"> * @inheritDoc</span>
<span class="sd"> */</span>
- <span class="k">public</span> <span class="k">function</span> <span class="nf">isValid</span><span class="p">(</span><span class="nv">$objectID</span> <span class="o">=</span> <span class="k">null</span><span class="p">)</span> <span class="p">{</span>
+ <span class="k">public</span> <span class="k">function</span> <span class="nf">isValid</span><span class="p">(</span><span class="nv">$objectID</span> <span class="o">=</span> <span class="k">null</span><span class="p">)</span>
+ <span class="p">{</span>
<span class="k">return</span> <span class="nx">PersonRuntimeCache</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-></span><span class="na">getObject</span><span class="p">(</span><span class="nv">$objectID</span><span class="p">)</span> <span class="o">!==</span> <span class="k">null</span><span class="p">;</span>
<span class="p">}</span>
<span class="sd">/**</span>
<span class="sd"> * @inheritDoc</span>
<span class="sd"> */</span>
- <span class="k">public</span> <span class="k">function</span> <span class="nf">lookup</span><span class="p">(</span><span class="nv">$searchString</span><span class="p">)</span> <span class="p">{</span>
+ <span class="k">public</span> <span class="k">function</span> <span class="nf">lookup</span><span class="p">(</span><span class="nv">$searchString</span><span class="p">)</span>
+ <span class="p">{</span>
<span class="nv">$conditionBuilder</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">PreparedStatementConditionBuilder</span><span class="p">(</span><span class="k">false</span><span class="p">,</span> <span class="s1">'OR'</span><span class="p">);</span>
<span class="nv">$conditionBuilder</span><span class="o">-></span><span class="na">add</span><span class="p">(</span><span class="s1">'person.firstName LIKE ?'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'%'</span> <span class="o">.</span> <span class="nv">$searchString</span> <span class="o">.</span> <span class="s1">'%'</span><span class="p">]);</span>
<span class="nv">$conditionBuilder</span><span class="o">-></span><span class="na">add</span><span class="p">(</span><span class="s1">'person.lastName LIKE ?'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'%'</span> <span class="o">.</span> <span class="nv">$searchString</span> <span class="o">.</span> <span class="s1">'%'</span><span class="p">]);</span>
<span class="s1">'image'</span> <span class="o">=></span> <span class="s1">'fa-user'</span><span class="p">,</span>
<span class="s1">'link'</span> <span class="o">=></span> <span class="nv">$person</span><span class="o">-></span><span class="na">getLink</span><span class="p">(),</span>
<span class="s1">'objectID'</span> <span class="o">=></span> <span class="nv">$person</span><span class="o">-></span><span class="na">personID</span><span class="p">,</span>
- <span class="s1">'title'</span> <span class="o">=></span> <span class="nv">$person</span><span class="o">-></span><span class="na">getTitle</span><span class="p">()</span>
+ <span class="s1">'title'</span> <span class="o">=></span> <span class="nv">$person</span><span class="o">-></span><span class="na">getTitle</span><span class="p">(),</span>
<span class="p">];</span>
<span class="p">}</span>
<span class="sd">/**</span>
<span class="sd"> * Prepares fetching all necessary data for the textual description if a user is currently online</span>
<span class="sd"> * viewing this page.</span>
-<span class="sd"> * </span>
+<span class="sd"> *</span>
<span class="sd"> * @see IOnlineLocationPageHandler::prepareOnlineLocation()</span>
<span class="sd"> *</span>
<span class="sd"> * @param Page $page visited page</span>
<span class="sd"> * @param UserOnline $user user online object with request data</span>
<span class="sd"> */</span>
- <span class="k">public</span> <span class="k">function</span> <span class="nf">prepareOnlineLocation</span><span class="p">(</span><span class="sd">/** @noinspection PhpUnusedParameterInspection */</span><span class="nx">Page</span> <span class="nv">$page</span><span class="p">,</span> <span class="nx">UserOnline</span> <span class="nv">$user</span><span class="p">)</span> <span class="p">{</span>
+ <span class="k">public</span> <span class="k">function</span> <span class="nf">prepareOnlineLocation</span><span class="p">(</span><span class="nx">Page</span> <span class="nv">$page</span><span class="p">,</span> <span class="nx">UserOnline</span> <span class="nv">$user</span><span class="p">)</span>
+ <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="nv">$user</span><span class="o">-></span><span class="na">pageObjectID</span> <span class="o">!==</span> <span class="k">null</span><span class="p">)</span> <span class="p">{</span>
<span class="nx">PersonRuntimeCache</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-></span><span class="na">cacheObjectID</span><span class="p">(</span><span class="nv">$user</span><span class="o">-></span><span class="na">pageObjectID</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
</code></pre></div>
+</td></tr></table>
+</div>
<p>Like any page handler, the <code>PersonPageHandler</code> class has to implement the <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/page/handler/IMenuPageHandler.class.php">IMenuPageHandler</a> interface, which should be done by extending the <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/page/handler/AbstractMenuPageHandler.class.php">AbstractMenuPageHandler</a> class.
As we want administrators to link to specific people in menus, for example, we have to also implement the <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/page/handler/ILookupPageHandler.class.php">ILookupPageHandler</a> interface by extending the <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/page/handler/AbstractLookupPageHandler.class.php">AbstractLookupPageHandler</a> class.</p>
</ol>
<hr />
<p>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.</p>
-<p>The complete source code of this part can be found on <a href="https://github.com/WoltLab/woltlab.github.io/tree/master/_includes/tutorial/tutorial-series/part-3">GitHub</a>.</p>
+<p>The complete source code of this part can be found on <a href="https://github.com/WoltLab/docs.woltlab.com/tree/5.4/snippets/tutorial/tutorial-series/part-3">GitHub</a>.</p>
+
+
+
+
+<hr>
+<div class="md-source-date">
+ <small>
+
+ Last update: 2021-04-23
+
+ </small>
+</div>
+
</article>
</div>
</div>
+
</main>
</a>
+ <a href="../part_4/" class="md-footer__link md-footer__link--next" rel="next">
+ <div class="md-footer__title">
+ <div class="md-ellipsis">
+ <span class="md-footer__direction">
+ Next
+ </span>
+ Part 4
+ </div>
+ </div>
+ <div class="md-footer__button md-icon">
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
+ </div>
+ </a>
+
</nav>
<div class="md-footer-meta md-typeset">
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
+
</div>
<div class="md-footer-copyright">
<a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
- <script id="__config" type="application/json">{"base": "../../..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}, "search": "../../../assets/javascripts/workers/search.fb4a9340.min.js", "version": {"provider": "mike"}}</script>
+ <script id="__config" type="application/json">{"base": "../../..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}, "search": "../../../assets/javascripts/workers/search.fe42c31b.min.js", "version": {"provider": "mike"}}</script>
- <script src="../../../assets/javascripts/bundle.ca5457b8.min.js"></script>
+ <script src="../../../assets/javascripts/bundle.4ea5477f.min.js"></script>
</body>
projects / GitHub / WoltLab / woltlab.github.io.git / blobdiff