Code Coverage |
||||||||||
Classes and Traits |
Functions and Methods |
Lines |
||||||||
| Total | |
0.00% |
0 / 1 |
|
0.00% |
0 / 3 |
CRAP | |
0.00% |
0 / 23 |
| StatusMessages | |
0.00% |
0 / 1 |
|
0.00% |
0 / 3 |
12 | |
0.00% |
0 / 23 |
| getInfo | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 7 |
|||
| generatePlaceholder | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 6 |
|||
| renderMessages | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 10 |
|||
| <?php | |
| /** | |
| * @file | |
| * Contains \Drupal\Core\Render\Element\StatusMessages. | |
| */ | |
| namespace Drupal\Core\Render\Element; | |
| /** | |
| * Provides a messages element. | |
| * | |
| * Used to display results of drupal_set_message() calls. | |
| * | |
| * Usage example: | |
| * @code | |
| * $build['status_messages'] = [ | |
| * '#type' => 'status_messages', | |
| * ]; | |
| * @end | |
| * | |
| * @RenderElement("status_messages") | |
| */ | |
| class StatusMessages extends RenderElement { | |
| /** | |
| * {@inheritdoc} | |
| * | |
| * Generate the placeholder in a #pre_render callback, because the hash salt | |
| * needs to be accessed, which may not yet be available when this is called. | |
| */ | |
| public function getInfo() { | |
| return [ | |
| // May have a value of 'status' or 'error' when only displaying messages | |
| // of that specific type. | |
| '#display' => NULL, | |
| '#pre_render' => [ | |
| get_class() . '::generatePlaceholder', | |
| ], | |
| ]; | |
| } | |
| /** | |
| * #pre_render callback to generate a placeholder. | |
| * | |
| * @param array $element | |
| * A renderable array. | |
| * | |
| * @return array | |
| * The updated renderable array containing the placeholder. | |
| */ | |
| public static function generatePlaceholder(array $element) { | |
| $element['messages_placeholder'] = [ | |
| '#lazy_builder' => [get_class() . '::renderMessages', [$element['#display']]], | |
| '#create_placeholder' => TRUE, | |
| ]; | |
| return $element; | |
| } | |
| /** | |
| * #lazy_builder callback; replaces placeholder with messages. | |
| * | |
| * @param string|null $type | |
| * Limit the messages returned by type. Defaults to NULL, meaning all types. | |
| * Passed on to drupal_get_messages(). These values are supported: | |
| * - NULL | |
| * - 'status' | |
| * - 'warning' | |
| * - 'error' | |
| * | |
| * @return array | |
| * A renderable array containing the messages. | |
| * | |
| * @see drupal_get_messages() | |
| */ | |
| public static function renderMessages($type) { | |
| // Render the messages. | |
| return [ | |
| '#theme' => 'status_messages', | |
| // @todo Improve when https://www.drupal.org/node/2278383 lands. | |
| '#message_list' => drupal_get_messages($type), | |
| '#status_headings' => [ | |
| 'status' => t('Status message'), | |
| 'error' => t('Error message'), | |
| 'warning' => t('Warning message'), | |
| ], | |
| ]; | |
| } | |
| } |