libraries/src/Input/Cookie.php - 5.4-dev - githubmirror/joomla-cms

libraries/src/Input/Cookie.php
159 строк5 KB
Allon Moritz
[5.3] Remove the reference to the super global (#44867)
16 фев 2025, 03:29
16 фев 2025, 03:297916bb8
<?php

/**
 * Joomla! Content Management System
 *
 * @copyright  (C) 2011 Open Source Matters, Inc. <https://www.joomla.org>
 * @license    GNU General Public License version 2 or later; see LICENSE.txt
 */

namespace Joomla\CMS\Input;

use Joomla\CMS\Filter\InputFilter;

// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects

/**
 * Joomla! Input Cookie Class
 *
 * @since       1.7.0
 *
 * @deprecated   4.3 will be removed in 6.0.
 *               Use Joomla\Input\Cookie instead
 */
class Cookie extends Input
{
    /**
     * Constructor.
     *
     * @param   ?array  $source   Ignored.
     * @param   array   $options  Array of configuration parameters (Optional)
     *
     * @since   1.7.0
     *
     * @deprecated   4.3 will be removed in 6.0.
     *               Use Joomla\Input\Cookie instead
     */
    public function __construct(?array $source = null, array $options = [])
    {
        if (isset($options['filter'])) {
            $this->filter = $options['filter'];
        } else {
            $this->filter = InputFilter::getInstance();
        }

        // Set the data source.
        $this->data = $_COOKIE;

        // Set the options for the class.
        $this->options = $options;
    }

    /**
     * Sets a value
     *
     * @param   string   $name      Name of the value to set.
     * @param   mixed    $value     Value to assign to the input.
     * @param   array    $options   An associative array which may have any of the keys expires, path, domain,
     *                              secure, httponly and samesite. The values have the same meaning as described
     *                              for the parameters with the same name. The value of the samesite element
     *                              should be either Lax or Strict. If any of the allowed options are not given,
     *                              their default values are the same as the default values of the explicit
     *                              parameters. If the samesite element is omitted, no SameSite cookie attribute
     *                              is set.
     *
     * @return  void
     *
     * @link    http://www.ietf.org/rfc/rfc2109.txt
     * @see     setcookie()
     * @since   1.7.0
     *
     * @deprecated   4.3 will be removed in 6.0.
     *               Use Joomla\Input\Cookie instead
     */
    public function set($name, $value, $options = [])
    {
        // BC layer to convert old method parameters.
        if (\is_array($options) === false) {
            trigger_deprecation(
                'joomla/input',
                '1.4.0',
                'The %s($name, $value, $expire, $path, $domain, $secure, $httpOnly) signature is deprecated and'
                . ' will not be supported once support'
                . ' for PHP 7.2 and earlier is dropped, use the %s($name, $value, $options) signature instead',
                __METHOD__,
                __METHOD__
            );

            $argList = \func_get_args();

            $options = [
                'expires'  => $argList[2] ?? 0,
                'path'     => $argList[3] ?? '',
                'domain'   => $argList[4] ?? '',
                'secure'   => $argList[5] ?? false,
                'httponly' => $argList[6] ?? false,
            ];
        }

        // Set the cookie
        if (version_compare(PHP_VERSION, '7.3', '>=')) {
            if (\is_array($value)) {
                foreach ($value as $key => $val) {
                    setcookie($name . "[$key]", $val, $options);
                }
            } else {
                setcookie($name, $value, $options);
            }
        } else {
            // Using the setcookie function before php 7.3, make sure we have default values.
            if (\array_key_exists('expires', $options) === false) {
                $options['expires'] = 0;
            }

            if (\array_key_exists('path', $options) === false) {
                $options['path'] = '';
            }

            if (\array_key_exists('domain', $options) === false) {
                $options['domain'] = '';
            }

            if (\array_key_exists('secure', $options) === false) {
                $options['secure'] = false;
            }

            if (\array_key_exists('httponly', $options) === false) {
                $options['httponly'] = false;
            }

            if (\is_array($value)) {
                foreach ($value as $key => $val) {
                    setcookie(
                        $name . "[$key]",
                        $val,
                        $options['expires'],
                        $options['path'],
                        $options['domain'],
                        $options['secure'],
                        $options['httponly']
                    );
                }
            } else {
                setcookie(
                    $name,
                    $value,
                    $options['expires'],
                    $options['path'],
                    $options['domain'],
                    $options['secure'],
                    $options['httponly']
                );
            }
        }

        $this->data[$name] = $value;
    }
}