-
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move
MessageBag
and MessageProvider
to contract
from utils
(#…
…5092)
- Loading branch information
1 parent
d0d7965
commit 3d09a3b
Showing
3 changed files
with
107 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,87 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
/** | ||
* This file is part of Hyperf. | ||
* | ||
* @link https://www.hyperf.io | ||
* @document https://hyperf.wiki | ||
* @contact [email protected] | ||
* @license https://github.com/hyperf/hyperf/blob/master/LICENSE | ||
*/ | ||
namespace Hyperf\Contract; | ||
|
||
interface MessageBag | ||
{ | ||
/** | ||
* Get the keys present in the message bag. | ||
*/ | ||
public function keys(): array; | ||
|
||
/** | ||
* Add a message to the bag. | ||
*/ | ||
public function add(string $key, string $message): MessageBag; | ||
|
||
/** | ||
* Merge a new array of messages into the bag. | ||
* | ||
* @param array|MessageProvider $messages | ||
* @return $this | ||
*/ | ||
public function merge($messages); | ||
|
||
/** | ||
* Determine if messages exist for a given key. | ||
* | ||
* @param array|string $key | ||
*/ | ||
public function has($key): bool; | ||
|
||
/** | ||
* Get the first message from the bag for a given key. | ||
*/ | ||
public function first(?string $key = null, ?string $format = null): string; | ||
|
||
/** | ||
* Get all of the messages from the bag for a given key. | ||
*/ | ||
public function get(string $key, ?string $format = null): array; | ||
|
||
/** | ||
* Get all of the messages for every key in the bag. | ||
*/ | ||
public function all(?string $format = null): array; | ||
|
||
/** | ||
* Get the raw messages in the container. | ||
*/ | ||
public function getMessages(): array; | ||
|
||
/** | ||
* Get the default message format. | ||
*/ | ||
public function getFormat(): string; | ||
|
||
/** | ||
* Set the default message format. | ||
* | ||
* @return $this | ||
*/ | ||
public function setFormat(string $format = ':message'); | ||
|
||
/** | ||
* Determine if the message bag has any messages. | ||
*/ | ||
public function isEmpty(): bool; | ||
|
||
/** | ||
* Determine if the message bag has any messages. | ||
*/ | ||
public function isNotEmpty(): bool; | ||
|
||
/** | ||
* Get the number of messages in the container. | ||
*/ | ||
public function count(): int; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
/** | ||
* This file is part of Hyperf. | ||
* | ||
* @link https://www.hyperf.io | ||
* @document https://hyperf.wiki | ||
* @contact [email protected] | ||
* @license https://github.com/hyperf/hyperf/blob/master/LICENSE | ||
*/ | ||
namespace Hyperf\Contract; | ||
|
||
interface MessageProvider | ||
{ | ||
/** | ||
* Get the messages for the instance. | ||
*/ | ||
public function getMessageBag(): MessageBag; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters