Add php doc

Author: Simonsator

src/Simonsator/PartyAndFriends/PAFPlayer.php

@@ -8,23 +8,39 @@ class PAFPlayer
 	private string $name;
 	private int $id;
 
+	/**
+	 * @param string $pUUID
+	 * @param string $pName
+	 * @param int $pID
+	 *
+	 * This constructor should only be called from within the library. It should never be created by an external class.
+	 */
 	public function __construct(string $pUUID, string $pName, int $pID)
 	{
 		$this->uniqueID = $pUUID;
 		$this->name = $pName;
 		$this->id = $pID;
 	}
 
+	/**
+	 * @return string The name of the player (not the display name)
+	 */
 	public function getName(): string
 	{
 		return $this->name;
 	}
 
+	/**
+	 * @return string The unique id of the player
+	 */
 	public function getUniqueID(): string
 	{
 		return $this->uniqueID;
 	}
 
+	/**
+	 * @return PAFPlayer[] Returns an array with all friends of the player
+	 */
 	public function getFriends(): array
 	{
 		$stmt = PAFPlayerManager::getInstance()->getConnection()->prepare(
@@ -50,6 +66,9 @@ public function getFriends(): array
 		return [];
 	}
 
+	/**
+	 * @return PAFPlayer[] Returns an array with containing all players that have sent a friend request to the player, which have not yet been denied or accepted
+	 */
 	public function getFriendRequests(): array
 	{
 		$stmt = PAFPlayerManager::getInstance()->getConnection()->prepare(
@@ -71,6 +90,9 @@ public function getFriendRequests(): array
 		return [];
 	}
 
+	/**
+	 * @return PAFPlayer[] Returns an array with all open friend requests this player sent to other players
+	 */
 	public function getSentFriendRequests(): array
 	{
 		$stmt = PAFPlayerManager::getInstance()->getConnection()->prepare(
@@ -92,6 +114,17 @@ public function getSentFriendRequests(): array
 		return [];
 	}
 
+	/**
+	 * @param int $pSettingsID The id of the setting. Extensions might add more settings, but by default, the plugin has the following settings:
+	 *                         0 = Friend Request Setting
+	 *                         1 = Party Invite Setting
+	 *                         2 = PM Setting
+	 *                         3 = Offline Setting
+	 *                         4 = Jump Setting
+	 *                         6 = Hide Setting
+	 *
+	 * @return int Returns the value of the setting
+	 */
 	public function getSettingsWorth(int $pSettingsID): int
 	{
 		$stmt = PAFPlayerManager::getInstance()->getConnection()->prepare(
@@ -104,6 +137,10 @@ public function getSettingsWorth(int $pSettingsID): int
 		return 0;
 	}
 
+	/**
+	 * @param PAFPlayer $player The player which should be the new friend of this player
+	 * @return void
+	 */
 	public function addFriend(PAFPlayer $player)
 	{
 		$stmt = PAFPlayerManager::getInstance()->getConnection()->prepare(
@@ -112,12 +149,19 @@ public function addFriend(PAFPlayer $player)
 		$stmt->execute();
 	}
 
+	/**
+	 * @return int Returns the id of the player as used in the party and friends database
+	 */
 	public function getID(): int
 	{
 		return $this->id;
 	}
 
-	public function sendFriendRequest(PAFPlayer $player)
+	/**
+	 * @param PAFPlayer $player The player which should receive a friend request from this player
+	 * @return void
+	 */
+	public function sendFriendRequest(PAFPlayer $player): void
 	{
 		$stmt = PAFPlayerManager::getInstance()->getConnection()->prepare(
 			"INSERT INTO {PAFPlayerManager::getInstance()->getTablePrefix()}friend_assignment 

src/Simonsator/PartyAndFriends/PAFPlayerManager.php

@@ -1,9 +1,4 @@
 <?php
-/**
- * User: Simonsator
- * Date: 10.02.17
- * Time: 14:28
- */
 
 namespace Simonsator\PartyAndFriends;
 
@@ -19,18 +14,29 @@ class PAFPlayerManager
 	private PDO $connection;
 	private string $tablePrefix;
 
+	/**
+	 * @param PDO $pPod The connection to the MySQL database
+	 * @param string $tablePrefix The prefix of the tables as set in the Party and Friends config
+	 */
 	public function __construct(PDO $pPod, string $tablePrefix)
 	{
 		self::$instance = $this;
 		$this->connection = $pPod;
 		$this->tablePrefix = $tablePrefix;
 	}
 
+	/**
+	 * @return PAFPlayerManager Returns the instance of the PAFPlayerManager. Make sure that it was initialized using the constructor before using this method
+	 */
 	public static function getInstance(): PAFPlayerManager
 	{
 		return self::$instance;
 	}
 
+	/**
+	 * @param string $pUUID The uuid of the player
+	 * @return PAFPlayer|null Returns the player if they ever joined the server or null if they did never join this server
+	 */
 	public function getPlayerByUUID(string $pUUID): ?PAFPlayer
 	{
 		$stmt = $this->connection->prepare(
@@ -47,14 +53,18 @@ public function getPlayerByUUID(string $pUUID): ?PAFPlayer
 	}
 
 	/**
-	 * @return String
+	 * @return String Returns the prefix of the tables as set in the Party and Friends config
 	 */
 	public function getTablePrefix(): string
 	{
 		return $this->tablePrefix;
 	}
 
-	public function getPlayerByID($pID): ?PAFPlayer
+	/**
+	 * @param int $pID The id of the player as used in the party and friends database
+	 * @return PAFPlayer|null Returns the corresponding player if the id belongs to a player or null if the id does not belong to a player
+	 */
+	public function getPlayerByID(int $pID): ?PAFPlayer
 	{
 		$stmt = $this->connection->prepare(
 			"SELECT player_id, player_uuid, player_name 
@@ -74,7 +84,11 @@ public function getConnection(): PDO
 		return $this->connection;
 	}
 
-	public function getPlayerByName($pPlayerName): ?PAFPlayer
+	/**
+	 * @param string $pPlayerName The name of the player
+	 * @return PAFPlayer|null Returns the player if they ever joined the server or null if they did never join this server
+	 */
+	public function getPlayerByName(string $pPlayerName): ?PAFPlayer
 	{
 		$stmt = $this->connection->prepare(
 			"SELECT player_id, player_uuid, player_name