nextcloud/lib/private/Accounts/AccountProperty.php

181 lines
4.0 KiB
PHP

<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2018 Julius Härtl <jus@bitgrid.net>
*
* @author Julius Härtl <jus@bitgrid.net>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OC\Accounts;
use OCP\Accounts\IAccountManager;
use OCP\Accounts\IAccountProperty;
class AccountProperty implements IAccountProperty {
/** @var string */
private $name;
/** @var string */
private $value;
/** @var string */
private $scope;
/** @var string */
private $verified;
/** @var string */
private $verificationData;
public function __construct(string $name, string $value, string $scope, string $verified, string $verificationData) {
$this->name = $name;
$this->value = $value;
$this->setScope($scope);
$this->verified = $verified;
$this->verificationData = $verificationData;
}
public function jsonSerialize() {
return [
'name' => $this->getName(),
'value' => $this->getValue(),
'scope' => $this->getScope(),
'verified' => $this->getVerified(),
'verificationData' => $this->getVerificationData(),
];
}
/**
* Set the value of a property
*
* @since 15.0.0
*
* @param string $value
* @return IAccountProperty
*/
public function setValue(string $value): IAccountProperty {
$this->value = $value;
return $this;
}
/**
* Set the scope of a property
*
* @since 15.0.0
*
* @param string $scope
* @return IAccountProperty
*/
public function setScope(string $scope): IAccountProperty {
$newScope = $this->mapScopeToV2($scope);
if (!in_array($newScope, [
IAccountManager::SCOPE_LOCAL,
IAccountManager::SCOPE_FEDERATED,
IAccountManager::SCOPE_PRIVATE,
IAccountManager::SCOPE_PUBLISHED
])) {
throw new \InvalidArgumentException('Invalid scope');
}
$this->scope = $newScope;
return $this;
}
/**
* Set the verification status of a property
*
* @since 15.0.0
*
* @param string $verified
* @return IAccountProperty
*/
public function setVerified(string $verified): IAccountProperty {
$this->verified = $verified;
return $this;
}
/**
* Get the name of a property
*
* @since 15.0.0
*
* @return string
*/
public function getName(): string {
return $this->name;
}
/**
* Get the value of a property
*
* @since 15.0.0
*
* @return string
*/
public function getValue(): string {
return $this->value;
}
/**
* Get the scope of a property
*
* @since 15.0.0
*
* @return string
*/
public function getScope(): string {
return $this->scope;
}
public static function mapScopeToV2(string $scope): string {
if (strpos($scope, 'v2-') === 0) {
return $scope;
}
switch ($scope) {
case IAccountManager::VISIBILITY_PRIVATE:
return IAccountManager::SCOPE_LOCAL;
case IAccountManager::VISIBILITY_CONTACTS_ONLY:
return IAccountManager::SCOPE_FEDERATED;
case IAccountManager::VISIBILITY_PUBLIC:
return IAccountManager::SCOPE_PUBLISHED;
default:
return $scope;
}
}
/**
* Get the verification status of a property
*
* @since 15.0.0
*
* @return string
*/
public function getVerified(): string {
return $this->verified;
}
public function setVerificationData(string $verificationData): IAccountProperty {
$this->verificationData = $verificationData;
return $this;
}
public function getVerificationData(): string {
return $this->verificationData;
}
}