Add `@method` comment for `DatabaseObjectList::getSingleObject()` in subclasses
[GitHub/WoltLab/WCF.git] / wcfsetup / install / files / lib / data / user / UserList.class.php
1 <?php
2
3 namespace wcf\data\user;
4
5 use wcf\data\DatabaseObjectList;
6
7 /**
8 * Represents a list of users.
9 *
10 * @author Alexander Ebert
11 * @copyright 2001-2019 WoltLab GmbH
12 * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
13 * @package WoltLabSuite\Core\Data\User
14 *
15 * @method User current()
16 * @method User[] getObjects()
17 * @method User|null getSingleObject()
18 * @method User|null seach($objectID)
19 * @property User[] $objects
20 */
21 class UserList extends DatabaseObjectList
22 {
23 /**
24 * @inheritDoc
25 */
26 public $className = User::class;
27
28 /**
29 * @inheritDoc
30 */
31 public function __construct()
32 {
33 parent::__construct();
34
35 if (!empty($this->sqlSelects)) {
36 $this->sqlSelects .= ',';
37 }
38 $this->sqlSelects .= "user_option_value.*";
39 $this->sqlJoins .= "
40 LEFT JOIN wcf" . WCF_N . "_user_option_value user_option_value
41 ON user_option_value.userID = user_table.userID";
42 }
43 }