Fwk\Core\Components\UrlRewriter\RouteParameter

Complexity

Total Complexity

10

Size/Duplication

Total Lines	89
Duplicated Lines	0 %

Coupling/Cohesion

Dependencies

0

Test Coverage

Coverage

90.91%

Importance

Changes	7
Bugs	3	Features	3

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	2
A	getName()	0	4	1
A	isRequired()	0	4	1
A	getRegex()	0	4	1
A	getDefault()	0	4	1
A	getValueOrDefault()	0	4	2
A	setValue()	0	4	1
A	getValue()	0	4	1

<?php
/**
 * Fwk
 *
 * Copyright (c) 2011-2014, Julien Ballestracci <julien@nitronet.org>.
 * All rights reserved.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * PHP Version 5.3
 * 
 * @category   Core
 * @package    Fwk\Core
 * @subpackage Components
 * @author     Julien Ballestracci <julien@nitronet.org>
 * @copyright  2011-2014 Julien Ballestracci <julien@nitronet.org>
 * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @link       http://www.fwk.pw
 */
namespace Fwk\Core\Components\UrlRewriter;

/**
 * Route Parameter
 * 
 * @category   Utilities
 * @package    Fwk\Core
 * @subpackage Components
 * @author     Julien Ballestracci <julien@nitronet.org>
 * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @link       http://www.phpfwk.com
 */
class RouteParameter
{
    const DEFAULT_REGEX = '.[^/\.]{0,}';
    
    /**
     *
     * @var string 
     */
    protected $name;

    /**
     *
     * @var boolean 
     */
    protected $required;

    /**
     *
     * @var string 
     */
    protected $regex;

    /**
     *
     * @var mixed 
     */
    protected $default;

    /**
     *
     * @var string 
     */
    protected $value;

    /**
     * 
     * @param type $name
     * @param type $default

Should the type for parameter $default not be type|null?

     * @param type $regex

Should the type for parameter $regex not be type|null?

     * @param type $required

Should the type for parameter $required not be boolean|type?

     * @param type $value

Should the type for parameter $value not be type|null?

     * 
     * @return void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
    public function __construct($name, $default = null, 
        $regex = null, $required = true, $value = null
    ) {
        $this->name     = (string)$name;
        $this->default  = $default;
        $this->required = (bool)$required;
        $this->regex    = (empty($regex) ? self::DEFAULT_REGEX : $regex);

It seems like empty($regex) ? self::DEFAULT_REGEX : $regex can also be of type object<Fwk\Core\Components\UrlRewriter\type>. However, the property $regex is declared as type string. Maybe add an additional type check?

        $this->value    = $value;

It seems like $value can also be of type object<Fwk\Core\Components\UrlRewriter\type>. However, the property $value is declared as type string. Maybe add an additional type check?

    }

    public function getName()
    {
        return $this->name;
    }

    public function isRequired()
    {
        return $this->required;
    }

    public function getRegex()
    {
        return $this->regex;
    }

    public function getDefault()
    {
        return $this->default;
    }

    public function getValueOrDefault()
    {
        return (!empty($this->value) ? $this->value : $this->default);
    }
    
    public function setValue($value)
    {
        $this->value = $value;
    }
    
    public function getValue()
    {
        return $this->value;
    }
}