SFObjectResult

class SFObjectResult

Class SFObjectResult

Properties

protected Result $_res

Methods

public __construct(Result $res) SFObject constructor.
public static SFObjectResult ok(SFObject|null $value) No description
public static SFObjectResult err(Exception $err) No description
public bool isOk() No description
public bool isError() No description
public SFObject|null value() No description
public Exception getErr() No description
public mixed valueOr($fallback) No description

Details

at line 23

__construct()

public __construct(Result $res)

SFObject constructor.

Parameters

Result $res
at line 32

ok()

public static SFObjectResult ok(SFObject|null $value)

Parameters

SFObject|null $value

Return Value

SFObjectResult

See also

Result::ok()
at line 41

err()

public static SFObjectResult err(Exception $err)

Parameters

Exception $err

Return Value

SFObjectResult

See also

Result::err()
at line 49

isOk()

public bool isOk()

Return Value

bool

See also

Result::isOK()
at line 57

isError()

public bool isError()

Return Value

bool

See also

Result::isError()
at line 66

value()

public SFObject|null value()

Return Value

SFObject|null

Exceptions

Exception

See also

Result::value()
at line 74

getErr()

public Exception getErr()

Return Value

Exception

See also

Result::getErr()
at line 83

valueOr()

public mixed valueOr($fallback)

Parameters

$fallback

Return Value

mixed

See also

Result::valueOr()

Source code

<?php
  
namespace SFClient\Result;

use SFClient\Result\Result;
use SFClient\SalesForce\SFObject;

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

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

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

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

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

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

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

  /**
   * @return SFObject|null
   * @throws \Exception
   * @see Result::value()
   */
  public function value(): ?SFObject {
      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);
  }
}