class RandomGenerator (View source)

Convenience class for generating cryptographically secure pseudo-random strings/tokens

Traits

A class that can be instantiated or replaced via DI

Methods

public static 
create(mixed ...$args)

An implementation of the factory method, allows you to create an instance of a class

public static 
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

public
string
randomToken(string $algorithm = 'whirlpool')

Generates a random token that can be used for session IDs, CSRF tokens etc., based on hash algorithms.

Details

static Injectable create(mixed ...$args)

An implementation of the factory method, allows you to create an instance of a class

This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.

This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();

Parameters

mixed ...$args

Return Value

Injectable

static Injectable singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).

Parameters

string $class

Optional classname to create, if the called class should not be used

Return Value

Injectable

The singleton instance

string randomToken(string $algorithm = 'whirlpool')

Generates a random token that can be used for session IDs, CSRF tokens etc., based on hash algorithms.

If you are using it as a password equivalent (e.g. autologin token) do NOT store it in the database as a plain text but encrypt it with Member::encryptWithUserSettings.

Parameters

string $algorithm

Any identifier listed in hash_algos() (Default: whirlpool)

Return Value

string

Returned length will depend on the used $algorithm

Exceptions

Exception