The Blog
Laravel MessageBag Public API: keys
The keys method in Laravel allows you to retrieve all the keys stored inside a MessageBag instance. In the code example provided, a MessageBag instance is created and items are added to it. Then, the keys method is called to retrieve an array of keys. The resulting array will contain only the keys that were added. If you want to learn more about Laravel's ErrorMessageBag component, you can check out the mini-series of articles provided in the "Continue Reading" section. These articles cover various aspects of the MessageBag public API.
Laravel MessageBag Public API: merge
The merge method in Laravel is used to combine the contents of a MessageBag instance with another array or object that implements the MessageProvider interface. This method modifies the original MessageBag instance and returns a reference to it. In the provided examples, the merge method is used to merge an array with a MessageBag instance and merge two MessageBag instances together. The resulting merged messages can be accessed as an array. This article is part of a series on Laravel's ErrorMessageBag component, exploring various methods in the public API.
Laravel MessageBag Public API: setFormat
The setFormat method is used to customize the format used by all methods of the MessageBag instance in Laravel. By passing a $format argument, developers can define the new format. If called without a value, it will reset the format to the default value. This method is part of the Laravel ErrorMessageBag component. Continue reading to learn more about Laravel's MessageBag and its public API methods. The articles cover various methods like add, all, any, count, first, get, getFormat, getMessageBag, getMessages, has, isEmpty, jsonSerialize, keys, merge, toArray, toJson, and __toString.
Laravel MessageBag Public API: toArray
The toArray method in Laravel's Collection class converts the collection instance into an array. It not only returns the underlying array but also converts any object instances into arrays. In the provided code example, the $returnedItems variable would contain an array with three elements, including a nested array. If you want to learn more about Laravel's ErrorMessageBag component, check out the rest of the articles in the series. They cover various public API methods, including add, all, any, count, first, get, getFormat, getMessageBag, getMessages, has, isEmpty, jsonSerialize, keys, merge, setFormat, toArray, toJson, and __toString.
Laravel MessageBag Public API: toJson
The toJson method in Laravel's ErrorMessageBag class converts the message bag instance into a JSON-encoded string. It internally uses PHP's json_encode function to perform this conversion. You can pass additional options to customize the encoding process by using the $options parameter. By default, the method returns a string without any formatting. However, you can pass the JSON_PRETTY_PRINT constant to get a more human-readable output. If your data structure is deeply nested and exceeds the default depth limit of 512 in json_encode, you can manually serialize the message bag and use json_encode with a custom depth value. This article is part of a mini-series that explores various methods in Laravel's ErrorMessageBag component.
Laravel ViewErrorBag Public API: count
Learn how to use the count method in Laravel's View Error Bags to determine the number of messages stored within the default MessageBag instance. This method is specifically handled by the ViewErrorBag instance and can be used to satisfy the requirements of PHP's Countable interface. Understand how adding or changing MessageBag instances affect the count results. Check out the complete mini-series about Laravel's View Error Bags for more information and other APIs you can use.
Laravel ViewErrorBag Public API: getBag
The getBag method retrieves a MessageBag instance associated with a provided key. If no instance exists with the key, a new Illuminate\Support\MessageBag instance will be returned. You can also request a MessageBag instance with any key, even if it hasn't been set. However, note that getBag does not set the returned MessageBag instance. You can dynamically access a MessageBag instance from ViewErrorBag by using a property with the intended key. For further reading about Laravel's View Error Bags, check out the mini-series of articles linked in the post.
Laravel ViewErrorBag Public API: getBags
The getBags method in Laravel's ViewErrorBag class returns an associative array containing all MessageBag instances stored within it. These instances can hold error messages related to specific form fields or other sections of a webpage. This allows developers to easily manage and display error messages to users. To learn more about Laravel's View Error Bags and their public API, check out the articles in this mini-series.
Laravel ViewErrorBag Public API: hasBag
The hasBag method is used to check if a MessageBag instance exists within the ViewErrorBag instance with the specified key. By default, the $key is set to default. This article is part of a series that explores Laravel's View Error Bags, including other methods such as count, getBag, getBags, and put.
Laravel ViewErrorBag Public API: put
The put method is used to add a new MessageBag instance to the ViewErrorBag instance with a specified key. You can also dynamically set a MessageBag instance by assigning it to a property in ViewErrorBag. To remove or replace all messages in a MessageBag instance, you can use the put method with a new MessageBag instance.
Latest posts
Wrapping up Forte Phase 0 with the lexer and parser now in private alpha, and kicking off Phase 1 wi...
Read moreA Forte development update: the parser now supports backtracking, improvements to node metadata, ide...
Read moreWrapping up attribute parsing in Forte's HTML parser, from simple HTML attributes to complex, edge-c...
Read moreExploring how Forte's parser extensions can be used to handle complex Blade directives like nested s...
Read moreDigging into parsing Blade and HTML comments while building Forte's HTML parser for Laravel Blade.
Read moreThis week I’m tackling Forte's HTML parser - consolidating Blade, Flux, and Livewire components into...
Read more