CookiesVariable::get() - Code Metrics - nystudio107/craft-cookies - Measure and Improve Code Quality continuously with Scrutinizer

CookiesVariable::get() A
last analyzed 2024-04-15 18:12 UTC

↳ Parent: CookiesVariable

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

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

<?php

/**
 * Cookies plugin for Craft CMS
 *
 * @link      https://nystudio107.com/

 * @copyright Copyright (c) nystudio107

 * @license   MIT License https://opensource.org/licenses/MIT
 */


namespace nystudio107\cookies\variables;

use nystudio107\cookies\Cookies;

/**
 * Cookies template variables
 *
 * @author    nystudio107

 * @package   Cookies

 * @since     1.1.0

 */

class CookiesVariable
{
    /**

     * Set a cookie
     */

    public function set(
        string $name = "",
        string $value = "",
        int    $expire = 0,
        string $path = "/",
        string $domain = "",
        bool   $secure = false,
        bool   $httpOnly = false,
        string $sameSite = 'Lax',
    ): void {
        Cookies::$plugin->cookies->set(
            $name,
            $value,
            $expire,
            $path,
            $domain,
            $secure,
            $httpOnly,
            $sameSite
        );
    }

    /**

     * Get a cookie
     */

    public function get(string $name): string
    {
        return Cookies::$plugin->cookies->get($name);
    }

    /**

     * Set a secure cookie
     */

    public function setSecure(
        string $name = "",
        string $value = "",
        int    $expire = 0,
        string $path = "/",
        string $domain = "",
        bool   $secure = false,
        bool   $httpOnly = false,
        string $sameSite = 'Lax',
    ): void {
        Cookies::$plugin->cookies->setSecure(
            $name,
            $value,
            $expire,
            $path,
            $domain,
            $secure,
            $httpOnly,
            $sameSite
        );
    }

    /**

     * Get a secure cookie
     */

    public function getSecure(string $name): string
    {
        return Cookies::$plugin->cookies->getSecure($name);
    }
}


1			<?php
2
3			/**
4			* Cookies plugin for Craft CMS
5			*
6			* @link https://nystudio107.com/
			0 ignored issues – show Coding Style introduced 2018-11-19 22:08 UTC by Report Bug Copy Issue Report The tag in position 1 should be the @copyright tag Loading history...
7			* @copyright Copyright (c) nystudio107
			0 ignored issues – show Coding Style introduced 2018-11-19 22:08 UTC by Report Bug Copy Issue Report @copyright tag must contain a year and the name of the copyright holder Loading history...
8			* @license MIT License https://opensource.org/licenses/MIT
9			*/
			0 ignored issues – show Coding Style introduced 2018-11-19 22:08 UTC by Report Bug Copy Issue Report PHP version not specified Loading history... Coding Style introduced 2018-11-19 22:08 UTC by Report Bug Copy Issue Report Missing @category tag in file comment Loading history... Coding Style introduced 2018-11-19 22:08 UTC by Report Bug Copy Issue Report Missing @package tag in file comment Loading history... Coding Style introduced 2018-11-19 22:08 UTC by Report Bug Copy Issue Report Missing @author tag in file comment Loading history...
10
11			namespace nystudio107\cookies\variables;
12
13			use nystudio107\cookies\Cookies;
14
15			/**
16			* Cookies template variables
17			*
18			* @author nystudio107
			0 ignored issues – show Coding Style introduced 2018-11-19 22:08 UTC by Report Bug Copy Issue Report The tag in position 1 should be the @package tag Loading history... Coding Style introduced 2018-11-19 22:08 UTC by Report Bug Copy Issue Report Content of the @author tag must be in the form "Display Name <[email protected]>" Loading history... Coding Style introduced 2019-08-21 13:04 UTC by Report Bug Copy Issue Report Tag value for @author tag indented incorrectly; expected 2 spaces but found 4 Loading history...
19			* @package Cookies
			0 ignored issues – show Coding Style introduced 2019-08-21 13:04 UTC by Report Bug Copy Issue Report Tag value for @package tag indented incorrectly; expected 1 spaces but found 3 Loading history...
20			* @since 1.1.0
			0 ignored issues – show Coding Style introduced 2018-11-19 22:08 UTC by Report Bug Copy Issue Report The tag in position 3 should be the @author tag Loading history... Coding Style introduced 2019-08-21 13:04 UTC by Report Bug Copy Issue Report Tag value for @since tag indented incorrectly; expected 3 spaces but found 5 Loading history...
21			*/
			0 ignored issues – show Coding Style introduced 2018-11-19 22:08 UTC by Report Bug Copy Issue Report Missing @category tag in class comment Loading history... Coding Style introduced 2018-11-19 22:08 UTC by Report Bug Copy Issue Report Missing @license tag in class comment Loading history... Coding Style introduced 2018-11-19 22:08 UTC by Report Bug Copy Issue Report Missing @link tag in class comment Loading history...
