Counters::getCookieName() - Code Metrics - turahe/laravel-counters - Measure and Improve Code Quality continuously with Scrutinizer

Counters::getCookieName() A
last analyzed 2023-09-16 10:12 UTC

↳ Parent: Counters

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	1
c	1
b	0
f	0
dl	0
loc	3
rs	10
cc	1
nc	1
nop	1

<?php
namespace Turahe\Counters\Classes;

use Turahe\Counters\Models\Counter;
use Turahe\Counters\Exceptions\CounterDoesNotExist;
use Turahe\Counters\Exceptions\CounterAlreadyExists;

/**
 * Class Counters.
 * @package Turahe\Counters\Classes
 */
class Counters
{
    /**
     * @param $key
     * @param $name
     * @param int $initial_value
     * @param int $step
     * Creating a record in counters table with $key, $name, $inital_value, $step
     */
    public function create($key, $name, $initial_value = 0, $step = 1)
    {
        $value = $initial_value;

        try {
            Counter::query()->create(
                compact('key', 'name', 'initial_value', 'step', 'value')
            );
        } catch (\Exception $e) {
            throw CounterAlreadyExists::create($key);
        }
    }

    /**
     * @param $key
     * @return \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Eloquent\Model|Counter
     * Get a counter object for the given $key
     */
    public function get($key)
    {
        $counter = Counter::query()->where('key', $key)->first();

        if (is_null($counter)) {
            throw CounterDoesNotExist::create($key);
        }

        return $counter;
    }

    /**
     * @param $key
     * @param null $default

     * @return mixed|null|string
     * get the counter value for the given $key,
     * $default will be returned in case the key is not found
     */
    public function getValue($key, $default = null)
    {
        $counter = Counter::query()->where('key', $key)->first();

        if ($counter) {
            return $counter->value;
        } elseif (! is_null($default)) {

            return $default;
        }

        throw CounterDoesNotExist::create($key);
    }

    /**
     * @param $key
     * @param $value
     * set the value of the given counter's key
     */
    public function setValue($key, $value)
    {
        Counter::query()->where('key', $key)->update(['value' => $value]);
    }

    /**
     * @param $key
     * @param $step
     * set the step value for a given counter's
     */
    public function setStep($key, $step)
    {
        Counter::query()->where('key', $key)->update(['step' => $step]);
    }

    /**
     * @param $key
     * @param null $step

     * @return \Illuminate\Database\Eloquent\Model|Counters|null
     * increment the counter with the step
     */
    public function increment($key, $step = null)
    {
        $counter = $this->get($key);

        if ($counter) {

            $counter->update(['value' => $counter->value + ($step ?? $counter->step)]);
        }

        return $counter;
    }

    /**
     * @param $key
     * @param null $step

     * @return \Illuminate\Database\Eloquent\Model|Counters|null
     * decrement the counter with the step
     */
    public function decrement($key, $step = null)
    {
        $counter = $this->get($key);

        if ($counter) {

            $counter->update(['value' => $counter->value - ($step ?? $counter->step)]);
        }

        return $counter;
    }

    /**
     * @param $key
     * @return \Illuminate\Database\Eloquent\Model|Counters|null
     */
    public function reset($key)
    {
        $counter = $this->get($key);

        if ($counter) {

            $counter->update(['value' => $counter->initial_value]);
        }

        return $counter;
    }

    /**
     * @param $key
     * This function will store a cookie for the counter key
     * If the cookie already exist, the counter will not incremented again
     * @param null $step

     */
    public function incrementIfNotHasCookies($key, $step = null)
    {
        $cookieName = $this->getCookieName($key);

        if (! array_key_exists($cookieName, $_COOKIE)) {
            $this->increment($key, $step);
            setcookie($cookieName, 1);
        }
    }

    /**
     * @param $key
     * This function will store a cookie for the counter key
     * If the cookie already exist, the counter will not decremented again
     * @param null $step

     */
    public function decrementIfNotHasCookies($key, $step = null)
    {
        $cookieName = $this->getCookieName($key);

        if (! array_key_exists($cookieName, $_COOKIE)) {
            $this->decrement($key, $step);
            setcookie($cookieName, 1);
        }
    }

    /**
     * @param $key
     * @return string
     */
    private function getCookieName($key)
    {
        return 'counters-cookie-'.$key;
    }
}


