nystudio107 / craft-cookies

src/twigextensions/CookiesTwigExtension.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\twigextensions;

use nystudio107\cookies\Cookies;
use Twig\Extension\AbstractExtension;
use Twig\TwigFilter;
use Twig\TwigFunction;

/**
 * Cookies twig extension
 *
 * @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 CookiesTwigExtension extends AbstractExtension
{
    /**
     * Return our Twig Extension name
     */

Missing @return tag in function comment

    public function getName(): string
    {
        return 'Cookies';
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function getFilters(): array
    {
        return [
            new TwigFilter('setCookie', fn(string $name = "", string $value = "", int $expire = 0, string $path = "/", string $domain = "", bool $secure = false, bool $httpOnly = false, string $sameSite = 'Lax') => $this->setCookie($name, $value, $expire, $path, $domain, $secure, $httpOnly, $sameSite)),
            new TwigFilter('getCookie', fn($name) => $this->getCookie($name)),
            new TwigFilter('setSecureCookie', fn(string $name = "", string $value = "", int $expire = 0, string $path = "/", string $domain = "", bool $secure = false, bool $httpOnly = false, string $sameSite = 'Lax') => $this->setSecureCookie($name, $value, $expire, $path, $domain, $secure, $httpOnly, $sameSite)),
            new TwigFilter('getSecureCookie', fn($name) => $this->getSecureCookie($name)),
        ];
    }

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public function getFunctions(): array
    {
        return [
            new TwigFunction('setCookie', fn(string $name = "", string $value = "", int $expire = 0, string $path = "/", string $domain = "", bool $secure = false, bool $httpOnly = false, string $sameSite = 'Lax') => $this->setCookie($name, $value, $expire, $path, $domain, $secure, $httpOnly, $sameSite)),
            new TwigFunction('getCookie', fn($name) => $this->getCookie($name)),
            new TwigFunction('setSecureCookie', fn(string $name = "", string $value = "", int $expire = 0, string $path = "/", string $domain = "", bool $secure = false, bool $httpOnly = false, string $sameSite = 'Lax') => $this->setSecureCookie($name, $value, $expire, $path, $domain, $secure, $httpOnly, $sameSite)),
            new TwigFunction('getSecureCookie', fn($name) => $this->getSecureCookie($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 cookie
     */

Missing @return tag in function comment

    public function setCookie(
        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 getCookie(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 setSecureCookie(
        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 getSecureCookie(string $name): string
    {
        return Cookies::$plugin->cookies->getSecure($name);
    }
}