commenting validation messages.

This commit is contained in:
Taylor Otwell 2011-09-28 22:42:28 -05:00
parent 3c05f7260c
commit b93a12209c
1 changed files with 29 additions and 0 deletions

View File

@ -26,6 +26,11 @@ public function __construct($messages = array())
*
* Duplicate messages will not be added.
*
* <code>
* // Add a message to the collector for the "email" attribute
* $messages->add('email', 'The e-mail address is invalid.');
* </code>
*
* @param string $key
* @param string $message
* @return void
@ -52,6 +57,14 @@ public function has($key)
/**
* Get the first message for a given key.
*
* <code>
* // Get the first message for the e-mail attribute
* $email = $messages->first('email');
*
* // Format the first message for the e-mail attribute
* $email = $messages->first('email', '<p>:message</p>');
* </code>
*
* @param string $key
* @param string $format
* @return string
@ -64,6 +77,14 @@ public function first($key, $format = ':message')
/**
* Get all of the messages for a key.
*
* <code>
* // Get all of the messages for the e-mail attribute
* $email = $messages->get('email');
*
* // Format all of the messages for the e-mail attribute
* $email = $messages->get('email', '<p>:message</p>');
* </code>
*
* @param string $key
* @param string $format
* @return array
@ -78,6 +99,14 @@ public function get($key = null, $format = ':message')
/**
* Get all of the messages for every key.
*
* <code>
* // Get all of the messages in the collector
* $all = $messages->all();
*
* // Format all of the messages in the collector
* $all = $messages->all('<p>:message</p>');
* </code>
*
* @param string $format
* @return array
*/