nystudio107 / craft-cookies

src/services/CookiesService.php

<?php

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

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) nystudio107

@copyright tag must contain a year and the name of the copyright holder

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

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

namespace nystudio107\cookies\services;

use Craft;
use craft\base\Component;
use yii\base\Exception;
use yii\base\InvalidConfigException;
use yii\web\Cookie;

/**
 * Cookies service
 *
 * @author    nystudio107

The tag in position 1 should be the @package tag

Content of the @author tag must be in the form "Display Name <username@example.com>"

Tag value for @author tag indented incorrectly; expected 2 spaces but found 4

 * @package   Cookies

Tag value for @package tag indented incorrectly; expected 1 spaces but found 3

 * @since     1.1.0

The tag in position 3 should be the @author tag

Tag value for @since tag indented incorrectly; expected 3 spaces but found 5

 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class CookiesService extends Component
{
    /**

Parameter $name should have a doc-comment as per coding-style.

Parameter $value should have a doc-comment as per coding-style.

Parameter $expire should have a doc-comment as per coding-style.

Parameter $path should have a doc-comment as per coding-style.

Parameter $domain should have a doc-comment as per coding-style.

Parameter $secure should have a doc-comment as per coding-style.

Parameter $httpOnly should have a doc-comment as per coding-style.

Parameter $sameSite should have a doc-comment as per coding-style.

     * Set a cookie
     */

Missing @return tag in function comment

    public function set(
        string $name = '',
        string $value = '',
        int    $expire = 0,
        string $path = '/',
        string $domain = '',
        bool   $secure = false,
        bool   $httpOnly = false,
        string $sameSite = 'Lax',
    ): void {
        if (empty($value)) {
            Craft::$app->response->cookies->remove($name);
        } else {
            $domain = empty($domain) ? Craft::$app->getConfig()->getGeneral()->defaultCookieDomain : $domain;
            if (PHP_VERSION_ID >= 70300) {
                setcookie($name, $value, [

The opening parenthesis of a multi-line function call should be the last content on the line.

                    'expires' => $expire,
                    'path' => $path,
                    'domain' => $domain,
                    'secure' => $secure,
                    'httponly' => $httpOnly,
                    'samesite' => $sameSite,
                ]);

For multi-line function calls, the closing parenthesis should be on a new line.

            } else {
                setcookie($name, $value, ['expires' => $expire, 'path' => $path, 'domain' => $domain, 'secure' => $secure, 'httponly' => $httpOnly]);
            }

            $_COOKIE[$name] = $value;
        }
    }

    /**

Parameter $name should have a doc-comment as per coding-style.

     * Get a cookie
     */

Missing @return tag in function comment

    public function get(string $name = ''): string
    {
        return $_COOKIE[$name] ?? '';
    }

    /**

Parameter $name should have a doc-comment as per coding-style.

Parameter $value should have a doc-comment as per coding-style.

Parameter $expire should have a doc-comment as per coding-style.

Parameter $path should have a doc-comment as per coding-style.

Parameter $domain should have a doc-comment as per coding-style.

Parameter $secure should have a doc-comment as per coding-style.

Parameter $httpOnly should have a doc-comment as per coding-style.

Parameter $sameSite should have a doc-comment as per coding-style.

     * Set a secure cookie
     */

Missing @return tag in function comment

    public function setSecure(
        string $name = '',
        string $value = '',
        int    $expire = 0,
        string $path = '/',
        string $domain = '',
        bool   $secure = false,
        bool   $httpOnly = false,
        string $sameSite = 'Lax',
    ): void {
        if (empty($value)) {
            Craft::$app->response->cookies->remove($name);
        } else {
            $domain = empty($domain) ? Craft::$app->getConfig()->getGeneral()->defaultCookieDomain : $domain;
            $cookie = new Cookie(['name' => $name, 'value' => '']);

            try {
                $cookie->value = Craft::$app->security->hashData(base64_encode(serialize($value)));

The call to yii\base\Security::hashData() has too few arguments starting with key.

            } catch (InvalidConfigException|Exception $e) {
                Craft::error(
                    'Error setting secure cookie: ' . $e->getMessage(),
                    __METHOD__
                );

                return;
            }

            $cookie->expire = $expire;
            $cookie->path = $path;
            $cookie->domain = $domain;
            $cookie->secure = $secure;
            $cookie->httpOnly = $httpOnly;
            if (PHP_VERSION_ID >= 70300) {
                $cookie->sameSite = $sameSite;
            }

            Craft::$app->response->cookies->add($cookie);
        }
    }

    /**

Parameter $name should have a doc-comment as per coding-style.

     * Get a secure cookie
     */

Missing @return tag in function comment

    public function getSecure(string $name = ''): string
    {
        $result = '';
        $cookie = Craft::$app->request->cookies->get($name);
        if ($cookie !== null) {
            try {
                $data = Craft::$app->security->validateData($cookie->value);

The call to yii\base\Security::validateData() has too few arguments starting with key.

            } catch (InvalidConfigException|Exception $e) {
                Craft::error(
                    'Error getting secure cookie: ' . $e->getMessage(),
                    __METHOD__
                );
                $data = false;
            }

            if (

First condition of a multi-line IF statement must directly follow the opening parenthesis

                !empty($cookie->value)

Each line in a multi-line IF statement must begin with a boolean operator

                && $data !== false
            ) {
                $result = unserialize(base64_decode($data), ['allowed_classes' => false]);
            }
        }

        return $result;
    }
}