petrknap/shorts

Set of short PHP helpers

v3.0.0 2024-11-02 11:23 UTC

Requires

• php: >=8.1

Requires (Dev)

• ext-zlib: *
• nunomaduro/phpinsights: ^2.11
• phpstan/phpstan: ^1.12
• phpunit/phpunit: ^10.5
• squizlabs/php_codesniffer: ^3.7

Suggests

• phpunit/phpunit: Required by PHP Unit helpers

Conflicts

• phpunit/phpunit: <9|>=12

LGPL-3.0-or-later

• phpunit
• markdown
• array
• helper

README

• Exceptions
  • CouldNotProcessData template
  • NotImplemented
• HasRequirements trait

Exception\CouldNotProcessData template

Template for an exception that indicates that the data could not be processed.

namespace PetrKnap\Shorts;

interface ImageResizerException extends \Throwable {}

/** @extends Exception\CouldNotProcessData<string> */
final class ImageResizerCouldNotResizeImage extends Exception\CouldNotProcessData implements ImageResizerException {}

final class ImageResizer {
    public function resize(string $image) {
        throw new ImageResizerCouldNotResizeImage(__METHOD__, $image);
    }
}

Exception\NotImplemented

Simple exception for prototyping purposes.

namespace PetrKnap\Shorts;

final class StringablePrototype implements \Stringable {
    public function __toString(): string {
        Exception\NotImplemented::throw(__METHOD__);
    }
}

HasRequirements trait

Simple trait to check if requirements of your code are fulfilled.

namespace PetrKnap\Shorts;

final class ServiceWithRequirements {
    use HasRequirements;
    
    public function __construct() {
        self::checkRequirements(functions: ['required_function']);
    }

    public function do(): void {
        required_function();
    }
}

It should not replace Composers requires, but it could improve them and check suggests.

Run composer require petrknap/shorts to install it. You can support this project via donation. The project is licensed under the terms of the LGPL-3.0-or-later.