1			<?php
2			namespace Turahe\Counters\Classes;
3
4			use Turahe\Counters\Models\Counter;
5			use Turahe\Counters\Exceptions\CounterDoesNotExist;
6			use Turahe\Counters\Exceptions\CounterAlreadyExists;
7
8			/**
9			* Class Counters.
10			* @package Turahe\Counters\Classes
11			*/
12			class Counters
13			{
14			/**
15			* @param $key
16			* @param $name
17			* @param int $initial_value
18			* @param int $step
19			* Creating a record in counters table with $key, $name, $inital_value, $step
20			*/
21			public function create($key, $name, $initial_value = 0, $step = 1)
22			{
23			$value = $initial_value;
24
25			try {
26			Counter::query()->create(
27			compact('key', 'name', 'initial_value', 'step', 'value')
28			);
29			} catch (\Exception $e) {
30			throw CounterAlreadyExists::create($key);
31			}
32			}
33
34			/**
35			* @param $key
36			* @return \Illuminate\Database\Eloquent\Builder\|\Illuminate\Database\Eloquent\Model\|Counter
37			* Get a counter object for the given $key
38			*/
39			public function get($key)
40			{
41			$counter = Counter::query()->where('key', $key)->first();
42
43			if (is_null($counter)) {
44			throw CounterDoesNotExist::create($key);
45			}
46
47			return $counter;
48			}
49
50			/**
51			* @param $key
52			* @param null $default
			0 ignored issues – show Documentation Bug introduced 2021-09-05 20:03 UTC by Report Bug Copy Issue Report Are you sure the doc-type for parameter `$default` is correct as it would always require `null` to be passed? Loading history...
53			* @return mixed\|null\|string
54			* get the counter value for the given $key,
55			* $default will be returned in case the key is not found
56			*/
57			public function getValue($key, $default = null)
58			{
59			$counter = Counter::query()->where('key', $key)->first();
60
61			if ($counter) {
62			return $counter->value;
63			} elseif (! is_null($default)) {
			0 ignored issues – show introduced 2021-09-05 20:03 UTC by Report Bug Copy Issue Report The condition `is_null($default)` is always `true`. Loading history...
64			return $default;
65			}
66
67			throw CounterDoesNotExist::create($key);
68			}
69
70			/**
71			* @param $key
72			* @param $value
73			* set the value of the given counter's key
74			*/
75			public function setValue($key, $value)
76			{
77			Counter::query()->where('key', $key)->update(['value' => $value]);
78			}
79
80			/**
81			* @param $key
82			* @param $step
83			* set the step value for a given counter's
84			*/
85			public function setStep($key, $step)
86			{
87			Counter::query()->where('key', $key)->update(['step' => $step]);
88			}
89
90			/**
91			* @param $key
92			* @param null $step
			0 ignored issues – show Documentation Bug introduced 2021-09-05 20:03 UTC by Report Bug Copy Issue Report Are you sure the doc-type for parameter `$step` is correct as it would always require `null` to be passed? Loading history...
93			* @return \Illuminate\Database\Eloquent\Model\|Counters\|null
94			* increment the counter with the step
95			*/
96			public function increment($key, $step = null)
97			{
98			$counter = $this->get($key);
99
100			if ($counter) {
			0 ignored issues – show introduced 2021-09-05 20:03 UTC by Report Bug Copy Issue Report `$counter` is of type `Turahe\Counters\Models\Counter`, thus it always evaluated to `true`. Loading history...
101			$counter->update(['value' => $counter->value + ($step ?? $counter->step)]);
102			}
103
104			return $counter;
105			}
106
107			/**
108			* @param $key
109			* @param null $step
			0 ignored issues – show Documentation Bug introduced 2021-09-05 20:03 UTC by Report Bug Copy Issue Report Are you sure the doc-type for parameter `$step` is correct as it would always require `null` to be passed? Loading history...
110			* @return \Illuminate\Database\Eloquent\Model\|Counters\|null
111			* decrement the counter with the step
112			*/
113			public function decrement($key, $step = null)
114			{
115			$counter = $this->get($key);
116
117			if ($counter) {
			0 ignored issues – show introduced 2021-09-05 20:03 UTC by Report Bug Copy Issue Report `$counter` is of type `Turahe\Counters\Models\Counter`, thus it always evaluated to `true`. Loading history...
118			$counter->update(['value' => $counter->value - ($step ?? $counter->step)]);
119			}
120
121			return $counter;
122			}
123
124			/**
125			* @param $key
126			* @return \Illuminate\Database\Eloquent\Model\|Counters\|null
127			*/
128			public function reset($key)
129			{
130			$counter = $this->get($key);
131
132			if ($counter) {
			0 ignored issues – show introduced 2021-09-05 20:03 UTC by Report Bug Copy Issue Report `$counter` is of type `Turahe\Counters\Models\Counter`, thus it always evaluated to `true`. Loading history...
133			$counter->update(['value' => $counter->initial_value]);
134			}
135
136			return $counter;
137			}
138
139			/**
140			* @param $key
141			* This function will store a cookie for the counter key
142			* If the cookie already exist, the counter will not incremented again
143			* @param null $step
			0 ignored issues – show Documentation Bug introduced 2021-09-05 20:03 UTC by Report Bug Copy Issue Report Are you sure the doc-type for parameter `$step` is correct as it would always require `null` to be passed? Loading history...
144			*/
145			public function incrementIfNotHasCookies($key, $step = null)
146			{
147			$cookieName = $this->getCookieName($key);
148
149			if (! array_key_exists($cookieName, $_COOKIE)) {
150			$this->increment($key, $step);
151			setcookie($cookieName, 1);
152			}
153			}
154
155			/**
156			* @param $key
157			* This function will store a cookie for the counter key
158			* If the cookie already exist, the counter will not decremented again
159			* @param null $step
			0 ignored issues – show Documentation Bug introduced 2021-09-05 20:03 UTC by Report Bug Copy Issue Report Are you sure the doc-type for parameter `$step` is correct as it would always require `null` to be passed? Loading history...
160			*/
161			public function decrementIfNotHasCookies($key, $step = null)
162			{
163			$cookieName = $this->getCookieName($key);
164
165			if (! array_key_exists($cookieName, $_COOKIE)) {
166			$this->decrement($key, $step);
167			setcookie($cookieName, 1);
168			}
169			}
170
171			/**
172			* @param $key
173			* @return string
174			*/
175			private function getCookieName($key)
176			{
177			return 'counters-cookie-'.$key;
178			}
179			}
180

turahe / laravel-counters

Counters::getCookieName() A last analyzed 2023-09-16 10:12 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Counters::getCookieName() A
last analyzed 2023-09-16 10:12 UTC