Event::logRequest() - Code Metrics - Inspection of "Merge pull request #1 from eustatos/scrutinizer-pa..." - eustatos/gitlab-webhook - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 936121...61de0e )

by Aleksander

created 2017-08-18 11:39 UTC

Event::logRequest() B

↳ Parent: Event

Complexity

Conditions	5
Paths	7

Size

Total Lines	21
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	21
rs	8.7624
c	0
b	0
f	0
cc	5
eloc	15
nc	7
nop	1

<?php
    namespace Eustatos\gitlab\webhook;

    /**
     * Event
     *
     * @package Eustatos\gitlab\webhook
     * @author  Alexander Astashkin <[email protected]>
     */
class Event
{
    private $_command;
    private $_output = [];
    private $_result;
    const TOKEN = 'b2b pushed';

    /**
     * __construct
     *
     * @param string $command
     * @param  string $password
     * @access public
     * @return void

     */
    public function __construct($command, $password)
    {
        $this->_command = $command;

        if ($password == self::TOKEN) {
            exec(
                $this->_command,
                $this->_output,
                $this->_result
            );
        }
    }

    /**
     * getResult
     *
     * @access public
     * @return void
     */
    public function getResult()
    {
        echo 'Result execution: ' . $this->_command . PHP_EOL
        . $this->_result . PHP_EOL;
        echo '<pre>';
            print_r($this->_output);
            echo '</pre>';
    }

    /**
     * logResult
     *
     * @param  string $file
     * @access public
     * @return void
     */
    public function logResult($file)
    {
        $this->writeToFile(
            $file,
            $this->_output
        );
    }

    /**
     * logRequest
     *
     * @param  string $file
     * @access public
     * @return void
     */
    public function logRequest($file)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

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

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        if (strcasecmp($_SERVER['REQUEST_METHOD'], 'POST') != 0) {
            throw new Exception('Request method must be POST!');
        }
        $contentType = isset($_SERVER['CONTENT_TYPE'])
            ? trim($_SERVER['CONTENT_TYPE'])
            : '';
        if (strcasecmp($contentType, 'application/json') != 0) {
            throw new Exception('Content type must be: application/json');
        }
        $jsonRequest = trim(file_get_contents('php://input'));
        $jsonRequest = json_decode($jsonRequest, true);
        if (!is_array($jsonRequest)) {
            throw new Exception('Received content conteined invalid JSON');
        }
        $this->writeToFile(
            $file,
            $jsonRequest
        );
    }

    /**
     * writeToFile
     *
     * Write to file
     *
     * @param string $file    relative path to file for write the content
     *                        Example: `bashexec.log`
     *
     * @param  mixed  $content String or array
     * @access public
     * @return void
     */
    public function writeToFile($file, $content)
    {
        file_put_contents(
            __DIR__ . DIRECTORY_SEPARATOR . $file,
            '--------------' . date('Y-m-d H:m:s') . '------------' . PHP_EOL
            . print_r($content, true),
            FILE_APPEND | LOCK_EX
        );
    }
}


1			<?php
2			namespace Eustatos\gitlab\webhook;
3
4			/**
5			* Event
6			*
7			* @package Eustatos\gitlab\webhook
8			* @author Alexander Astashkin <[email protected]>
9			*/
10			class Event
11			{
12			private $_command;
13			private $_output = [];
14			private $_result;
15			const TOKEN = 'b2b pushed';
16
17			/**
18			* __construct
19			*
20			* @param string $command
21			* @param string $password
22			* @access public
23			* @return void
			0 ignored issues – show Comprehensibility Best Practice introduced 2017-08-18 11:30 UTC by Report Bug Copy Issue Report Adding a `@return` annotation to constructors is generally not recommended as a constructor does not have a meaningful return value. Adding a `@return` annotation to a constructor is not recommended, since a constructor does not have a meaningful return value. Please refer to the PHP core documentation on constructors. Loading history...
24			*/
25			public function __construct($command, $password)
26			{
27			$this->_command = $command;
28
29			if ($password == self::TOKEN) {
30			exec(
31			$this->_command,
32			$this->_output,
33			$this->_result
34			);
35			}
36			}
37
38			/**
39			* getResult
40			*
41			* @access public
42			* @return void
43			*/
44			public function getResult()
45			{
46			echo 'Result execution: ' . $this->_command . PHP_EOL
47			. $this->_result . PHP_EOL;
48			echo '<pre>';
49			print_r($this->_output);
50			echo '</pre>';
51			}
52
53			/**
54			* logResult
55			*
56			* @param string $file
57			* @access public
58			* @return void
59			*/
60			public function logResult($file)
61			{
62			$this->writeToFile(
63			$file,
64			$this->_output
65			);
66			}
67
68			/**
69			* logRequest
70			*
71			* @param string $file
72			* @access public
73			* @return void
74			*/
75			public function logRequest($file)
			0 ignored issues – show Coding Style introduced 2017-08-18 11:30 UTC by Report Bug Copy Issue Report `logRequest` uses the super-global variable `$_SERVER` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
76			{
77			if (strcasecmp($_SERVER['REQUEST_METHOD'], 'POST') != 0) {
78			throw new Exception('Request method must be POST!');
79			}
80			$contentType = isset($_SERVER['CONTENT_TYPE'])
81			? trim($_SERVER['CONTENT_TYPE'])
82			: '';
83			if (strcasecmp($contentType, 'application/json') != 0) {
84			throw new Exception('Content type must be: application/json');
85			}
86			$jsonRequest = trim(file_get_contents('php://input'));
87			$jsonRequest = json_decode($jsonRequest, true);
88			if (!is_array($jsonRequest)) {
89			throw new Exception('Received content conteined invalid JSON');
90			}
91			$this->writeToFile(
92			$file,
93			$jsonRequest
94			);
95			}
96
97			/**
98			* writeToFile
99			*
100			* Write to file
101			*
102			* @param string $file relative path to file for write the content
103			* Example: `bashexec.log`
104			*
105			* @param mixed $content String or array
106			* @access public
107			* @return void
108			*/
109			public function writeToFile($file, $content)
110			{
111			file_put_contents(
112			__DIR__ . DIRECTORY_SEPARATOR . $file,
113			'--------------' . date('Y-m-d H:m:s') . '------------' . PHP_EOL
114			. print_r($content, true),
115			FILE_APPEND \| LOCK_EX
116			);
117			}
118			}
119

eustatos / gitlab-webhook

Push — master ( 936121...61de0e )

Event::logRequest() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like