W3cubDocs

/Laravel 8

HashManager

class HashManager extends Manager implements Hasher (View source)

Properties

protected Container $container The container instance. from Manager
protected Repository $config The configuration repository instance. from Manager
protected array $customCreators The registered custom driver creators. from Manager
protected array $drivers The array of created "drivers". from Manager

Methods

void __construct(Container $container)

Create a new manager instance.

 from Manager
string getDefaultDriver()

Get the default driver name.
mixed driver(string|null $driver = null)

Get a driver instance.

 from Manager
mixed createDriver(string $driver)

Create a new driver instance.

 from Manager
mixed callCustomCreator(string $driver)

Call a custom driver creator.

 from Manager
$this extend(string $driver, Closure $callback)

Register a custom driver creator Closure.

 from Manager
array getDrivers()

Get all of the created "drivers".

 from Manager
mixed __call(string $method, array $parameters)

Dynamically call the default driver instance.

 from Manager
BcryptHasher createBcryptDriver()

Create an instance of the Bcrypt hash Driver.
ArgonHasher createArgonDriver()

Create an instance of the Argon2i hash Driver.
Argon2IdHasher createArgon2idDriver()

Create an instance of the Argon2id hash Driver.
array info(string $hashedValue)

Get information about the given hashed value.
string make(string $value, array $options = [])

Hash the given value.
bool check(string $value, string $hashedValue, array $options = [])

Check the given plain value against a hash.
bool needsRehash(string $hashedValue, array $options = [])

Check if the given hash has been hashed using the given options.

Details

void __construct(Container $container)

Create a new manager instance.

Parameters

Container $container

Return Value

void

string getDefaultDriver()

Get the default driver name.

Return Value

string

mixed driver(string|null $driver = null)

Get a driver instance.

Parameters

string|null $driver

Return Value

mixed

Exceptions

InvalidArgumentException

protected mixed createDriver(string $driver)

Create a new driver instance.

Parameters

string $driver

Return Value

mixed

Exceptions

InvalidArgumentException

protected mixed callCustomCreator(string $driver)

Call a custom driver creator.

Parameters

string $driver

Return Value

mixed

$this extend(string $driver, Closure $callback)

Register a custom driver creator Closure.

Parameters

string $driver
Closure $callback

Return Value

$this

array getDrivers()

Get all of the created "drivers".

Return Value

array

mixed __call(string $method, array $parameters)

Dynamically call the default driver instance.

Parameters

string $method
array $parameters

Return Value

mixed

BcryptHasher createBcryptDriver()

Create an instance of the Bcrypt hash Driver.

Return Value

BcryptHasher

ArgonHasher createArgonDriver()

Create an instance of the Argon2i hash Driver.

Return Value

ArgonHasher

Argon2IdHasher createArgon2idDriver()

Create an instance of the Argon2id hash Driver.

Return Value

Argon2IdHasher

array info(string $hashedValue)

Get information about the given hashed value.

Parameters

string $hashedValue

Return Value

array

string make(string $value, array $options = [])

Hash the given value.

Parameters

string $value
array $options

Return Value

string

bool check(string $value, string $hashedValue, array $options = [])

Check the given plain value against a hash.

Parameters

string $value
string $hashedValue
array $options

Return Value

bool

bool needsRehash(string $hashedValue, array $options = [])

Check if the given hash has been hashed using the given options.

Parameters

string $hashedValue
array $options

Return Value

bool

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Hashing/HashManager.html