MVaultResult

class MVaultResult

Class MVaultResult

Properties

protected Result $res

Methods

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

Details

at line 30

ok()

public static MVaultResult ok(MVaultRecord $value)

Parameters

MVaultRecord $value

Return Value

MVaultResult
at line 38

err()

public static MVaultResult err(Exception $err)

Parameters

Exception $err

Return Value

MVaultResult
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 MVaultRecord value()

Return Value

MVaultRecord

Exceptions

Exception
at line 67

getErr()

public Exception|null getErr()

Return Value

Exception|null
at line 75

valueOr()

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

Parameters

mixed $fallback

Return Value

MVaultRecord|null|mixed

Source code

<?php

namespace LibMVault\Result;

use LibMVault\MVaultRecord;

/**
 * Class MVaultResult
 * @package LibMVault\Result
 */
class MVaultResult {

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

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

  /**
   * @param MVaultRecord $value
   * @return MVaultResult
   */
  public static function ok(MVaultRecord $value): MVaultResult {
    return new MVaultResult(Result::ok($value));
  }

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

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

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

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

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

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