XMF Cookbook
Search
K

KeyFactory

The Xmf\Jwt\KeyFactory class is a factory used to build key objects for use in a JsonWebToken object.

KeyFactory:build($keyName, $storage = null)

Returns a Xmf\Key\Basic key object for JWT use based on default choices. If the key, specified by name in $keyName, has not been established, it will be created.
The $keyName key name is a string, the symbolic name of the key to use. The $keyName uniquely identifies a key in a key store, as defined by the interface Xmf\Key\StorageInterface. The key name should relate to a specific application action, or a closely related set of actions.
If specified, $storage should be an instance of Xmf\Key\StorageInterface. If null a default FileStorage instance will be used.