Skip to content

Commit

Permalink
More type safety
Browse files Browse the repository at this point in the history
Signed-off-by: Carl Schwan <carl@carlschwan.eu>
  • Loading branch information
CarlSchwan committed Oct 17, 2022
1 parent 3790ff8 commit 9319bbb
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 25 deletions.
4 changes: 2 additions & 2 deletions apps/files_external/lib/Lib/Auth/AuthMechanism.php
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
use OCA\Files_External\Lib\StorageModifierTrait;
use OCA\Files_External\Lib\VisibilityTrait;
use OCA\Files_External\Lib\IIdentifier;
use OCA\Files_External\Lib\IFrontendDefintion;
use OCA\Files_External\Lib\IFrontendDefinition;

/**
* Authentication mechanism
Expand All @@ -52,7 +52,7 @@
* - StorageModifierTrait
* Object can affect storage mounting
*/
class AuthMechanism implements \JsonSerializable, IIdentifier, IFrontendDefintion {
class AuthMechanism implements \JsonSerializable, IIdentifier, IFrontendDefinition {
/** Standard authentication schemes */
public const SCHEME_NULL = 'null';
public const SCHEME_BUILTIN = 'builtin';
Expand Down
14 changes: 5 additions & 9 deletions apps/files_external/lib/Lib/Backend/Backend.php
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
use OCA\Files_External\Lib\StorageModifierTrait;
use OCA\Files_External\Lib\VisibilityTrait;
use OCA\Files_External\Lib\IIdentifier;
use OCA\Files_External\Lib\IFrontendDefintion;
use OCA\Files_External\Lib\IFrontendDefinition;

/**
* Storage backend
Expand All @@ -57,7 +57,7 @@
* - StorageModifierTrait
* Object can affect storage mounting
*/
class Backend implements \JsonSerializable, IIdentifier, IFrontendDefintion {
class Backend implements \JsonSerializable, IIdentifier, IFrontendDefinition {
use VisibilityTrait;
use FrontendDefinitionTrait;
use PriorityTrait;
Expand Down Expand Up @@ -120,21 +120,17 @@ public function getLegacyAuthMechanism(array $parameters = []) {
return $this->legacyAuthMechanism;
}

/**
* @param AuthMechanism $authMechanism
* @return self
*/
public function setLegacyAuthMechanism(AuthMechanism $authMechanism) {
public function setLegacyAuthMechanism(AuthMechanism $authMechanism): self {
$this->legacyAuthMechanism = $authMechanism;
return $this;
}

/**
* @param callable $callback dynamic auth mechanism selection
* @return self
*/
public function setLegacyAuthMechanismCallback(callable $callback) {
public function setLegacyAuthMechanismCallback(callable $callback): self {
$this->legacyAuthMechanism = $callback;
return $this;
}

/**
Expand Down
6 changes: 3 additions & 3 deletions apps/files_external/lib/Lib/FrontendDefinitionTrait.php
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ trait FrontendDefinitionTrait {
/** @var string human-readable mechanism name */
private string $text = "";

/** @var DefinitionParameter[] parameters for mechanism */
/** @var array<string, DefinitionParameter> parameters for mechanism */
private array $parameters = [];

/** @var string[] custom JS */
Expand All @@ -51,14 +51,14 @@ public static function lexicalCompare(IFrontendDefinition $a, IFrontendDefinitio
}

/**
* @return DefinitionParameter[]
* @return array<string, DefinitionParameter>
*/
public function getParameters(): array {
return $this->parameters;
}

/**
* @param DefinitionParameter[] $parameters
* @param list<DefinitionParameter> $parameters
*/
public function addParameters(array $parameters): self {
foreach ($parameters as $parameter) {
Expand Down
6 changes: 3 additions & 3 deletions apps/files_external/lib/Lib/IFrontendDefinition.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,19 @@
*/
namespace OCA\Files_External\Lib;

interface IFrontendDefintion {
interface IFrontendDefinition {

public function getText(): string;

public function setText(string $text): self;

/**
* @return list<DefinitionParameter>
* @return array<string, DefinitionParameter>
*/
public function getParameters(): array;

/**
* @param DefinitionParameter[] $parameters
* @param list<DefinitionParameter> $parameters
*/
public function addParameters(array $parameters): self;

Expand Down
10 changes: 2 additions & 8 deletions apps/files_external/lib/Lib/MissingDependency.php
Original file line number Diff line number Diff line change
Expand Up @@ -39,17 +39,11 @@ public function __construct($dependency) {
$this->dependency = $dependency;
}

/**
* @return string
*/
public function getDependency() {
public function getDependency(): string {
return $this->dependency;
}

/**
* @return string|null
*/
public function getMessage() {
public function getMessage(): ?string {
return $this->message;
}

Expand Down

0 comments on commit 9319bbb

Please sign in to comment.