From de0792868918e81fe6ce707037c6ee7b3d42796b Mon Sep 17 00:00:00 2001 From: netkas Date: Thu, 19 Dec 2024 21:11:40 -0500 Subject: [PATCH] Refine PHPDoc comments for better clarity. --- src/Socialbox/Objects/Standard/SessionState.php | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/src/Socialbox/Objects/Standard/SessionState.php b/src/Socialbox/Objects/Standard/SessionState.php index d4d4715..d2352ae 100644 --- a/src/Socialbox/Objects/Standard/SessionState.php +++ b/src/Socialbox/Objects/Standard/SessionState.php @@ -70,8 +70,9 @@ } /** + * Retrieves the identifier of the current instance. * - * @return string The identifier associated with the entity. + * @return string The identifier as a string. */ public function getIdentifiedAs(): string { @@ -89,8 +90,9 @@ } /** + * Retrieves the flags associated with the current instance. * - * @return array|null + * @return array|null An array of flags or null if no flags are set. */ public function getFlags(): ?array { @@ -119,8 +121,9 @@ } /** + * Retrieves the creation timestamp of the current instance. * - * @return int Returns the created timestamp as an integer. + * @return int The creation timestamp as an integer. */ public function getCreated(): int { @@ -139,8 +142,9 @@ } /** + * Converts the current instance into an associative array. * - * @return array An associative array representation of the object's properties, including 'uuid', 'identified_as', 'authenticated', 'flags', and 'created'. + * @return array An associative array representation of the instance, including UUID, identification, authentication status, flags, and creation date. */ public function toArray(): array {