LayoutHelper::projectUser()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 6
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 3
nc 1
nop 2
dl 0
loc 6
rs 9.4285
c 0
b 0
f 0
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
 * Layout Helper.
18
 */
19
class LayoutHelper extends Base
20
{
21
    /**
22
     * Render a template without the layout if Ajax request.
23
     *
24
     * @param string $template Template name
25
     * @param array  $params   Template parameters
26
     *
27
     * @return string
28
     */
29
    public function app($template, array $params = [])
30
    {
31
        $content = $this->template->render($template, $params);
0 ignored issues
show
Documentation introduced by
The property template does not exist on object<Jitamin\Helper\LayoutHelper>. 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
33
        if ($this->request->isAjax()) {
0 ignored issues
show
Documentation introduced by
The property request does not exist on object<Jitamin\Helper\LayoutHelper>. 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...
34
            return $content;
35
        }
36
37
        return $this->template->render(
0 ignored issues
show
Documentation introduced by
The property template does not exist on object<Jitamin\Helper\LayoutHelper>. 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...
38
            'layouts/master',
39
            $params + ['content_for_layout' => $content]
40
        );
41
    }
42
43
    /**
44
     * Common layout for profile views.
45
     *
46
     * @param string $template Template name
47
     * @param array  $params   Template parameters
48
     * @param string $subside
49
     *
50
     * @return string
51
     */
52
    public function profile($template, array $params, $subside = 'profile/_partials/subnav')
53
    {
54
        if (isset($params['user'])) {
55
            $params['title'] = '#'.$params['user']['id'].' '.($params['user']['name'] ?: $params['user']['username']);
56
        }
57
58
        return $this->subLayout('profile/layout', $subside, $template, $params);
59
    }
60
61
    /**
62
     * Common layout for task views.
63
     *
64
     * @param string $template Template name
65
     * @param array  $params   Template parameters
66
     *
67
     * @return string
68
     */
69
    public function task($template, array $params)
70
    {
71
        $params['page_title'] = $params['task']['project_name'].', #'.$params['task']['id'].' - '.$params['task']['title'];
72
        $params['title'] = $params['task']['project_name'];
73
74
        return $this->subLayout('task/layout', 'task/subside', $template, $params);
75
    }
76
77
    /**
78
     * Common layout for project views.
79
     *
80
     * @param string $template
81
     * @param array  $params
82
     * @param string $subside
83
     *
84
     * @return string
85
     */
86
    public function project($template, array $params, $subside = 'manage/project_settings/subside')
87
    {
88
        if (empty($params['title'])) {
89
            $params['title'] = $params['project']['name'];
90 View Code Duplication
        } elseif ($params['project']['name'] !== $params['title']) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
91
            $params['title'] = $params['project']['name'].' &raquo; '.$params['title'];
92
        }
93
94
        return $this->subLayout('project/layout', $subside, $template, $params);
95
    }
96
97
    /**
98
     * Common layout for project user views.
99
     *
100
     * @param string $template
101
     * @param array  $params
102
     *
103
     * @return string
104
     */
105
    public function projectUser($template, array $params)
106
    {
107
        $params['filter'] = ['user_id' => $params['user_id']];
108
109
        return $this->subLayout('manage/project_user_overview/layout', 'manage/project_user_overview/subside', $template, $params);
110
    }
111
112
    /**
113
     * Common layout for admin views.
114
     *
115
     * @param string $template
116
     * @param array  $params
117
     * @param string $subside
118
     *
119
     * @return string
120
     */
121
    public function admin($template, array $params, $subside = 'admin/setting/subside')
122
    {
123
        if (!isset($params['values'])) {
124
            $params['values'] = $this->settingModel->getAll();
0 ignored issues
show
Documentation introduced by
The property settingModel does not exist on object<Jitamin\Helper\LayoutHelper>. 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...
125
        }
126
127
        if (!isset($params['errors'])) {
128
            $params['errors'] = [];
129
        }
130
131
        return $this->subLayout('admin/layout', $subside, $template, $params);
132
    }
133
134
    /**
135
     * Common layout for dashboard views.
136
     *
137
     * @param string $template
138
     * @param array  $params
139
     * @param string $subside
140
     *
141
     * @return string
142
     */
143
    public function dashboard($template, array $params, $subside = 'dashboard/_partials/subnav')
144
    {
145
        return $this->subLayout('dashboard/layout', $subside, $template, $params);
146
    }
147
148
    /**
149
     * Common layout for analytic views.
150
     *
151
     * @param string $template
152
     * @param array  $params
153
     *
154
     * @return string
155
     */
156
    public function analytic($template, array $params, $subside = 'project/analytic/_partials/subside')
157
    {
158 View Code Duplication
        if (isset($params['project']['name'])) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
159
            $params['title'] = $params['project']['name'].' &raquo; '.$params['title'];
160
        }
161
162
        return $this->subLayout('project/analytic/layout', $subside, $template, $params);
163
    }
164
165
    /**
166
     * Common method to generate a sub-layout.
167
     *
168
     * @param string $sublayout
169
     * @param string $subside
170
     * @param string $template
171
     * @param array  $params
172
     *
173
     * @return string
174
     */
175
    protected function subLayout($sublayout, $subside, $template, array $params = [])
176
    {
177
        $content = $this->template->render($template, $params);
0 ignored issues
show
Documentation introduced by
The property template does not exist on object<Jitamin\Helper\LayoutHelper>. 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...
178
179
        if ($this->request->isAjax()) {
0 ignored issues
show
Documentation introduced by
The property request does not exist on object<Jitamin\Helper\LayoutHelper>. 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...
180
            return $content;
181
        }
182
183
        $params['content_for_sublayout'] = $content;
184
        $params['subside_template'] = $subside;
185
186
        return $this->app($sublayout, $params);
187
    }
188
}
189