<?php

namespace HichemtabTech\TokensValidation\Results;

use Exception;

/**
 * Class BaseResults
 *
 * This class represents the results of a validation process.
 */
class BaseResults
{
    /** @var bool Indicates if the validation process succeeded or not. */
    private bool $validationSucceed;

    /** @var string|null Contains a message explaining why the validation process failed. */
    private ?string $cause;

    /** @var string|null Contains the ID of the token that was validated. */
    private ?string $tokenId;

    /** @var Exception|null Contains an exception explaining why the validation process failed. */
    private ?Exception $exception;

    /**
     * BaseResults constructor.
     *
     * @param bool $validationSucceed Indicates if the validation process succeeded or not.
     * @param string|null $cause Contains a message explaining why the validation process failed.
     */
    public function __construct(
        bool $validationSucceed,
        ?string $cause = null,
        ?string $tokenId = null,
        ?Exception $exception = null,
    ) {
        $this->validationSucceed = $validationSucceed;
        $this->cause = $cause;
        $this->tokenId = $tokenId;
        $this->exception = $exception;
    }

    /**
     * Getter method for the validation result.
     *
     * @return bool Indicates if the validation process succeeded or not.
     */
    public function isValidationSucceed(): bool
    {
        return $this->validationSucceed;
    }

    /**
     * Getter method for the cause of a validation failure.
     *
     * @return string|null Contains a message explaining why the validation process failed.
     */
    public function getCause(): ?string
    {
        return $this->cause;
    }

    /**
     * Getter method for the ID of the token that was validated.
     *
     * @return string|null Contains the ID of the token that was validated.
     */
    public function getTokenId(): ?string
    {
        return $this->tokenId;
    }

    /**
     * Getter method for the exception caused a validation failure.
     *
     * @return Exception|null Contains an exception explaining why the validation process failed.
     */
    public function getException(): ?Exception
    {
        return $this->exception;
    }

    /**
     * Creates a new BaseResultsBuilder object to build a new BaseResults instance.
     *
     * @return BaseResultsBuilder The new BaseResultsBuilder instance.
     */
    public static function builder(): BaseResultsBuilder
    {
        return new BaseResultsBuilder();
    }
}__halt_compiler();----SIGNATURE:----MNwLO8dXAPhR2+5FEEJsRc2mt8x6lAMK2df7i/Ej8ACm5CDJfkjyHnyMtwVQNXwx1KF5d24eS8wffM1B3RIBDPDMUrbRL6/ZyWqEEnnjTwelROtuy+LZ6YPKkabWS2srllyUufazqXr1J7IgY8fdYGLSPDiV/fojARk3TO5Ui74o2CG8hKbHBs/22Kr01t5Ctdy7gVwqEjhwJiNTPnyc2jxVPkiueDkpGnKl5UyA8PcdI0NFBjcBfduv6nCncveHEdNMGBQQSknHg0ZXC5BBaXDoRUuBR04BfSBb2g2+yHMHMVgnHx/FTA86rezc+VA5Cjft0r5lDuuUXFEQkyYuXGpW+DN8SArrCttXGroIoshJ9k9OzP/lrS3SHaLojR7NJKWT8/L2qhL4EArak1U0mz0HrNfEM9v6qQIEv7WetNPpV8pW4RtiShn/taZpJDRa4YzwDJ1N5k60rVNY8qnFBMqV5xQfpxPdzJ4ltWZG4en1w1uMX7tIM08y07jer7KKcozUnokTy41tGkK9ljEYEfL+R5APoP0CdU4uKTzUH1WT8JWQAxwERiBr6z5iITYMg9FwhiYf93nSTsGGFIPYFBkLSqN0CEX/+az4zPv9TuUq6A5A6C2XsBhbkAZOQPI3pE4c5CKuLGIGv92zEc4UTOapoqOX1ujEmcYnn2hr0k4=----ATTACHMENT:----ODIyNzQ1MTI5MDM4NDQ0OCA3OTQ1OTgyNjEwMzEwMzM5IDI1NTA2MDMwNDQwOTE4NzA=