Nosial/socialbox-php
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Refactored Peer Information to use InformationFields rather than being hard-coded into the peer record

Browse source
This commit is contained in:
netkas 2025-01-24 15:10:20 -05:00
parent 75de51c910
commit f689e36378
45 changed files with 1422 additions and 1337 deletions
Download patch file Download diff file Expand all files Collapse all files

331
src/Socialbox/Objects/Database/RegisteredPeerRecord.php
View file

@ -1,331 +0,0 @@
<?php
namespace Socialbox\Objects\Database;
use DateTime;
use InvalidArgumentException;
use Socialbox\Classes\Configuration;
use Socialbox\Enums\Flags\PeerFlags;
use Socialbox\Interfaces\SerializableInterface;
use Socialbox\Objects\Standard\Peer;
use Socialbox\Objects\Standard\SelfUser;
class RegisteredPeerRecord implements SerializableInterface
{
private string $uuid;
private string $username;
private string $server;
private ?string $displayName;
private ?string $displayPicture;
private ?string $emailAddress;
private ?string $phoneNumber;
private ?DateTime $birthday;
/**
* @var PeerFlags[]
*/
private ?array $flags;
private bool $enabled;
private DateTime $created;
private DateTime $updated;
/**
* Constructor for initializing class properties from provided data.
*
* @param array $data Array containing initialization data.
*/
public function __construct(array $data)
{
$this->uuid = $data['uuid'];
$this->username = $data['username'];
$this->server = $data['server'];
$this->displayName = $data['display_name'] ?? null;
$this->displayPicture = $data['display_picture'] ?? null;
$this->emailAddress = $data['email_address'] ?? null;
$this->phoneNumber = $data['phone_number'] ?? null;
if(!isset($data['birthday']))
{
$this->birthday = null;
}
elseif(is_int($data['birthday']))
{
$this->birthday = (new DateTime())->setTimestamp($data['birthday']);
}
elseif(is_string($data['birthday']))
{
$this->birthday = new DateTime($data['birthday']);
}
elseif($data['birthday'] instanceof DateTime)
{
$this->birthday = $data['birthday'];
}
else
{
throw new InvalidArgumentException("The birthday field must be a valid timestamp or date string.");
}
if($data['flags'])
{
$this->flags = PeerFlags::fromString($data['flags']);
}
else
{
$this->flags = [];
}
$this->enabled = $data['enabled'];
if(!isset($data['created']))
{
$this->created = new DateTime();
}
elseif(is_int($data['created']))
{
$this->created = (new DateTime())->setTimestamp($data['created']);
}
elseif(is_string($data['created']))
{
$this->created = new DateTime($data['created']);
}
else
{
throw new InvalidArgumentException("The created field must be a valid timestamp or date string.");
}
if(!isset($data['updated']))
{
$this->updated = new DateTime();
}
elseif(is_int($data['updated']))
{
$this->updated = (new DateTime())->setTimestamp($data['updated']);
}
elseif(is_string($data['updated']))
{
$this->updated = new DateTime($data['updated']);
}
else
{
throw new InvalidArgumentException("The updated field must be a valid timestamp or date string.");
}
}
/**
* Retrieves the UUID of the current instance.
*
* @return string The UUID.
*/
public function getUuid(): string
{
return $this->uuid;
}
/**
* Retrieves the username.
*
* @return string The username.
*/
public function getUsername(): string
{
return $this->username;
}
/**
* Retrieves the server.
*
* @return string The server.
*/
public function getServer(): string
{
return $this->server;
}
/**
* Constructs and retrieves the peer address using the current instance's username and the domain from the configuration.
*
* @return string The constructed peer address.
*/
public function getAddress(): string
{
return sprintf("%s@%s", $this->username, Configuration::getInstanceConfiguration()->getDomain());
}
/**
* Retrieves the display name.
*
* @return string|null The display name if set, or null otherwise.
*/
public function getDisplayName(): ?string
{
return $this->displayName;
}
/**
* Retrieves the display picture.
*
* @return string|null The display picture if set, or null otherwise.
*/
public function getDisplayPicture(): ?string
{
return $this->displayPicture;
}
/**
* Retrieves the email address.
*
* @return string|null The email address if set, or null otherwise.
*/
public function getEmailAddress(): ?string
{
return $this->emailAddress;
}
/**
* Retrieves the phone number.
*
* @return string|null The phone number if set, or null otherwise.
*/
public function getPhoneNumber(): ?string
{
return $this->phoneNumber;
}
/**
* Retrieves the birthday.
*
* @return DateTime|null The birthday if set, or null otherwise.
*/
public function getBirthday(): ?DateTime
{
return $this->birthday;
}
/**
* Retrieves the flags.
*
* @return PeerFlags[] The flags.
*/
public function getFlags(): array
{
return $this->flags;
}
/**
* Adds a flag to the current instance.
*
* @param PeerFlags $flag The flag to add.
*/
public function flagExists(PeerFlags $flag): bool
{
return in_array($flag, $this->flags, true);
}
/**
* Adds a flag to the current instance.
*
* @param PeerFlags $flag The flag to add.
*/
public function removeFlag(PeerFlags $flag): void
{
$key = array_search($flag, $this->flags, true);
if($key !== false)
{
unset($this->flags[$key]);
}
}
/**
* Checks if the current instance is enabled.
*
* @return bool True if enabled, false otherwise.
*/
public function isEnabled(): bool
{
return $this->enabled;
}
/**
* Retrieves the creation date and time.
*
* @return DateTime The creation date and time.
*/
public function getCreated(): DateTime
{
return $this->created;
}
/**
* Retrieves the last update date and time.
*
* @return DateTime The last update date and time.
*/
public function getUpdated(): DateTime
{
return $this->updated;
}
/**
* Determines if the user is considered external by checking if the username is 'host' and the server
* is not the same as the domain from the configuration.
*
* @return bool True if the user is external, false otherwise.
*/
public function isExternal(): bool
{
return $this->username === 'host' && $this->server !== Configuration::getInstanceConfiguration()->getDomain();
}
/**
* Converts the current instance to a SelfUser object.
*
* @return SelfUser The SelfUser object.
*/
public function toSelfUser(): SelfUser
{
return new SelfUser($this);
}
/**
* Converts the current instance to a Peer object.
*
* @return Peer The Peer representation of the current instance.
*/
public function toStandardPeer(): Peer
{
return Peer::fromArray([
'address' => $this->getAddress(),
'display_name' => $this->displayName,
'flags' => array_map(fn(PeerFlags $flag) => $flag->value, $this->flags),
'registered' => $this->created->getTimestamp()
]);
}
/**
* @inheritDoc
*/
public static function fromArray(array $data): object
{
return new self($data);
}
/**
* @inheritDoc
*/
public function toArray(): array
{
return [
'uuid' => $this->uuid,
'username' => $this->username,
'server' => $this->server,
'display_name' => $this->displayName,
'display_picture' => $this->displayPicture,
'email_address' => $this->emailAddress,
'phone_number' => $this->phoneNumber,
'birthday' => $this->birthday?->getTimestamp(),
'flags' => PeerFlags::toString($this->flags),
'enabled' => $this->enabled,
'created' => $this->created,
'updated' => $this->updated
];
}
}