Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. SetCookie.php

function SetCookie::validate

Check if the cookie is valid according to RFC 6265.

Return value

bool|string Returns true if valid or an error message if invalid

File

vendor/guzzlehttp/guzzle/src/Cookie/SetCookie.php, line 455

Class

SetCookie
Set-Cookie object

Namespace

GuzzleHttp\Cookie

Code

public function validate() {
    $name = $this->getName();
    if ($name === '') {
        return 'The cookie name must not be empty';
    }
    // Check if any of the invalid characters are present in the cookie name
    if (\preg_match('/[\\x00-\\x20\\x22\\x28-\\x29\\x2c\\x2f\\x3a-\\x40\\x5c\\x7b\\x7d\\x7f]/', $name)) {
        return 'Cookie name must not contain invalid characters: ASCII ' . 'Control characters (0-31;127), space, tab and the ' . 'following characters: ()<>@,;:\\"/?={}';
    }
    // Value must not be null. 0 and empty string are valid. Empty strings
    // are technically against RFC 6265, but known to happen in the wild.
    $value = $this->getValue();
    if ($value === null) {
        return 'The cookie value must not be empty';
    }
    // Domains must not be empty, but can be 0. "0" is not a valid internet
    // domain, but may be used as server name in a private network.
    $domain = $this->getDomain();
    if ($domain === null || $domain === '') {
        return 'The cookie domain must not be empty';
    }
    return true;
}

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal