nystudio107 / craft-cookies

src/variables/CookiesVariable.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\variables;

use nystudio107\cookies\Cookies;

/**
 * Cookies template variables
 *
 * @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 CookiesVariable
{
    /**

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 {
        Cookies::$plugin->cookies->set(
            $name,
            $value,
            $expire,
            $path,
            $domain,
            $secure,
            $httpOnly,
            $sameSite
        );
    }

    /**

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 Cookies::$plugin->cookies->get($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 {
        Cookies::$plugin->cookies->setSecure(
            $name,
            $value,
            $expire,
            $path,
            $domain,
            $secure,
            $httpOnly,
            $sameSite
        );
    }

    /**

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
    {
        return Cookies::$plugin->cookies->getSecure($name);
    }
}