Phalcon\Html\Link\EvolvableLink

Complexity

Total Complexity

5

Size/Duplication

Total Lines	107
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	withoutAttribute()	0	7	1
A	withAttribute()	0	7	1
A	withoutRel()	0	7	1
A	withHref()	0	8	1
A	withRel()	0	7	1

<?php

/**
 * This file is part of the Phalcon Framework.
 *
 * For the full copyright and license information, please view the LICENSE.md
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Phalcon\Html\Link;

use Psr\Link\EvolvableLinkInterface;

/**
 * Class Link
 *
 * @package Phalcon\Link
 *
 * @property array  $attributes
 * @property string $href
 * @property array  $rels
 * @property bool   $templated
 */
class EvolvableLink extends Link implements EvolvableLinkInterface
{
    /**
     * Returns an instance with the specified attribute added.
     *
     * If the specified attribute is already present, it will be overwritten
     * with the new value.
     *
     * @param string $attribute The attribute to include.
     * @param string $value     The value of the attribute to set.
     *
     * @return static
     */
    public function withAttribute($attribute, $value)
    {
        $newInstance = clone $this;

        $newInstance->attributes[$attribute] = $value;

        return $newInstance;
    }

    /**
     * Returns an instance with the specified href.
     *
     * @param string $href
     *       The href value to include.  It must be one of:
     *       - An absolute URI, as defined by RFC 5988.
     *       - A relative URI, as defined by RFC 5988. The base of the relative
     *       link is assumed to be known based on context by the client.
     *       - A URI template as defined by RFC 6570.
     *       - An object implementing __toString() that produces one of the
     *       above values.
     *
     * An implementing library SHOULD evaluate a passed object to a string
     * immediately rather than waiting for it to be returned later.
     *
     * @return static
     */
    public function withHref($href)
    {
        $newInstance = clone $this;

        $newInstance->href      = $href;
        $newInstance->templated = $this->hrefIsTemplated($href);

        return $newInstance;
    }

    /**
     * Returns an instance with the specified relationship included.
     *
     * If the specified rel is already present, this method MUST return
     * normally without errors, but without adding the rel a second time.
     *
     * @param string $rel
     *   The relationship value to add.
     *
     * @return static
     */
    public function withRel($rel)
    {
        $newInstance = clone $this;

        $newInstance->rels[$rel] = true;

        return $newInstance;
    }

    /**
     * Returns an instance with the specified attribute excluded.
     *
     * If the specified attribute is not present, this method MUST return
     * normally without errors.
     *
     * @param string $attribute
     *   The attribute to remove.
     *
     * @return static
     */
    public function withoutAttribute($attribute)
    {
        $newInstance = clone $this;

        unset($newInstance->attributes[$attribute]);

        return $newInstance;
    }

    /**
     * Returns an instance with the specified relationship excluded.
     *
     * If the specified rel is already not present, this method MUST return
     * normally without errors.
     *
     * @param string $rel
     *   The relationship value to exclude.
     *
     * @return static
     */
    public function withoutRel($rel)
    {
        $newInstance = clone $this;

        unset($newInstance->rels[$rel]);

        return $newInstance;
    }
}