BoolResult

class BoolResult

Class BoolResult

Properties

protected Result $_res

Methods

public __construct(Result $res) Bool constructor.
public static BoolResult ok(bool $value) No description
public static BoolResult err(Exception $err) No description
public bool isOk() No description
public bool isError() No description
public bool value() No description
public Exception getErr() No description
public mixed valueOr($fallback) No description

Details

at line 22

__construct()

public __construct(Result $res)

Bool constructor.

Parameters

Result $res
at line 31

ok()

public static BoolResult ok(bool $value)

Parameters

bool $value

Return Value

BoolResult

See also

Result::ok()
at line 40

err()

public static BoolResult err(Exception $err)

Parameters

Exception $err

Return Value

BoolResult

See also

Result::err()
at line 48

isOk()

public bool isOk()

Return Value

bool

See also

Result::isOK()
at line 56

isError()

public bool isError()

Return Value

bool

See also

Result::Error()
at line 65

value()

public bool value()

Return Value

bool

Exceptions

Exception

See also

Result::value()
at line 73

getErr()

public Exception getErr()

Return Value

Exception

See also

Result::getErr()
at line 82

valueOr()

public mixed valueOr($fallback)

Parameters

$fallback

Return Value

mixed

See also

Result::valueOr()

Source code

<?php

namespace SFClient\Result;

use SFClient\Result\Result;

/**
 * Class BoolResult
 * @package SFClient\Result
 */
class BoolResult {

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

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

  /**
   * @param bool $value
   * @return BoolResult
   * @see Result::ok()
   */
  public static function ok(bool $value): BoolResult {
      return new BoolResult(Result::ok($value));
  }

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

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

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

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

  /**
   * @return \Exception
   * @see Result::getErr()
   */
  public function getErr(): \Exception {
      return $this->res->getErr();
  }

  /**
   * @param $fallback
   * @return mixed
   * @see Result::valueOr()
   */
  public function valueOr($fallback) {
      return $this->res->valueOr($fallback);
  }
}