Unique token generator/validator. More...

Inheritance diagram for Token:

Public Member Functions
	generate ($context=null, $ttl=null)
	Generate a token. More...

	valid ($token, $context=null)
	Check if a token is (still) valid. More...

	delete ($token)
	Delete a token. More...

Public Member Functions inherited from Component
	__construct ($fred, $config=null)

	__destruct ()

	clientConfig ()
	Public configuration. More...

	config ($key, $default=null)
	Retrieve a config value. More...

	ping ()
	Ping function. More...

	filemtime ($filename)
	Filemtime with session cache. More...

	component ($name)
	Get a component (local or default). More...

	components (... $names)
	Get multiple components in an array. More...

Public Member Functions inherited from Thing
	propertyExists ($property)
	Check if a property exists (public or published). More...

	constants ($prefix=null)
	Return all constants. More...

	get ($key)
	Get one or more properties. More...

	set ($key, $value=null)
	Set one or more properties. More...

	__get ($key)

	__set ($key, $value)

Data Fields
	$length = 50

Data Fields inherited from Component
	$filemtimeTtl = 0

Data Fields inherited from Thing
const	HIDDEN = 0
	Property is hidden. More...

const	READABLE = 1
	Property is readable. More...

const	WRITEABLE = 2
	Property is writeable. More...

const	READWRITE = 3
	Property is readable and writeable. More...

Protected Member Functions
	hash ($context, $token)

Protected Member Functions inherited from Component
	init ()

	done ()

	getSession ()

Protected Member Functions inherited from Thing
	publish ($property, $visibility=self::READABLE)
	Publish a property (or hide it again). More...

	configure ($config)
	Configure the object. More...

	_get ($key)
	Default getter if no specific setter is defined, and the property is also not published (readable). More...

	_set ($key, $value)
	Default setter if no specific setter is defined, and the property is also not published (writeable). More...

Additional Inherited Members
Protected Attributes inherited from Component
	$_fred = null

	$_config = null

	$_name = null

	$_components = []
	Local components (key = component name, value = component). More...

	$_session = null

Protected Attributes inherited from Thing
	$_published = []
	Published properties (key = name of property, value = visibility). More...

Detailed Description

Unique token generator/validator.

Definition at line 8 of file Token.php.

Member Function Documentation

◆ delete()

delete ( $token )

Delete a token.

Returns: bool True on success.

Definition at line 53 of file Token.php.

◆ generate()

generate	(	$context = `null`,
		$ttl = `null`
	)

Generate a token.

Parameters

mixed	$context	Context for the token.
int	$ttl	Time-to-live in seconds (empty = indefinitely).

Returns: string Random token for this context.

Definition at line 21 of file Token.php.

◆ hash()

hash	(	$context,
		$token
	)

protected

Definition at line 12 of file Token.php.

◆ valid()

valid	(	$token,
		$context = `null`
	)

Check if a token is (still) valid.

Parameters

string	$token	Token to check.
mixed	$context	Context for the token.

Returns: bool True if the token is valid.

Definition at line 32 of file Token.php.

Field Documentation

◆ $length

$length = 50

Definition at line 10 of file Token.php.

The documentation for this class was generated from the following file:

/var/www/fred.local/vendor/rsi/fred/src/Rsi/Fred/Token.php

Public Member Functions

Data Fields

Protected Member Functions

Additional Inherited Members