StatusValue.php

Go to the documentation of this file.

<?php
class StatusValue {
    protected $ok = true;
    protected $errors = [];

    public $value;
    public $success = [];
    public $successCount = 0;
    public $failCount = 0;

    public static function newFatal( $message /*, parameters...*/ ) {
        $params = func_get_args();
        $result = new static();
        call_user_func_array( [ &$result, 'fatal' ], $params );
        return $result;
    }

    public static function newGood( $value = null ) {
        $result = new static();
        $result->value = $value;
        return $result;
    }

    public function splitByErrorType() {
        $errorsOnlyStatusValue = clone $this;
        $warningsOnlyStatusValue = clone $this;
        $warningsOnlyStatusValue->ok = true;

        $errorsOnlyStatusValue->errors = $warningsOnlyStatusValue->errors = [];
        foreach ( $this->errors as $item ) {
            if ( $item['type'] === 'warning' ) {
                $warningsOnlyStatusValue->errors[] = $item;
            } else {
                $errorsOnlyStatusValue->errors[] = $item;
            }
        };

        return [ $errorsOnlyStatusValue, $warningsOnlyStatusValue ];
    }

    public function isGood() {
        return $this->ok && !$this->errors;
    }

    public function isOK() {
        return $this->ok;
    }

    public function getValue() {
        return $this->value;
    }

    public function getErrors() {
        return $this->errors;
    }

    public function setOK( $ok ) {
        $this->ok = $ok;
    }

    public function setResult( $ok, $value = null ) {
        $this->ok = (bool)$ok;
        $this->value = $value;
    }

    public function warning( $message /*, parameters... */ ) {
        $this->errors[] = [
            'type' => 'warning',
            'message' => $message,
            'params' => array_slice( func_get_args(), 1 )
        ];
    }

    public function error( $message /*, parameters... */ ) {
        $this->errors[] = [
            'type' => 'error',
            'message' => $message,
            'params' => array_slice( func_get_args(), 1 )
        ];
    }

    public function fatal( $message /*, parameters... */ ) {
        $this->errors[] = [
            'type' => 'error',
            'message' => $message,
            'params' => array_slice( func_get_args(), 1 )
        ];
        $this->ok = false;
    }

    public function merge( $other, $overwriteValue = false ) {
        $this->errors = array_merge( $this->errors, $other->errors );
        $this->ok = $this->ok && $other->ok;
        if ( $overwriteValue ) {
            $this->value = $other->value;
        }
        $this->successCount += $other->successCount;
        $this->failCount += $other->failCount;
    }

    public function getErrorsByType( $type ) {
        $result = [];
        foreach ( $this->errors as $error ) {
            if ( $error['type'] === $type ) {
                $result[] = $error;
            }
        }

        return $result;
    }

    public function hasMessage( $message ) {
        if ( $message instanceof MessageSpecifier ) {
            $message = $message->getKey();
        }
        foreach ( $this->errors as $error ) {
            if ( $error['message'] instanceof MessageSpecifier
                && $error['message']->getKey() === $message
            ) {
                return true;
            } elseif ( $error['message'] === $message ) {
                return true;
            }
        }

        return false;
    }

    public function replaceMessage( $source, $dest ) {
        $replaced = false;

        foreach ( $this->errors as $index => $error ) {
            if ( $error['message'] === $source ) {
                $this->errors[$index]['message'] = $dest;
                $replaced = true;
            }
        }

        return $replaced;
    }

    public function __toString() {
        $status = $this->isOK() ? "OK" : "Error";
        if ( count( $this->errors ) ) {
            $errorcount = "collected " . ( count( $this->errors ) ) . " error(s) on the way";
        } else {
            $errorcount = "no errors detected";
        }
        if ( isset( $this->value ) ) {
            $valstr = gettype( $this->value ) . " value set";
            if ( is_object( $this->value ) ) {
                $valstr .= "\"" . get_class( $this->value ) . "\" instance";
            }
        } else {
            $valstr = "no value set";
        }
        $out = sprintf( "<%s, %s, %s>",
            $status,
            $errorcount,
            $valstr
        );
        if ( count( $this->errors ) > 0 ) {
            $hdr = sprintf( "+-%'-4s-+-%'-25s-+-%'-40s-+\n", "", "", "" );
            $i = 1;
            $out .= "\n";
            $out .= $hdr;
            foreach ( $this->errors as $error ) {
                if ( $error['message'] instanceof MessageSpecifier ) {
                    $key = $error['message']->getKey();
                    $params = $error['message']->getParams();
                } elseif ( $error['params'] ) {
                    $key = $error['message'];
                    $params = $error['params'];
                } else {
                    $key = $error['message'];
                    $params = [];
                }

                $out .= sprintf( "| %4d | %-25.25s | %-40.40s |\n",
                    $i,
                    $key,
                    implode( " ", $params )
                );
                $i += 1;
            }
            $out .= $hdr;
        }

        return $out;
    }
}