TokenResult

class TokenResult

Class TokenResult

Properties

protected Result $res

Methods

public static TokenResult ok(Token|null $value) No description
public static TokenResult err(Exception $err) No description
public bool isOk() No description
public bool isError() No description
public Token|null value() No description
public Exception|null getErr() No description
public Token|null|mixed valueOr(mixed $fallback) No description

Details

at line 30

ok()

public static TokenResult ok(Token|null $value)

Parameters

Token|null $value

Return Value

TokenResult
at line 38

err()

public static TokenResult err(Exception $err)

Parameters

Exception $err

Return Value

TokenResult
at line 45

isOk()

public bool isOk()

Return Value

bool
at line 52

isError()

public bool isError()

Return Value

bool
at line 60

value()

public Token|null value()

Return Value

Token|null

Exceptions

Exception
at line 67

getErr()

public Exception|null getErr()

Return Value

Exception|null
at line 75

valueOr()

public Token|null|mixed valueOr(mixed $fallback)

Parameters

mixed $fallback

Return Value

Token|null|mixed

Source code

<?php

namespace LibPBSAuth\Result;

use LibPBSAuth\Token;

/**
 * Class TokenResult
 * @package LibPBSAuth\Result
 */
class TokenResult {

  /**
   * @var Result
   */
  protected $res;

  /**
   * TokenResult constructor.
   * @param Result $res
   */
  private function __construct(Result $res) {
    $this->res = $res;
  }

  /**
   * @param Token|null $value
   * @return TokenResult
   */
  public static function ok(?Token $value): TokenResult {
    return new TokenResult(Result::ok($value));
  }

  /**
   * @param \Exception $err
   * @return TokenResult
   */
  public static function err(\Exception $err): TokenResult {
    return new TokenResult(Result::err($err));
  }

  /**
   * @return bool
   */
  public function isOk(): bool {
    return $this->res->isOk();
  }

  /**
   * @return bool
   */
  public function isError(): bool {
    return $this->res->isError();
  }

  /**
   * @return Token|null
   * @throws \Exception
   */
  public function value(): ?Token {
    return $this->res->value();
  }

  /**
   * @return \Exception|null
   */
  public function getErr() {
    return $this->res->getErr();
  }

  /**
   * @param mixed $fallback
   * @return Token|null|mixed
   */
  public function valueOr($fallback) {
    return $this->res->valueOr($fallback);
  }
}