FormOptions.php

Go to the documentation of this file.

<?php
class FormOptions implements ArrayAccess {
    /* @{ */
    const AUTO = -1;
    const STRING = 0;
    const INT = 1;
    const FLOAT = 4;
    const BOOL = 2;
    const INTNULL = 3;
    const ARR = 5;
    /* @} */
 
    protected $options = [];
 
    # Setting up
 
    public function add( $name, $default, $type = self::AUTO ) {
        $option = [];
        $option['default'] = $default;
        $option['value'] = null;
        $option['consumed'] = false;
 
        if ( $type !== self::AUTO ) {
            $option['type'] = $type;
        } else {
            $option['type'] = self::guessType( $default );
        }
 
        $this->options[$name] = $option;
    }
 
    public function delete( $name ) {
        $this->validateName( $name, true );
        unset( $this->options[$name] );
    }
 
    public static function guessType( $data ) {
        if ( is_bool( $data ) ) {
            return self::BOOL;
        } elseif ( is_int( $data ) ) {
            return self::INT;
        } elseif ( is_float( $data ) ) {
            return self::FLOAT;
        } elseif ( is_string( $data ) ) {
            return self::STRING;
        } elseif ( is_array( $data ) ) {
            return self::ARR;
        } else {
            throw new MWException( 'Unsupported datatype' );
        }
    }
 
    # Handling values
 
    public function validateName( $name, $strict = false ) {
        if ( !isset( $this->options[$name] ) ) {
            if ( $strict ) {
                throw new MWException( "Invalid option $name" );
            } else {
                return false;
            }
        }
 
        return true;
    }
 
    public function setValue( $name, $value, $force = false ) {
        $this->validateName( $name, true );
 
        if ( !$force && $value === $this->options[$name]['default'] ) {
            // null default values as unchanged
            $this->options[$name]['value'] = null;
        } else {
            $this->options[$name]['value'] = $value;
        }
    }
 
    public function getValue( $name ) {
        $this->validateName( $name, true );
 
        return $this->getValueReal( $this->options[$name] );
    }
 
    protected function getValueReal( $option ) {
        if ( $option['value'] !== null ) {
            return $option['value'];
        } else {
            return $option['default'];
        }
    }
 
    public function reset( $name ) {
        $this->validateName( $name, true );
        $this->options[$name]['value'] = null;
    }
 
    public function consumeValue( $name ) {
        $this->validateName( $name, true );
        $this->options[$name]['consumed'] = true;
 
        return $this->getValueReal( $this->options[$name] );
    }
 
    public function consumeValues( $names ) {
        $out = [];
 
        foreach ( $names as $name ) {
            $this->validateName( $name, true );
            $this->options[$name]['consumed'] = true;
            $out[] = $this->getValueReal( $this->options[$name] );
        }
 
        return $out;
    }
 
    public function validateIntBounds( $name, $min, $max ) {
        $this->validateBounds( $name, $min, $max );
    }
 
    public function validateBounds( $name, $min, $max ) {
        $this->validateName( $name, true );
        $type = $this->options[$name]['type'];
 
        if ( $type !== self::INT && $type !== self::FLOAT ) {
            throw new MWException( "Option $name is not of type INT or FLOAT" );
        }
 
        $value = $this->getValueReal( $this->options[$name] );
        $value = max( $min, min( $max, $value ) );
 
        $this->setValue( $name, $value );
    }
 
    public function getUnconsumedValues( $all = false ) {
        $values = [];
 
        foreach ( $this->options as $name => $data ) {
            if ( !$data['consumed'] ) {
                if ( $all || $data['value'] !== null ) {
                    $values[$name] = $this->getValueReal( $data );
                }
            }
        }
 
        return $values;
    }
 
    public function getChangedValues() {
        $values = [];
 
        foreach ( $this->options as $name => $data ) {
            if ( $data['value'] !== null ) {
                $values[$name] = $data['value'];
            }
        }
 
        return $values;
    }
 
    public function getAllValues() {
        $values = [];
 
        foreach ( $this->options as $name => $data ) {
            $values[$name] = $this->getValueReal( $data );
        }
 
        return $values;
    }
 
    # Reading values
 
    public function fetchValuesFromRequest( WebRequest $r, $optionKeys = null ) {
        if ( !$optionKeys ) {
            $optionKeys = array_keys( $this->options );
        }
 
        foreach ( $optionKeys as $name ) {
            $default = $this->options[$name]['default'];
            $type = $this->options[$name]['type'];
 
            switch ( $type ) {
                case self::BOOL:
                    $value = $r->getBool( $name, $default );
                    break;
                case self::INT:
                    $value = $r->getInt( $name, $default );
                    break;
                case self::FLOAT:
                    $value = $r->getFloat( $name, $default );
                    break;
                case self::STRING:
                    $value = $r->getText( $name, $default );
                    break;
                case self::INTNULL:
                    $value = $r->getIntOrNull( $name );
                    break;
                case self::ARR:
                    $value = $r->getArray( $name );
                    break;
                default:
                    throw new MWException( 'Unsupported datatype' );
            }
 
            if ( $value !== null ) {
                $this->options[$name]['value'] = $value === $default ? null : $value;
            }
        }
    }
 
    /* @{ */
    public function offsetExists( $name ) {
        return isset( $this->options[$name] );
    }
 
    public function offsetGet( $name ) {
        return $this->getValue( $name );
    }
 
    public function offsetSet( $name, $value ) {
        $this->setValue( $name, $value );
    }
 
    public function offsetUnset( $name ) {
        $this->delete( $name );
    }
    /* @} */
}