GitHub Access Token became invalid

It seems like the GitHub access token used for retrieving details about this repository from GitHub became invalid. This might prevent certain types of inspections from being run (in particular, everything related to pull requests).
Please ask an admin of your repository to re-new the access token on this website.

Issues (46)

Security Analysis    no request data  

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/Repositories/Repository.php (3 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 Caffeinated\Modules\Repositories;
4
5
use Caffeinated\Modules\Contracts\RepositoryInterface;
6
use Illuminate\Config\Repository as Config;
7
use Illuminate\Filesystem\Filesystem;
8
9
abstract class Repository implements RepositoryInterface
10
{
11
    /**
12
     * @var \Illuminate\Config\Repository
13
     */
14
    protected $config;
15
16
    /**
17
     * @var \Illuminate\Filesystem\Filesystem
18
     */
19
    protected $files;
20
21
    /**
22
     * @var string Path to the defined modules directory
23
     */
24
    protected $path;
25
26
    /**
27
     * Constructor method.
28
     *
29
     * @param \Illuminate\Config\Repository     $config
30
     * @param \Illuminate\Filesystem\Filesystem $files
31
     */
32
    public function __construct(Config $config, Filesystem $files)
33
    {
34
        $this->config = $config;
35
        $this->files  = $files;
36
    }
37
38
    /**
39
     * Get all module basenames.
40
     *
41
     * @return array
42
     */
43
    protected function getAllBasenames()
44
    {
45
        $path = $this->getPath();
46
47
        try {
48
            $collection = collect($this->files->directories($path));
49
50
            $basenames = $collection->map(function ($item, $key) {
0 ignored issues
show
The parameter $key is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
51
                return basename($item);
52
            });
53
54
            return $basenames;
55
        } catch (\InvalidArgumentException $e) {
56
            return collect(array());
57
        }
58
    }
59
60
    /**
61
     * Get a module's manifest contents.
62
     *
63
     * @param string $slug
64
     *
65
     * @return Collection|null
66
     */
67
    public function getManifest($slug)
68
    {
69
        if (! is_null($slug)) {
70
            $module     = str_slug($slug);
71
            $path       = $this->getManifestPath($module);
72
            $contents   = $this->files->get($path);
73
            $collection = collect(json_decode($contents, true));
74
75
            return $collection;
0 ignored issues
show
Bug Best Practice introduced by
The return type of return $collection; (Illuminate\Support\Collection) is incompatible with the return type declared by the interface Caffeinated\Modules\Cont...yInterface::getManifest of type Caffeinated\Modules\Contracts\Collection.

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...
76
        }
77
78
        return;
79
    }
80
81
    /**
82
     * Get modules path.
83
     *
84
     * @return string
85
     */
86
    public function getPath()
87
    {
88
        return $this->path ?: $this->config->get('modules.path');
89
    }
90
91
    /**
92
     * Set modules path in "RunTime" mode.
93
     *
94
     * @param string $path
95
     *
96
     * @return object $this
97
     */
98
    public function setPath($path)
99
    {
100
        $this->path = $path;
101
102
        return $this;
103
    }
104
105
    /**
106
     * Get path for the specified module.
107
     *
108
     * @param string $slug
109
     *
110
     * @return string
111
     */
112
    public function getModulePath($slug)
113
    {
114
        $module = studly_case($slug);
115
116
        return $this->getPath()."/{$module}/";
117
    }
118
119
    /**
120
     * Get path of module manifest file.
121
     *
122
     * @param string $module
0 ignored issues
show
There is no parameter named $module. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
123
     *
124
     * @return string
125
     */
126
    protected function getManifestPath($slug)
127
    {
128
        return $this->getModulePath($slug).'module.json';
129
    }
130
131
    /**
132
     * Get modules namespace.
133
     *
134
     * @return string
135
     */
136
    public function getNamespace()
137
    {
138
        return rtrim($this->config->get('modules.namespace'), '/\\');
139
    }
140
}
141