22			class CookiesVariable
23			{
24			/**
			0 ignored issues – show Coding Style introduced 2024-02-13 03:49 UTC by Report Bug Copy Issue Report Parameter `$name` should have a doc-comment as per coding-style. Loading history... Coding Style introduced 2024-02-13 03:49 UTC by Report Bug Copy Issue Report Parameter `$value` should have a doc-comment as per coding-style. Loading history... Coding Style introduced 2024-02-13 03:49 UTC by Report Bug Copy Issue Report Parameter `$expire` should have a doc-comment as per coding-style. Loading history... Coding Style introduced 2024-02-13 03:49 UTC by Report Bug Copy Issue Report Parameter `$path` should have a doc-comment as per coding-style. Loading history... Coding Style introduced 2024-02-13 03:49 UTC by Report Bug Copy Issue Report Parameter `$domain` should have a doc-comment as per coding-style. Loading history... Coding Style introduced 2024-02-13 03:49 UTC by Report Bug Copy Issue Report Parameter `$secure` should have a doc-comment as per coding-style. Loading history... Coding Style introduced 2024-02-13 03:49 UTC by Report Bug Copy Issue Report Parameter `$httpOnly` should have a doc-comment as per coding-style. Loading history... Coding Style introduced 2024-02-13 03:49 UTC by Report Bug Copy Issue Report Parameter `$sameSite` should have a doc-comment as per coding-style. Loading history...
25			* Set a cookie
26			*/
			0 ignored issues – show Coding Style introduced 2024-02-13 03:49 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
27			public function set(
28			string $name = "",
29			string $value = "",
30			int $expire = 0,
31			string $path = "/",
32			string $domain = "",
33			bool $secure = false,
34			bool $httpOnly = false,
35			string $sameSite = 'Lax',
36			): void {
37			Cookies::$plugin->cookies->set(
38			$name,
39			$value,
40			$expire,
41			$path,
42			$domain,
43			$secure,
44			$httpOnly,
45			$sameSite
46			);
47			}
48
49			/**
			0 ignored issues – show Coding Style introduced 2024-02-13 03:49 UTC by Report Bug Copy Issue Report Parameter `$name` should have a doc-comment as per coding-style. Loading history...
50			* Get a cookie
51			*/
			0 ignored issues – show Coding Style introduced 2024-02-13 03:49 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
52			public function get(string $name): string
53			{
54			return Cookies::$plugin->cookies->get($name);
55			}
56
57			/**
			0 ignored issues – show Coding Style introduced 2024-02-13 03:49 UTC by Report Bug Copy Issue Report Parameter `$name` should have a doc-comment as per coding-style. Loading history... Coding Style introduced 2024-02-13 03:49 UTC by Report Bug Copy Issue Report Parameter `$value` should have a doc-comment as per coding-style. Loading history... Coding Style introduced 2024-02-13 03:49 UTC by Report Bug Copy Issue Report Parameter `$expire` should have a doc-comment as per coding-style. Loading history... Coding Style introduced 2024-02-13 03:49 UTC by Report Bug Copy Issue Report Parameter `$path` should have a doc-comment as per coding-style. Loading history... Coding Style introduced 2024-02-13 03:49 UTC by Report Bug Copy Issue Report Parameter `$domain` should have a doc-comment as per coding-style. Loading history... Coding Style introduced 2024-02-13 03:49 UTC by Report Bug Copy Issue Report Parameter `$secure` should have a doc-comment as per coding-style. Loading history... Coding Style introduced 2024-02-13 03:49 UTC by Report Bug Copy Issue Report Parameter `$httpOnly` should have a doc-comment as per coding-style. Loading history... Coding Style introduced 2024-02-13 03:49 UTC by Report Bug Copy Issue Report Parameter `$sameSite` should have a doc-comment as per coding-style. Loading history...
58			* Set a secure cookie
59			*/
			0 ignored issues – show Coding Style introduced 2024-02-13 03:49 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
60			public function setSecure(
61			string $name = "",
62			string $value = "",
63			int $expire = 0,
64			string $path = "/",
65			string $domain = "",
66			bool $secure = false,
67			bool $httpOnly = false,
68			string $sameSite = 'Lax',
69			): void {
70			Cookies::$plugin->cookies->setSecure(
71			$name,
72			$value,
73			$expire,
74			$path,
75			$domain,
76			$secure,
77			$httpOnly,
78			$sameSite
79			);
80			}
81
82			/**
			0 ignored issues – show Coding Style introduced 2018-11-19 22:08 UTC by Report Bug Copy Issue Report Parameter `$name` should have a doc-comment as per coding-style. Loading history...
83			* Get a secure cookie
84			*/
			0 ignored issues – show Coding Style introduced 2024-02-13 03:49 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
85			public function getSecure(string $name): string
86			{
87			return Cookies::$plugin->cookies->getSecure($name);
88			}
89			}
90

nystudio107 / craft-cookies

CookiesVariable::get() A last analyzed 2024-04-15 18:12 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

CookiesVariable::get() A
last analyzed 2024-04-15 18:12 UTC