https://github.com/pbek/pbebasebundle
Webpage helper bundle for eZ Publish Platform
https://github.com/pbek/pbebasebundle
Last synced: 10 months ago
JSON representation
Webpage helper bundle for eZ Publish Platform
- Host: GitHub
- URL: https://github.com/pbek/pbebasebundle
- Owner: pbek
- License: gpl-2.0
- Created: 2015-01-07T08:25:37.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2016-09-24T16:07:56.000Z (over 9 years ago)
- Last Synced: 2025-01-17T14:14:49.684Z (12 months ago)
- Language: PHP
- Size: 58.6 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
PBE Base Bundle
==========
The **PBE Base Bundle** is a **webpage helper bundle** for the [**eZ Publish 5 Platform**](http://ez.no).
You may also want to visit the [PBEBaseBundle Project Webpage](http://www.bekerle.com/PBEBaseBundle) for more informations.
Implemented features
--------------------
* Two level **top menu** generation from a folder with **folders and links** to be included in the pagelayout.
* `pbe_fetch_content` twig function to **load content** in **twig** templates. This could, for example, be used in the pagelayout to load content from an **object relation list**.
Installation
----------
First you'll need **composer**, if you don't already have it. You can execute this in your eZ Publish root directory.
```shell
curl -sS https://getcomposer.org/installer | php
```
Then you can **require** the bundle:
```shell
php composer.phar "pbe/base-bundle":"dev-master"
```
Now you have to **add** the **bundle** to your `ezpublish/EzPublishKernel.php`:
```php
use PBE\BaseBundle\PBEBaseBundle;
...
public function registerBundles()
{
$bundles = array(
new FrameworkBundle(),
...
new PBEBaseBundle()
);
...
}
```
Finally you need to **add** the `base.css` file to your `page_head_style.html.twig` like this:
```twig
{% stylesheets
'@eZDemoBundle/Resources/public/css/bootstrap.css'
...
'@PBEBaseBundle/Resources/public/css/base.css'
%}
{% endstylesheets %}
```
To **override** code of the **PBEBaseBundle** you can also make it **parent** of your bundle.
```php
public function getParent()
{
return 'PBEBaseBundle';
}
```
Take a look at [How to Use Bundle Inheritance to Override Parts of a Bundle](http://symfony.com/doc/current/cookbook/bundles/inheritance.html) for **more information.**
Usage
-----
### top menu generator
Just include this code into your `pagelayout.html.twig` where you want to put your **main menu**. In this example `86` is the location id of the parent folder.
```twig
{{ render( controller( "PBEBaseBundle:Menu:topMenuFromFolder", { 'parentFolderLocationId': 86 } ) ) }}
```
##### This may look like this
#### Injecting other sub-locations to directly link to
You can also add **sub-locations** that are directly linked to in your menu.
For example for your menu entry with the location id `101` additionally load a maximum of `8` items of location `locationId`.
```twig
{{ render( controller( "PBEBaseBundle:Menu:topMenuFromFolder", {
'parentFolderLocationId': 86,
'directlyIncludedLocations': {
101: {
'locationId': 70,
'limit': 8
}
}
} ) ) }}
```
##### This may look like this
The "Blog" menu entry has the `locationId` `101`.
The blog posts are directly loaded from the blog (`'locationId': 70`).
### pbe_fetch_content
You can use this **twig function** in your templates to **load content**. In this example `57` is the content id.
```twig
{% set content = pbe_fetch_content( 57 ) %}
```
It will return a `\eZ\Publish\Core\Repository\Values\Content\Content` object.