Neurony\Url\Options\UrlOptions

Complexity

Total Complexity

10

Size/Duplication

Total Lines	182
Duplicated Lines	5.49 %

Coupling/Cohesion

Components	7
Dependencies	0

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__get()	10	10	2
A	instance()	0	4	1
A	routeUrlTo()	0	7	1
A	generateUrlSlugFrom()	0	6	1
A	saveUrlSlugTo()	0	6	1
A	prefixUrlWith()	0	6	1
A	suffixUrlWith()	0	6	1
A	glueUrlWith()	0	6	1
A	doNotUpdateCascading()	0	6	1

<?php

namespace Neurony\Url\Options;

use Exception;

class UrlOptions
{
    /**
     * The controller where the laravel router should dispatch the request.
     * This is used when a URI is accessed by a user.
     * The format of this property should be Full\Namespace\Of\Controller.
     *
     * @var string
     */
    private $routeController;

    /**
     * The controller where the laravel router should dispatch the request.
     * This is used when a URI is accessed by a user.
     * The format of this property should be simply the name of the method residing inside the $routeController.
     *
     * @var string
     */
    private $routeAction;

    /**
     * The field used to generate the url slug from.
     *
     * @var string|array|callable
     */
    private $fromField;

    /**
     * The field where to store the generated url slug.
     *
     * @var string
     */
    private $toField;

    /**
     * The prefix that should be prepended to the generated url slug.
     *
     * @var string|array|callable
     */
    private $urlPrefix;

    /**
     * The suffix that should be appended to the generated url slug.
     *
     * @var string|array|callable
     */
    private $urlSuffix;

    /**
     * The symbol that will be used to glue url segments together.
     *
     * @var string
     */
    private $urlGlue = '/';

    /**
     * Flag whether to update children urls on parent url save.
     *
     * @var bool
     */
    private $cascadeUpdate = true;

    /**
     * Get the value of a property of this class.
     *
     * @param $name
     * @return mixed
     * @throws Exception
     */
    public function __get($name)

This method seems to be duplicated in your project.

    {
        if (property_exists(static::class, $name)) {
            return $this->{$name};
        }

        throw new Exception(
            'The property "'.$name.'" does not exist in class "'.static::class.'"'
        );
    }

    /**
     * Get a fresh instance of this class.
     *
     * @return UrlOptions
     */
    public static function instance(): self
    {
        return new static();
    }

    /**
     * Set the $urlRoute to work with in the Neurony\Url\Traits\HasUrl trait.
     *
     * @param string $controller
     * @param string $action
     * @return UrlOptions
     */
    public function routeUrlTo(string $controller, string $action): self
    {
        $this->routeController = $controller;
        $this->routeAction = $action;

        return $this;
    }

    /**
     * Set the $fromField to work with in the Neurony\Url\Traits\HasUrl trait.
     *
     * @param string|array|callable $field
     * @return UrlOptions
     */
    public function generateUrlSlugFrom($field): self
    {
        $this->fromField = $field;

        return $this;
    }

    /**
     * Set the $toField to work with in the Neurony\Url\Traits\HasUrl trait.
     *
     * @param string $field
     * @return UrlOptions
     */
    public function saveUrlSlugTo(string $field): self
    {
        $this->toField = $field;

        return $this;
    }

    /**
     * Set the $urlPrefix to work with in the Neurony\Url\Traits\HasUrl trait.
     *
     * @param string|array|callable $prefix
     * @return UrlOptions
     */
    public function prefixUrlWith($prefix): self
    {
        $this->urlPrefix = $prefix;

        return $this;
    }

    /**
     * Set the $urlSuffix to work with in the Neurony\Url\Traits\HasUrl trait.
     *
     * @param string|array|callable $suffix
     * @return UrlOptions
     */
    public function suffixUrlWith($suffix): self
    {
        $this->urlSuffix = $suffix;

        return $this;
    }

    /**
     * Set the $urlGlue to work with in the Neurony\Url\Traits\HasUrl trait.
     *
     * @param string $glue
     * @return UrlOptions
     */
    public function glueUrlWith(string $glue): self
    {
        $this->urlGlue = $glue;

        return $this;
    }

    /**
     * Set the $cascadeUpdate to work with in the Neurony\Url\Traits\HasUrl trait.
     *
     * @return UrlOptions
     */
    public function doNotUpdateCascading(): self
    {
        $this->cascadeUpdate = false;

        return $this;
    }
}