mirror of
https://github.com/php-flasher/php-flasher.git
synced 2026-03-31 15:07:47 +01:00
Simplify PHPDoc comments in core Prime classes
Removes verbose documentation while preserving type annotations for array parameters and PHPStan type definitions.
This commit is contained in:
@@ -5,8 +5,6 @@ declare(strict_types=1);
|
|||||||
namespace Flasher\Prime;
|
namespace Flasher\Prime;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Type-safe configuration for PHPFlasher.
|
|
||||||
*
|
|
||||||
* @phpstan-type ConfigType array{
|
* @phpstan-type ConfigType array{
|
||||||
* default: string,
|
* default: string,
|
||||||
* main_script?: string,
|
* main_script?: string,
|
||||||
|
|||||||
@@ -10,9 +10,6 @@ use Flasher\Prime\EventDispatcher\EventListener\AttachDefaultStampsListener;
|
|||||||
use Flasher\Prime\EventDispatcher\EventListener\EnvelopeRemovalListener;
|
use Flasher\Prime\EventDispatcher\EventListener\EnvelopeRemovalListener;
|
||||||
use Flasher\Prime\EventDispatcher\EventListener\EventListenerInterface;
|
use Flasher\Prime\EventDispatcher\EventListener\EventListenerInterface;
|
||||||
|
|
||||||
/**
|
|
||||||
* Default implementation of the event dispatcher interface.
|
|
||||||
*/
|
|
||||||
final class EventDispatcher implements EventDispatcherInterface
|
final class EventDispatcher implements EventDispatcherInterface
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -8,8 +8,6 @@ use Flasher\Prime\Notification\FlasherBuilder;
|
|||||||
use Flasher\Prime\Notification\NotificationBuilderInterface;
|
use Flasher\Prime\Notification\NotificationBuilderInterface;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Default implementation of FlasherFactoryInterface.
|
|
||||||
*
|
|
||||||
* @mixin \Flasher\Prime\Notification\FlasherBuilder
|
* @mixin \Flasher\Prime\Notification\FlasherBuilder
|
||||||
*/
|
*/
|
||||||
final class FlasherFactory extends NotificationFactory implements FlasherFactoryInterface
|
final class FlasherFactory extends NotificationFactory implements FlasherFactoryInterface
|
||||||
|
|||||||
@@ -4,41 +4,10 @@ declare(strict_types=1);
|
|||||||
|
|
||||||
namespace Flasher\Prime\Notification;
|
namespace Flasher\Prime\Notification;
|
||||||
|
|
||||||
/**
|
|
||||||
* Type - Constants for standard notification types.
|
|
||||||
*
|
|
||||||
* This class defines the standard notification types supported by PHPFlasher.
|
|
||||||
* Using these constants instead of string literals ensures consistency and
|
|
||||||
* prevents typos when specifying notification types.
|
|
||||||
*/
|
|
||||||
final class Type
|
final class Type
|
||||||
{
|
{
|
||||||
/**
|
|
||||||
* Success notification type.
|
|
||||||
*
|
|
||||||
* Used for positive feedback, successful operations, or completed actions.
|
|
||||||
*/
|
|
||||||
public const SUCCESS = 'success';
|
public const SUCCESS = 'success';
|
||||||
|
|
||||||
/**
|
|
||||||
* Error notification type.
|
|
||||||
*
|
|
||||||
* Used for failures, exceptions, or problems that prevented an operation from completing.
|
|
||||||
*/
|
|
||||||
public const ERROR = 'error';
|
public const ERROR = 'error';
|
||||||
|
|
||||||
/**
|
|
||||||
* Info notification type.
|
|
||||||
*
|
|
||||||
* Used for neutral informational messages, status updates, or helpful tips.
|
|
||||||
*/
|
|
||||||
public const INFO = 'info';
|
public const INFO = 'info';
|
||||||
|
|
||||||
/**
|
|
||||||
* Warning notification type.
|
|
||||||
*
|
|
||||||
* Used for potential issues, alerts, or important notices that don't prevent
|
|
||||||
* an operation but deserve attention.
|
|
||||||
*/
|
|
||||||
public const WARNING = 'warning';
|
public const WARNING = 'warning';
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user