Class flHttpClientCookie

flHttpClientCookie Class

Class to hold a single cookie.

Package: fusionLib
Copyright: Copyright (c) 2007 - 2016 fusionLib. All rights reserved.
Located at system/libs/Http/flHttpClient.php

Methods summary

`public`	# `__construct( string $name, string $value, string $domain, integer $expires = null, string $path = null, boolean $secure = false )` Construct the cookie. Construct the cookie. Parameters `$name` The name of the cookie. `$value` The value for the cookie. `$domain` The domain the cookie belongs to. `$expires` The timestamp of when the cookie expires or null to never expire. `$path` The path for the cookie. `$secure` true if the cookie should only be used over https connections or false.
`public static flHttpClientCookie`	# `parseCookie( string $domain, string $cookie )` Parse the raw cookie data sent from the server and store the cookie. Parse the raw cookie data sent from the server and store the cookie. Parameters `$domain` The current domain name `$cookie` The raw cookie data Returns `flHttpClientCookie` The cookie object for the data.
`public boolean`	# `isExpired( )` Test if the cookie has expired. Test if the cookie has expired. Returns boolean true if the cookie has expired; else false.
`public string`	# `getDomain( )` Get the domain name. Get the domain name. Returns string The domain name.
`public integer`	# `getExpires( )` Get the time the cookie expires. Get the time the cookie expires. Returns integer Unix timestamp of the time the cookie expires or null.
`public string`	# `getName( )` Get the name of the cookie. Get the name of the cookie. Returns string The cookie name.
`public string`	# `getPath( )` Get the path for the cookie. Get the path for the cookie. Returns string The path.
`public boolean`	# `getSecure( )` Get if the cookie is secure. Get if the cookie is secure. Returns boolean true if the cookie is secure, else false.
`public string`	# `getValue( )` Get the value of the cookie. Get the value of the cookie. Returns string The value.
`public string`	# `__toString( )` Get the cookie as a string suitable for sending to the server. Get the cookie as a string suitable for sending to the server. Returns string The cookie as a string.
`public boolean`	# `matches( string $domain, string $path, boolean $secure )` Tests if the cookie matches the given domain, path and secure settings. Tests if the cookie matches the given domain, path and secure settings. Parameters `$domain` The domain to match against. `$path` The path to match against. `$secure` The secure settings. Returns boolean true if the cookie matches the given path else false.