Issues (19)

Security Analysis    not enabled

This project does not seem to handle request data directly as such no vulnerable execution paths were found.

  Cross-Site Scripting
Cross-Site Scripting enables an attacker to inject code into the response of a web-request that is viewed by other users. It can for example be used to bypass access controls, or even to take over other users' accounts.
  File Exposure
File Exposure allows an attacker to gain access to local files that he should not be able to access. These files can for example include database credentials, or other configuration files.
  File Manipulation
File Manipulation enables an attacker to write custom data to files. This potentially leads to injection of arbitrary code on the server.
  Object Injection
Object Injection enables an attacker to inject an object into PHP code, and can lead to arbitrary code execution, file exposure, or file manipulation attacks.
  Code Injection
Code Injection enables an attacker to execute arbitrary code on the server.
  Response Splitting
Response Splitting can be used to send arbitrary responses.
  File Inclusion
File Inclusion enables an attacker to inject custom files into PHP's file loading mechanism, either explicitly passed to include, or for example via PHP's auto-loading mechanism.
  Command Injection
Command Injection enables an attacker to inject a shell command that is execute with the privileges of the web-server. This can be used to expose sensitive data, or gain access of your server.
  SQL Injection
SQL Injection enables an attacker to execute arbitrary SQL code on your database server gaining access to user data, or manipulating user data.
  XPath Injection
XPath Injection enables an attacker to modify the parts of XML document that are read. If that XML document is for example used for authentication, this can lead to further vulnerabilities similar to SQL Injection.
  LDAP Injection
LDAP Injection enables an attacker to inject LDAP statements potentially granting permission to run unauthorized queries, or modify content inside the LDAP tree.
  Header Injection
  Other Vulnerability
This category comprises other attack vectors such as manipulating the PHP runtime, loading custom extensions, freezing the runtime, or similar.
  Regex Injection
Regex Injection enables an attacker to execute arbitrary code in your PHP process.
  XML Injection
XML Injection enables an attacker to read files on your local filesystem including configuration files, or can be abused to freeze your web-server process.
  Variable Injection
Variable Injection enables an attacker to overwrite program variables with custom data, and can lead to further vulnerabilities.
Unfortunately, the security analysis is currently not available for your project. If you are a non-commercial open-source project, please contact support to gain access.

src/Models/Project.php (4 issues)

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

1
<?php
2
3
namespace Larafolio\Models;
4
5
use Larafolio\Helpers\Sluggable;
6
use Illuminate\Database\Eloquent\SoftDeletes;
7
8
class Project extends HasContent
9
{
10
    use Sluggable, SoftDeletes;
11
12
    /**
13
     * The table associated with the model.
14
     *
15
     * @var string
16
     */
17
    protected $table = 'projects';
18
19
    /**
20
     * The attributes that are mass assignable.
21
     *
22
     * @var array
23
     */
24
    protected $fillable = [
25
        'name', 'slug', 'type', 'visible', 'order',
26
    ];
27
28
    /**
29
     * Properties to always eager load.
30
     *
31
     * @var array
32
     */
33
    protected $with = ['blocks', 'images', 'links'];
34
35
    /**
36
     * The attributes that should be casted to native types.
37
     *
38
     * @var array
39
     */
40
    protected $casts = [
41
        'visible' => 'boolean',
42
    ];
43
44
    /**
45
     * Fields that are dates.
46
     *
47
     * @var array
48
     */
49
    protected $dates = ['created_at', 'updated_at', 'deleted_at'];
50
51
    /**
52
     * Get the route key for the model.
53
     *
54
     * @return string
55
     */
56
    public function getRouteKeyName()
57
    {
58
        return 'slug';
59
    }
60
61
    /**
62
     * Bootstrap model.
63
     */
64
    public static function boot()
65
    {
66
        parent::boot();
67
68
        static::creating(function (Project $project) {
69
            $project->setSlug('name');
70
        });
71
72
        static::updating(function (Project $project) {
73
            $project->setSlug('name');
74
        });
75
    }
76
77
    /**
78
     * Return all visible projects.
79
     *
80
     * @param bool $group If true, group projects by 'type'.
81
     * @param bool $order If true, order projects by 'order'.
82
     *
83
     * @return \Illuminate\Support\Collection
84
     */
85
    public static function allVisible($group = true, $order = true)
86
    {
87
        $query = static::where('visible', true);
88
89
        return static::orderAndGroupQuery($query, $group, $order);
90
    }
91
92
    /**
93
     * Return all hidden projects.
94
     *
95
     * @param bool $group If true, group projects by 'type'.
96
     * @param bool $order If true, order projects by 'order'.
97
     *
98
     * @return \Illuminate\Support\Collection
99
     */
100
    public static function allHidden($group = true, $order = true)
101
    {
102
        $query = static::where('visible', false);
103
104
        return static::orderAndGroupQuery($query, $group, $order);
105
    }
106
107
    /**
108
     * Return all projects grouped by 'type'.
109
     *
110
     * @param bool $order If true, order projects by 'order'.
111
     *
112
     * @return \Illuminate\Support\Collection
113
     */
114
    public static function allGrouped($order = true)
115
    {
116
        $query = static::query();
117
118
        return static::orderAndGroupQuery($query, true, $order);
0 ignored issues
show
$query is of type object<Illuminate\Database\Eloquent\Builder>, but the function expects a object<Larafolio\Models\Builder>.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
119
    }
120
121
    /**
122
     * Return all projects ordered by 'order'.
123
     *
124
     * @return \Illuminate\Support\Collection
125
     */
126
    public static function allOrdered()
127
    {
128
        $query = static::query();
129
130
        return static::orderAndGroupQuery($query, false, true);
0 ignored issues
show
$query is of type object<Illuminate\Database\Eloquent\Builder>, but the function expects a object<Larafolio\Models\Builder>.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
131
    }
132
133
    /**
134
     * Order and group query, return results.
135
     *
136
     * @param Builder $query Query to be ordered.
137
     * @param bool    $group If true, group projects by 'type'.
138
     * @param bool    $order If true, order projects by 'order'.
139
     *
140
     * @return \Illuminate\Support\Collection
141
     */
142
    protected static function orderAndGroupQuery($query, $group, $order)
143
    {
144
        if ($order) {
145
            $query->orderBy('order');
146
        }
147
148
        $query->orderRelationship('links');
149
150
        $query->orderRelationship('blocks');
151
152
        if ($group) {
153
            return $query->get()
154
                ->each(function ($project, $key) {
155
                    $project->index = $key;
156
                })
157
                ->groupBy('type');
158
        }
159
160
        return $query->get();
161
    }
162
163
    /**
164
     * Get all projects with given block name.
165
     *
166
     * @param string $blockName Name of block.
167
     *
168
     * @return \Illuminate\Support\Collection
169
     */
170
    public static function hasBlockNamed($blockName)
171
    {
172
        return static::hasRelationshipNamed('text_blocks', $blockName);
173
    }
174
175
    /**
176
     * Get all projects with given image name.
177
     *
178
     * @param string $imageName Name of image.
179
     *
180
     * @return \Illuminate\Support\Collection
181
     */
182
    public static function hasImageNamed($imageName)
183
    {
184
        return static::hasRelationshipNamed('images', $imageName);
185
    }
186
187
    /**
188
     * Get all projects with given link name.
189
     *
190
     * @param string $linkName Name of link.
191
     *
192
     * @return \Illuminate\Support\Collection
193
     */
194
    public static function hasLinkNamed($linkName)
195
    {
196
        return static::hasRelationshipNamed('links', $linkName);
197
    }
198
199
    /**
200
     * Get all projects with relationship on table that has given name.
201
     *
202
     * @param string $table Name of table relationship is on.
203
     * @param string $name  Relationship name.
204
     *
205
     * @return \Illuminate\Support\Collection
206
     */
207
    protected static function hasRelationshipNamed($table, $name)
208
    {
209
        return static::join($table, 'projects.id', '=', "{$table}.project_id")
210
            ->where("{$table}.name", '=', $name)
211
            ->select('projects.*')
212
            ->get();
213
    }
214
215
    /**
216
     * Return the project id.
217
     *
218
     * @return int
219
     */
220
    public function id()
221
    {
222
        return $this->id;
223
    }
224
225
    /**
226
     * Return the project name.
227
     *
228
     * @return string
229
     */
230
    public function name()
231
    {
232
        return $this->name;
233
    }
234
235
    /**
236
     * Return the project type.
237
     *
238
     * @return string
239
     */
240
    public function type()
241
    {
242
        return $this->type;
243
    }
244
245
    /**
246
     * Return the project slug.
247
     *
248
     * @return string
249
     */
250
    public function slug()
251
    {
252
        return $this->slug;
253
    }
254
255
    /**
256
     * Return the project order value.
257
     *
258
     * @return int
259
     */
260
    public function order()
261
    {
262
        return $this->order;
263
    }
264
265
    /**
266
     * Get formatted text of block named description or first block.
267
     *
268
     * @return Larafolio\Models\TextBlock
269
     */
270
    public function getProjectBlock()
271
    {
272
        $block = $this->block($this->name());
273
274
        if ($block) {
275
            return $block;
0 ignored issues
show
Bug Best Practice introduced by
The return type of return $block; (Illuminate\Database\Eloquent\Model) is incompatible with the return type documented by Larafolio\Models\Project::getProjectBlock of type Larafolio\Models\Larafolio\Models\TextBlock.

If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.

Let’s take a look at an example:

class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

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

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

Our function my_function expects a Post object, and outputs the author of the post. The base class Post returns a simple string and outputting a simple string will work just fine. However, the child class BlogPost which is a sub-type of Post instead decided to return an object, and is therefore violating the SOLID principles. If a BlogPost were passed to my_function, PHP would not complain, but ultimately fail when executing the strtoupper call in its body.

Loading history...
276
        } elseif ($this->hasBlocks()) {
277
            return $this->blocks()->first();
278
        }
279
    }
280
281
    /**
282
     * Get formatted text of block named description or first block.
283
     *
284
     * @param bool $formatted If true, return formatted text.
285
     *
286
     * @return string
287
     */
288
    public function getProjectBlockText($formatted = true)
289
    {
290
        $project = $this->getProjectBlock();
291
292
        if ($project && $formatted) {
293
            return $project->formattedText();
294
        } elseif ($project) {
295
            return $project->text();
296
        }
297
298
        return $project;
299
    }
300
301
    /**
302
     * Get url of small image with project name or first image in collection.
303
     *
304
     * @return Larafolio\Models\Image
305
     */
306
    public function getProjectImage()
307
    {
308
        $projectImage = $this->image($this->name());
309
310
        if ($projectImage) {
311
            return $projectImage;
0 ignored issues
show
Bug Best Practice introduced by
The return type of return $projectImage; (Illuminate\Database\Eloquent\Model) is incompatible with the return type documented by Larafolio\Models\Project::getProjectImage of type Larafolio\Models\Larafolio\Models\Image.

If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.

Let’s take a look at an example:

class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

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

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

Our function my_function expects a Post object, and outputs the author of the post. The base class Post returns a simple string and outputting a simple string will work just fine. However, the child class BlogPost which is a sub-type of Post instead decided to return an object, and is therefore violating the SOLID principles. If a BlogPost were passed to my_function, PHP would not complain, but ultimately fail when executing the strtoupper call in its body.

Loading history...
312
        } elseif ($this->hasImages()) {
313
            return $this->images()->first();
314
        }
315
    }
316
317
    /**
318
     * Get url of small image with project name or first image in collection.
319
     *
320
     * @param string $size The size of the image, name of image cache filter.
321
     *
322
     * @return string
323
     */
324
    public function getProjectImageUrl($size = 'small')
325
    {
326
        $projectImage = $this->getProjectImage();
327
328
        if ($projectImage) {
329
            return $projectImage->{$size}();
330
        }
331
332
        return $projectImage;
333
    }
334
335
    /**
336
     * Get blocks sorted by order.
337
     *
338
     * @param \Builder $query Query builder.
339
     * @param string   $slug  Project slug.
340
     *
341
     * @return \Builder
342
     */
343
    public function scopeWithBlocks($query, $slug)
344
    {
345
        return $query->orderRelationship('blocks')
346
            ->where('slug', $slug);
347
    }
348
349
    /**
350
     * Get full project info (blocks and links sorted by order).
351
     *
352
     * @param \Builder $query Query builder.
353
     * @param string   $slug  Project slug.
354
     *
355
     * @return \Builder
356
     */
357
    public function scopeFull($query, $slug)
358
    {
359
        return $query->orderRelationship('blocks')
360
            ->orderRelationship('links')
361
            ->where('slug', $slug);
362
    }
363
364
    /**
365
     * Order given relationship by order value.
366
     *
367
     * @param \Builder $query        Query builder.
368
     * @param string   $relationship Name of relationship to order.
369
     *
370
     * @return \Builder
371
     */
372
    public function scopeOrderRelationship($query, $relationship)
373
    {
374
        return $query->with([$relationship => function ($query) {
375
            $query->orderBy('order');
376
        }]);
377
    }
378
379
    /**
380
     * Return project properties to be passed to js.
381
     *
382
     * @return array
383
     */
384
    public function generateProps()
385
    {
386
        return [
387
            'deletedAt' => $this->deleted_at->diffForHumans(),
388
            'id'        => $this->id(),
389
            'name'      => $this->name(),
390
            'slug'      => $this->slug(),
391
        ];
392
    }
393
}
394