StoreManager::trackEvent() - Code Metrics - Inspection of "Just style fixing" - libgraviton/graviton - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/EVO-7278-tracking-info... ( d73a1e...c12eb7 )

unknown

created 2016-09-16 15:04 UTC

StoreManager::trackEvent() A

↳ Parent: StoreManager

Complexity

Conditions	2
Paths	3

Size

Total Lines	14
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	14
rs	9.4285
cc	2
eloc	8
nc	3
nop	3

<?php
/**
 * To manage the data to be saved into DB as last thing to do.
 */
namespace Graviton\AuditTrackingBundle\Manager;

use Doctrine\ODM\MongoDB\DocumentManager;
use Graviton\AuditTrackingBundle\Document\AuditTracking;
use Doctrine\Bundle\MongoDBBundle\ManagerRegistry;

/**
 * Class StoreManager
 * @package Graviton\AuditTrackingBundle\Manager
 *
 * @author   List of contributors <https://github.com/libgraviton/graviton/graphs/contributors>
 * @license  http://opensource.org/licenses/gpl-license.php GNU Public License
 * @link     http://swisscom.ch
 */
class StoreManager
{
    /** @var ActivityManager */
    private $activityManager;

    /** @var DocumentManager */
    private $documentManager;

    /**
     * Avoid saving same action again
     * @var
     */
    private $saved;


    /**
     * StoreManager constructor.
     * @param ActivityManager $activityManager Main activity manager
     * @param ManagerRegistry $doctrine        Doctrine document mapper
     */
    public function __construct(
        ActivityManager $activityManager,
        ManagerRegistry $doctrine
    ) {
        $this->activityManager = $activityManager;

        $this->documentManager = $doctrine->getManager();
    }

    /**
     * Save data to DB
     * onKernelResponse
     *
     * @return void
     */
    public function persistEvents()
    {
        $events = $this->activityManager->getEvents();
        $thread = $this->generateUUID();
        $username = $this->activityManager->getSecurityUsername();

        foreach ($events as $event) {
            $this->trackEvent($event, $thread, $username);
<?php

function getDate($date)
{
    if ($date !== null) {
        return new DateTime($date);
    }

    return false;
}
        }
    }

    /**
     * Save the event to DB
     *
     * @param AuditTracking $event    Performed by user
     * @param string        $thread   The thread ID
     * @param string        $username User connected name
     * @return void
     */
    private function trackEvent($event, $thread, $username)
    {
        // Request information
        $event->setThread($thread);
        $event->setUsername($username);

        try {
            $this->documentManager->persist($event);
            $this->documentManager->flush($event);
        } catch (\Exception $e) {
            die(var_dump($e->getMessage()));

            // TODO LOG the error and event
        }
    }



    /**
     * Generate a unique identifer
     *
     * @return string
     */
    private function generateUUID()
    {
        if (!function_exists('openssl_random_pseudo_bytes')) {
            return uniqid('unq', true);
        }

        $data = openssl_random_pseudo_bytes(16);
        $data[6] = chr(ord($data[6]) & 0x0f | 0x40);    // set version to 0100
        $data[8] = chr(ord($data[8]) & 0x3f | 0x80);    // set bits 6-7 to 10
        return vsprintf('%s%s-%s-%s-%s-%s%s%s', str_split(bin2hex($data), 4));
    }
}


