CryptoManana\Core\Traits\MessageDigestion\DerivationSaltingTrait

Complexity

Total Complexity

3

Size/Duplication

Total Lines	29
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	setDerivationSalt()	0	9	2
A	getDerivationSalt()	0	3	1

<?php

/**
 * Trait implementation of the derivation salting capabilities for digestion algorithms.
 */

namespace CryptoManana\Core\Traits\MessageDigestion;

use CryptoManana\Core\Interfaces\MessageDigestion\DerivationSaltingInterface as DerivationSaltingSpecification;

/**
 * Trait SaltingCapabilitiesTrait - Reusable implementation of `DerivationSaltingInterface`.
 *
 * @see \CryptoManana\Core\Interfaces\MessageDigestion\DerivationSaltingInterface The abstract specification.
 *
 * @package CryptoManana\Core\Traits\MessageDigestion
 *
 * @property string $derivationSalt The derivation salt string property storage.
 *
 * @mixin DerivationSaltingSpecification
 */
trait DerivationSaltingTrait
{
    /**
     * Setter for the derivation salt string property.
     *
     * @param string $derivationSalt The derivation salt string.
     *
     * @return $this The hash algorithm object.
     * @throws \Exception Validation errors.
     */
    public function setDerivationSalt($derivationSalt)
    {
        if (!is_string($derivationSalt)) {
            throw new \InvalidArgumentException('The derivation salt must be of type string.');
        }

        $this->derivationSalt = $derivationSalt;

        return $this;
    }

    /**
     * Getter for the derivation salt string property.
     *
     * @return string The derivation salt string.
     */
    public function getDerivationSalt()
    {
        return $this->derivationSalt;
    }
}