smtech\StMarksSearch\RequireParameter

Complexity

Total Complexity

9

Size/Duplication

Total Lines	63
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
B	requireParameter()	0	15	5
A	forceBooleanParameter()	0	4	2
A	defaultParameter()	0	8	2

<?php

namespace smtech\StMarksSearch;

use Exception;

/**
 * Require parameters
 *
 * @author Seth Battis <SethBattis@stmarksschool.org>
 */
trait RequireParameter
{
    /**
     * Require that a specific parameter key exists (and optionally has a
     * particular class as one of its parents)
     *
     * @param mixed[string] $params

The doc-type mixed[string] could not be parsed: Expected "]" at position 2, but found "string". (view supported doc-types)

     * @param string $key
     * @param string|false $class (Optional, defaults to `FALSE`) name of class
     *                            to require as a parent
     * @return void
     * @throws Exception If the required parameter is not set (or does not
     *         have the correct parent class, if `$class` is specified)
     */
    protected function requireParameter($params, $key, $class = false)
    {
        if (!isset($params[$key])) {
            throw new Exception("`$key` param required");
        }

        if ($class !== false && is_string($class)) {
            if (!is_a($params[$key], $class)) {
                throw new Exception(
                    "`$key` must be an instance of `$class`, instance of " .
                    get_class($params[$key]) . ' passed instead'
                );
            }
        }
    }


    /**
     * Force a boolean result from a particular parameter key
     *
     * @param mixed[string] $params

The doc-type mixed[string] could not be parsed: Expected "]" at position 2, but found "string". (view supported doc-types)

     * @param string $key    [description]
     * @return boolean `TRUE` iff `$params[$key]` exists and has a true value
     *                        (`1`, `'yes'`, `'true'`, `true`, etc.), `FALSE`
     *                        otherwise.
     */
    protected function forceBooleanParameter($params, $key)
    {
        return isset($params[$key]) && filter_var($params[$key], FILTER_VALIDATE_BOOLEAN);
    }

    /**
     * Set a parameter to a default value if it is not set
     *
     * @param mixed[string] $params

The doc-type mixed[string] could not be parsed: Expected "]" at position 2, but found "string". (view supported doc-types)

     * @param string $key
     * @param mixed $value
     * @param string|false $class
     * @return void
     */
    protected function defaultParameter(&$params, $key, $value, $class = false)
    {
        try {
            $this->requireParameter($params, $key, $class);
        } catch (Exception $e) {
            $params[$key] = $value;
        }
    }
}