https://github.com/nystudio107/eagerbeaver
DEPRECATED Allows you to eager load elements from auto-injected Entry elements on demand from your templates.
https://github.com/nystudio107/eagerbeaver
craft-plugin craftcms eager-loading elements
Last synced: 7 months ago
JSON representation
DEPRECATED Allows you to eager load elements from auto-injected Entry elements on demand from your templates.
- Host: GitHub
- URL: https://github.com/nystudio107/eagerbeaver
- Owner: nystudio107
- License: mit
- Created: 2017-09-27T21:28:41.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-01-01T23:39:49.000Z (about 7 years ago)
- Last Synced: 2024-03-19T14:46:56.407Z (almost 2 years ago)
- Topics: craft-plugin, craftcms, eager-loading, elements
- Language: PHP
- Homepage:
- Size: 39.1 KB
- Stars: 25
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](http://unmaintained.tech/)
# DEPRECATED
This Craft CMS 2.x plugin is no longer supported, but it is fully functional, and you may continue to use it as you see fit. The license also allows you to fork it and make changes as needed for legacy support reasons.
The Craft CMS 3.x version of this plugin can be found here: [craft-eagerbeaver](https://github.com/nystudio107/craft-eagerbeaver) and can also be installed via the Craft Plugin Store in the Craft CP.
# Eager Beaver plugin for Craft CMS
Allows you to eager load elements from auto-injected Entry elements on demand from your templates.
Related: [Eager Beaver for Craft 3.x](https://github.com/nystudio107/craft3-eagerbeaver)
## Installation
To install Eager Beaver, follow these steps:
1. Download & unzip the file and place the `eagerbeaver` directory into your `craft/plugins` directory
2. -OR- do a `git clone https://github.com/nystudio107/eagerbeaver.git` directly into your `craft/plugins` folder. You can then update it with `git pull`
3. -OR- install with Composer via `composer require nystudio107/eagerbeaver`
4. Install plugin in the Craft Control Panel under Settings > Plugins
5. The plugin folder should be named `eagerbeaver` for Craft to see it. GitHub recently started appending `-master` (the branch name) to the name of the folder for zip file downloads.
Eager Beaver works on Craft 2.6.x.
## Eager Beaver Overview
Craft's [Eager-Loading Elements](https://craftcms.com/docs/templating/eager-loading-elements) allows you to nicely optimize your templates by telling Craft to load everything you need in one big query.
The only rub is that you can't specify this eager loading behavior for `entry`, `category`, or `product` elements that are auto-injected into your template.
Eager Beaver is a small plugin that allows you to eager load sub-elements like Assets, Categories, Users, etc. to these auto-injected elements.
This is especially useful if you have pages that use Matrix block "content builders", and thus will typically result in loading a number of relations like Assets contained in Matrix blocks to render a page.
## Configuring Eager Beaver
There's nothing to configure.
## Using Eager Beaver
To use Eager Beaver, simply do something like:
```
{% do eagerLoadElements(entry, [
'author.userPicture',
'blogCategory',
'blogImage',
'blogContent.image:image'
]) %}
```
Or you can use the more verbose syntax to do the same thing:
```
{% do craft.eagerBeaver.eagerLoadElements(entry, [
'author.userPicture',
'blogCategory',
'blogImage',
'blogContent',
'blogContent.image:image'
]) %}
```
The first parameter is the Element or array of Elements that you want to eager-load sub-elements into, such as an `entry`. If you pass in an array of Elements, they must all be the same type.
The second parameter is the same `with:` that you use for [Eager-Loading Elements](https://craftcms.com/docs/templating/eager-loading-elements), and uses the exact same syntax.
In the above example:
- `author` is a `User` that has an Assets field named `userPicture` added to it.
- `blogCategory` is a Category field
- `blogImage` is an Asset field
- `blogContent` is a Matrix field that has an Assets field named `image` added to the block type `image`
## Eager Beaver Roadmap
Some things to do, and ideas for potential features:
* Release it
Brought to you by [nystudio107](https://nystudio107.com/)