Get string/boolean/integer property fallback

[ravage84]

Type: feature
Issue: Resolves none
Breaking change: no

Refers to #747 (comment)

I did not use the new fall back values it in any call ,yet.

Self critique::
Theoretically, this could lead to two cases of unclean code:

1. It copies or changes the default value set in the rule set XML.
2. It allows to use properties that do not exist in the rule set XML.

[kylekatarnls]

• Test are fine for me.
• I see some possible improvements in the code and PHPDoc (see comments)
• The getBooleanProperty should not return null (it's unclear when expecting a boolean) and the doc should enforce all $default type to be aligned to the @return of the method

[MarkVaughn]

Here's my suggestion for shared code

  
    /**
     * Returns the value of a configured property
     *
     * Throws an exception when no property with <b>$name</b> exists
     * and no default value to fallback was given.
     *
     * @param string $name The name of the property, e.g. "ignore-whitespace".
     * @param mixed $default An optional default value to fallback instead of throwing an exception.
     * @return mixed The value of a configured property.
     * @throws \OutOfBoundsException When no property for <b>$name</b> exists and
     * no default value to fallback was given.
     */
    protected function getProperty($name, $default = null)
    {
        if (isset($this->properties[$name])) {
            return $this->properties[$name];
        }
        if ($default !== null) {
            return $default;
        }

        throw new \OutOfBoundsException('Property "' . $name . '" does not exist.');
    }
    
    /**
     * Returns the value of a configured property as a boolean
     *
     * Throws an exception when no property with <b>$name</b> exists
     * and no default value to fallback was given.
     *
     * @param string $name The name of the property, e.g. "ignore-whitespace".
     * @param bool $default An optional default value to fallback instead of throwing an exception.
     * @return bool The value of a configured property as a boolean.
     * @throws \OutOfBoundsException When no property for <b>$name</b> exists and
     * no default value to fallback was given.
     */
    public function getBooleanProperty($name, $default = null)
    {
        return in_array($this->getProperty($name, $default), array('true', 'on', 1, true), false);
    }

    /**
     * Returns the value of a configured property as an integer
     *
     * Throws an exception when no property with <b>$name</b> exists
     * and no default value to fallback was given.
     *
     * @param string $name The name of the property, e.g. "minimum".
     * @param int $default An optional default value to fallback instead of throwing an exception.
     * @return int The value of a configured property as an integer.
     * @throws \OutOfBoundsException When no property for <b>$name</b> exists and
     * no default value to fallback was given.
     */
    public function getIntProperty($name, $default = null)
    {
        return (int) $this->getProperty($name, $default);
    }ƒ

    /**
     * Returns the raw string value of a configured property
     *
     * Throws an exception when no property with <b>$name</b> exists
     * and no default value to fallback was given.
     *
     * @param string $name The name of the property, e.g. "exceptions".
     * @param string|null $default An optional default value to fallback instead of throwing an exception.
     * @return string The raw string value of a configured property.
     * @throws \OutOfBoundsException When no property for <b>$name</b> exists and
     * no default value to fallback was given.
     */
    public function getStringProperty($name, $default = null)
    {
        return (string) $this->getProperty($name, $default);
    }

Also fallback has no space

[ravage84]

Also fallback has no space

@MarkVaughn "fall back" in the sense of "to fall back [to]", not a fallback.

https://dictionary.cambridge.org/de/worterbuch/englisch/fall-back
https://dictionary.cambridge.org/de/worterbuch/englisch/fallback

[ravage84]

Here's my suggestion for shared code

I'm fine with your suggestion, though I would prefer to leave the third in_array() parameter as in my PR.
And if you guys insist to change it, please do that in a separate commit so the visibility of the change is higher (e.g. if somebody tracks the change through the git history).

[MarkVaughn]

sorry for the misclicks :/

[MarkVaughn]

Not sure what

[Composer\Downloader\TransportException]  
  Peer fingerprint did not match      

has to do with this code.

[ravage84]

has to do with this code.

@MarkVaughn nothing. It's an issue of Travis. I'll restart the job.