1			<?php
2			/**
3			* To manage the data to be saved into DB as last thing to do.
4			*/
5			namespace Graviton\AuditTrackingBundle\Manager;
6
7			use Doctrine\ODM\MongoDB\DocumentManager;
8			use Graviton\AuditTrackingBundle\Document\AuditTracking;
9			use Doctrine\Bundle\MongoDBBundle\ManagerRegistry;
10
11			/**
12			* Class StoreManager
13			* @package Graviton\AuditTrackingBundle\Manager
14			*
15			* @author List of contributors <https://github.com/libgraviton/graviton/graphs/contributors>
16			* @license http://opensource.org/licenses/gpl-license.php GNU Public License
17			* @link http://swisscom.ch
18			*/
19			class StoreManager
20			{
21			/** @var ActivityManager */
22			private $activityManager;
23
24			/** @var DocumentManager */
25			private $documentManager;
26
27			/**
28			* Avoid saving same action again
29			* @var
30			*/
31			private $saved;
			0 ignored issues – show Unused Code introduced 2016-09-16 16:10 UTC by Report Bug Copy Issue Report The property `$saved` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
32
33			/**
34			* StoreManager constructor.
35			* @param ActivityManager $activityManager Main activity manager
36			* @param ManagerRegistry $doctrine Doctrine document mapper
37			*/
38			public function __construct(
39			ActivityManager $activityManager,
40			ManagerRegistry $doctrine
41			) {
42			$this->activityManager = $activityManager;
43
44			$this->documentManager = $doctrine->getManager();
45			}
46
47			/**
48			* Save data to DB
49			* onKernelResponse
50			*
51			* @return void
52			*/
53			public function persistEvents()
54			{
55			$events = $this->activityManager->getEvents();
56			$thread = $this->generateUUID();
57			$username = $this->activityManager->getSecurityUsername();
58
59			foreach ($events as $event) {
60			$this->trackEvent($event, $thread, $username);
			0 ignored issues – show Security Bug introduced 2016-09-16 16:10 UTC by Report Bug Copy Issue Report It seems like `$username` defined by `$this->activityManager->getSecurityUsername()` on line `57` can also be of type `false`; however, `Graviton\AuditTrackingBu...reManager::trackEvent()` does only seem to accept `string`, did you maybe forget to handle an error condition? This check looks for type mismatches where the missing type is `false`. This is usually indicative of an error condtion. Consider the follow example <?php function getDate($date) { if ($date !== null) { return new DateTime($date); } return false; } This function either returns a new `DateTime` object or false, if there was an error. This is a typical pattern in PHP programming to show that an error has occurred without raising an exception. The calling code should check for this returned `false` before passing on the value to another function or method that may not be able to handle a `false`. Loading history...
61			}
62			}
63
64			/**
65			* Save the event to DB
66			*
67			* @param AuditTracking $event Performed by user
68			* @param string $thread The thread ID
69			* @param string $username User connected name
70			* @return void
71			*/
72			private function trackEvent($event, $thread, $username)
73			{
74			// Request information
75			$event->setThread($thread);
76			$event->setUsername($username);
77
78			try {
79			$this->documentManager->persist($event);
80			$this->documentManager->flush($event);
81			} catch (\Exception $e) {
82			die(var_dump($e->getMessage()));
			0 ignored issues – show Security Debugging Code introduced 2016-09-16 16:10 UTC by Report Bug Copy Issue Report `var_dump($e->getMessage());` looks like debug code. Are you sure you do not want to remove it? This might expose sensitive data. Loading history... Coding Style Compatibility introduced 2016-09-16 16:10 UTC by Report Bug Copy Issue Report The method `trackEvent()` contains an exit expression. An exit expression should only be used in rare cases. For example, if you write a short command line script. In most cases however, using an `exit` expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage. Loading history...
83			// TODO LOG the error and event
84			}
85			}
86
87
88
89			/**
90			* Generate a unique identifer
91			*
92			* @return string
93			*/
94			private function generateUUID()
95			{
96			if (!function_exists('openssl_random_pseudo_bytes')) {
97			return uniqid('unq', true);
98			}
99
100			$data = openssl_random_pseudo_bytes(16);
101			$data[6] = chr(ord($data[6]) & 0x0f \| 0x40); // set version to 0100
102			$data[8] = chr(ord($data[8]) & 0x3f \| 0x80); // set bits 6-7 to 10
103			return vsprintf('%s%s-%s-%s-%s-%s%s%s', str_split(bin2hex($data), 4));
104			}
105			}
106

libgraviton / graviton

Push — feature/EVO-7278-tracking-info... ( d73a1e...c12eb7 )

StoreManager::trackEvent() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like