Commit b93a1220 authored by Taylor Otwell's avatar Taylor Otwell

commenting validation messages.

parent 3c05f726
...@@ -26,6 +26,11 @@ class Messages { ...@@ -26,6 +26,11 @@ class Messages {
* *
* Duplicate messages will not be added. * 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 $key
* @param string $message * @param string $message
* @return void * @return void
...@@ -52,6 +57,14 @@ class Messages { ...@@ -52,6 +57,14 @@ class Messages {
/** /**
* Get the first message for a given 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 $key
* @param string $format * @param string $format
* @return string * @return string
...@@ -64,6 +77,14 @@ class Messages { ...@@ -64,6 +77,14 @@ class Messages {
/** /**
* Get all of the messages for a key. * 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 $key
* @param string $format * @param string $format
* @return array * @return array
...@@ -78,6 +99,14 @@ class Messages { ...@@ -78,6 +99,14 @@ class Messages {
/** /**
* Get all of the messages for every key. * 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 * @param string $format
* @return array * @return array
*/ */
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment