Limoncello\Crypt\BaseCrypt

Complexity

Total Complexity

7

Size/Duplication

Total Lines	46
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	clearErrors()	0	7	2
A	getErrorMessage()	0	9	3
A	throwException()	0	4	1
A	openSslErrorString()	0	4	1

<?php declare(strict_types=1);

namespace Limoncello\Crypt;

/**
 * Copyright 2015-2019 info@neomerx.com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

use Limoncello\Crypt\Exceptions\CryptException;
use function openssl_error_string;

/**
 * @package Limoncello\Crypt
 */
abstract class BaseCrypt
{
    /**
     * @return void
     */
    protected function clearErrors(): void
    {
        /** @noinspection PhpStatementHasEmptyBodyInspection */
        while ($this->openSslErrorString() !== false) {
            // drop all accumulated error messages if any
        }
    }

    /**
     * @return null|string
     */
    protected function getErrorMessage(): ?string
    {
        $message = null;
        while (($errorLine = $this->openSslErrorString()) !== false) {
            $message .= ($message === null ? $errorLine : PHP_EOL . $errorLine);
        }

        return $message;
    }

    /**
     * @param CryptException $exception
     *
     * @return void

Consider making the return type a bit more specific; maybe use NoType.

     */
    protected function throwException(CryptException $exception): void
    {
        throw $exception;
    }

    /**
     * We need this wrapper for testing purposes so we can mock system call to Open SSL.
     *
     * @return string|false
     */
    protected function openSslErrorString()
    {
        return openssl_error_string();
    }
}