Jaxon\Script\Factory\ParameterFactory

Complexity

Total Complexity

11

Size/Duplication

Total Lines	131
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	page()	0	4	1
A	checked()	0	3	1
A	int()	0	3	1
A	javascript()	0	3	1
A	string()	0	3	1
A	js()	0	3	1
A	select()	0	3	1
A	html()	0	3	1
A	input()	0	3	1
A	numeric()	0	3	1
A	form()	0	3	1

<?php

/**
 * ParameterFactory.php
 *
 * Create parameters for calls to js functions and selectors.
 *
 * @package jaxon-core
 * @author Thierry Feuzeu <thierry.feuzeu@gmail.com>
 * @copyright 2016 Thierry Feuzeu <thierry.feuzeu@gmail.com>
 * @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License
 * @link https://github.com/jaxon-php/jaxon-core
 */

namespace Jaxon\Script\Factory;

use Jaxon\Script\Call\Parameter;

class ParameterFactory
{
    /**
     * Make a parameter of type Parameter::FORM_VALUES
     *
     * @param string $sFormId    The id of the HTML form
     *
     * @return Parameter
     */
    public function form(string $sFormId): Parameter
    {
        return new Parameter(Parameter::FORM_VALUES, $sFormId);
    }

    /**
     * Make a parameter of type Parameter::INPUT_VALUE
     *
     * @param string $sInputId    the id of the HTML input element
     *
     * @return Parameter
     */
    public function input(string $sInputId): Parameter
    {
        return new Parameter(Parameter::INPUT_VALUE, $sInputId);
    }

    /**
     * Make a parameter of type Parameter::CHECKED_VALUE
     *
     * @param string $sInputId    the name of the HTML form element
     *
     * @return Parameter
     */
    public function checked(string $sInputId): Parameter
    {
        return new Parameter(Parameter::CHECKED_VALUE, $sInputId);
    }

    /**
     * Make a parameter of type Parameter::CHECKED_VALUE
     *
     * @param string $sInputId    the name of the HTML form element
     *
     * @return Parameter
     */
    public function select(string $sInputId): Parameter
    {
        return $this->input($sInputId);
    }

    /**
     * Make a parameter of type Parameter::ELEMENT_INNERHTML
     *
     * @param string $sElementId    the id of the HTML element
     *
     * @return Parameter
     */
    public function html(string $sElementId): Parameter
    {
        return new Parameter(Parameter::ELEMENT_INNERHTML, $sElementId);
    }

    /**
     * Make a parameter of type Parameter::QUOTED_VALUE
     *
     * @param string $sValue    the value of the parameter
     *
     * @return Parameter
     */
    public function string(string $sValue): Parameter
    {
        return new Parameter(Parameter::QUOTED_VALUE, $sValue);
    }

    /**
     * Make a parameter of type Parameter::NUMERIC_VALUE
     *
     * @param int $nValue    the value of the parameter
     *
     * @return Parameter
     */
    public function numeric(int $nValue): Parameter
    {
        return new Parameter(Parameter::NUMERIC_VALUE, intval($nValue));
    }

    /**
     * Make a parameter of type Parameter::NUMERIC_VALUE
     *
     * @param numeric $nValue    the value of the parameter

The type Jaxon\Script\Factory\numeric was not found. Maybe you did not declare it correctly or list all dependencies?

     *
     * @return Parameter
     */
    public function int(int $nValue): Parameter
    {
        return $this->numeric($nValue);
    }

    /**
     * Make a parameter of type Parameter::JS_VALUE
     *
     * @param string $sValue    the javascript code of the parameter
     *
     * @return Parameter
     */
    public function javascript(string $sValue): Parameter
    {
        return new Parameter(Parameter::JS_VALUE, $sValue);
    }

    /**
     * Make a parameter of type Parameter::JS_VALUE
     *
     * @param string $sValue    the javascript code of the parameter
     *
     * @return Parameter
     */
    public function js(string $sValue): Parameter
    {
        return $this->javascript($sValue);
    }

    /**
     * Make a parameter of type Parameter::PAGE_NUMBER
     *
     * @return Parameter
     */
    public function page(): Parameter
    {
        // By default, the value of a parameter of type Parameter::PAGE_NUMBER is 0.
        return new Parameter(Parameter::PAGE_NUMBER, 0);
    }
}