NavbarSearchHelper::render() - Code Metrics - Inspection of "Add navbar search" - Jitamin/jitamin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#165)

by Phecho

created 2017-01-15 06:32 UTC

NavbarSearchHelper::render() B

↳ Parent: NavbarSearchHelper

Complexity

Conditions	3
Paths	3

Size

Total Lines	27
Code Lines	18

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	18
nc	3
nop	1
dl	0
loc	27
rs	8.8571
c	0
b	0
f	0

<?php

/*
 * This file is part of Jitamin.
 *
 * Copyright (C) Jitamin Team
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Jitamin\Helper;

use Jitamin\Foundation\Base;

/**
 * Navbar Search Helper.
 */
class NavbarSearchHelper extends Base
{
    /**
     * Get current query.
     *
     * @param array $project
     *
     * @return string
     */
    public function getSearchQuery(array $project)
    {
        $project_id = !empty($project) ? $project['id'] : 0;
        $query = $this->request->getStringParam('q', $this->userSession->getFilters($project_id));
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $this->userSession->setFilters($project_id, $query);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

        return urldecode($query);
    }

    /**
     * Render project header (views switcher and search box).
     *
     * @param array $project
     *
     * @return string
     */
    public function render(array $project)
    {
        if (empty($project)) {
            return;
        }
        $controller = $this->helper->app->getRouterController();
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $action = $this->helper->app->getRouterAction();
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

        if (!$this->canShowNavbarSearch($controller.'@'.$action)) {
            return;
        }

        $filters = [
            'controller' => $controller,
            'action'     => $action,
            'project_id' => $project['id'],
            'q'          => $this->getSearchQuery($project),
        ];

        return $this->template->render('_partials/navbar_search', [
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            'project'             => $project,
            'filters'             => $filters,
            'categories_list'     => $this->categoryModel->getList($project['id'], false),
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            'users_list'          => $this->projectUserRoleModel->getAssignableUsersList($project['id'], false),
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            'custom_filters_list' => $this->customFilterModel->getAll($project['id'], $this->userSession->getId()),
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        ]);
    }

    /**
     * Determin if shows header search bar.
     *
     * @param string $path
     *
     * @return bool
     */
    protected function canShowNavbarSearch($path = '')
    {
        $whiteList = ['Project/ProjectController@overview', 'Project/ProjectController@show', 'Project/Board/BoardController@show', 'CalendarController@show', 'Task/TaskController@index', 'Task/TaskController@gantt'];

        return in_array($path, $whiteList);
    }
}


1			<?php
2
3			/*
4			* This file is part of Jitamin.
5			*
6			* Copyright (C) Jitamin Team
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Jitamin\Helper;
13
14			use Jitamin\Foundation\Base;
15
16			/**
17			* Navbar Search Helper.
18			*/
19			class NavbarSearchHelper extends Base
20			{
21			/**
22			* Get current query.
23			*
24			* @param array $project
25			*
26			* @return string
27			*/
28			public function getSearchQuery(array $project)
29			{
30			$project_id = !empty($project) ? $project['id'] : 0;
31			$query = $this->request->getStringParam('q', $this->userSession->getFilters($project_id));
			0 ignored issues – show Documentation introduced 2017-01-15 06:36 UTC by Report Bug Copy Issue Report The property `request` does not exist on `object<Jitamin\Helper\NavbarSearchHelper>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text / class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history... Documentation introduced 2017-01-15 06:36 UTC by Report Bug Copy Issue Report The property `userSession` does not exist on `object<Jitamin\Helper\NavbarSearchHelper>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /* * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
32			$this->userSession->setFilters($project_id, $query);
			0 ignored issues – show Documentation introduced 2017-01-15 06:36 UTC by Report Bug Copy Issue Report The property `userSession` does not exist on `object<Jitamin\Helper\NavbarSearchHelper>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
33
34			return urldecode($query);
35			}
36
37			/**
38			* Render project header (views switcher and search box).
39			*
40			* @param array $project
41			*
42			* @return string
43			*/
44			public function render(array $project)
45			{
46			if (empty($project)) {
47			return;
48			}
49			$controller = $this->helper->app->getRouterController();
			0 ignored issues – show Documentation introduced 2017-01-15 06:36 UTC by Report Bug Copy Issue Report The property `helper` does not exist on `object<Jitamin\Helper\NavbarSearchHelper>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
50			$action = $this->helper->app->getRouterAction();
			0 ignored issues – show Documentation introduced 2017-01-15 06:36 UTC by Report Bug Copy Issue Report The property `helper` does not exist on `object<Jitamin\Helper\NavbarSearchHelper>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
51
52			if (!$this->canShowNavbarSearch($controller.'@'.$action)) {
53			return;
54			}
55
56			$filters = [
57			'controller' => $controller,
58			'action' => $action,
59			'project_id' => $project['id'],
60			'q' => $this->getSearchQuery($project),
61			];
62
63			return $this->template->render('_partials/navbar_search', [
			0 ignored issues – show Documentation introduced 2017-01-15 06:36 UTC by Report Bug Copy Issue Report The property `template` does not exist on `object<Jitamin\Helper\NavbarSearchHelper>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
64			'project' => $project,
65			'filters' => $filters,
66			'categories_list' => $this->categoryModel->getList($project['id'], false),
			0 ignored issues – show Documentation introduced 2017-01-15 06:36 UTC by Report Bug Copy Issue Report The property `categoryModel` does not exist on `object<Jitamin\Helper\NavbarSearchHelper>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
67			'users_list' => $this->projectUserRoleModel->getAssignableUsersList($project['id'], false),
			0 ignored issues – show Documentation introduced 2017-01-15 06:36 UTC by Report Bug Copy Issue Report The property `projectUserRoleModel` does not exist on `object<Jitamin\Helper\NavbarSearchHelper>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
68			'custom_filters_list' => $this->customFilterModel->getAll($project['id'], $this->userSession->getId()),
			0 ignored issues – show Documentation introduced 2017-01-15 06:36 UTC by Report Bug Copy Issue Report The property `customFilterModel` does not exist on `object<Jitamin\Helper\NavbarSearchHelper>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text / class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history... Documentation introduced 2017-01-15 06:36 UTC by Report Bug Copy Issue Report The property `userSession` does not exist on `object<Jitamin\Helper\NavbarSearchHelper>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /* * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
69			]);
70			}
71
72			/**
73			* Determin if shows header search bar.
74			*
75			* @param string $path
76			*
77			* @return bool
78			*/
79			protected function canShowNavbarSearch($path = '')
80			{
81			$whiteList = ['Project/ProjectController@overview', 'Project/ProjectController@show', 'Project/Board/BoardController@show', 'CalendarController@show', 'Task/TaskController@index', 'Task/TaskController@gantt'];
82
83			return in_array($path, $whiteList);
84			}
85			}
86

Jitamin / jitamin

Pull Request — master (#165)

NavbarSearchHelper::render() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like