LuhnAlgorithmInterface.php

<?php

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2021 Niklas Ekman
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

declare(strict_types=1);

namespace Nekman\LuhnAlgorithm\Contract;

use Nekman\LuhnAlgorithm\Exceptions\MissingCheckDigitException;

/**
 * Handles the Luhn Algorithm.
 *
 * @link http://en.wikipedia.org/wiki/Luhn_algorithm
 */
interface LuhnAlgorithmInterface
{
    /**
     * Determine if a number is valid according to the Luhn Algorithm.
     * @param NumberInterface $number The number to validate.
     * @throws MissingCheckDigitException If the check digit in the number is not set.
     * @throws LuhnAlgorithmExceptionInterface
     * @return bool true if number is valid, false otherwise.
     */
    public function isValid(NumberInterface $number): bool;

    /**
     * Calculate the check digit for an input.
     * @param NumberInterface $number The number to calculate the check digit for.
     * @throws LuhnAlgorithmExceptionInterface
     * @return int The check digit.
     */
    public function calcCheckDigit(NumberInterface $number): int;

    /**
     * Calculates the checksum for number.
     * @param NumberInterface $number The number to calculate the checksum for.
     * @throws LuhnAlgorithmExceptionInterface
     * @return int The checksum.
     */
    public function calcChecksum(NumberInterface $number): int;
}