Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/artgris/pagebundle
Add a page manager to EasyAdminBundle for Symfony
https://github.com/artgris/pagebundle
bundle easyadminbundle symfony
Last synced: 3 months ago
JSON representation
Add a page manager to EasyAdminBundle for Symfony
- Host: GitHub
- URL: https://github.com/artgris/pagebundle
- Owner: artgris
- Created: 2019-06-02T14:12:21.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-12-12T10:32:06.000Z (about 1 year ago)
- Last Synced: 2024-10-14T06:12:40.947Z (3 months ago)
- Topics: bundle, easyadminbundle, symfony
- Language: PHP
- Homepage:
- Size: 933 KB
- Stars: 13
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Artgris Page
============
## Installation:
composer require artgris/page-bundle
php bin/console doctrine:schema:update --force
## Configuration:
in config/packages
### configure KnpLabs/DoctrineBehaviors: https://github.com/KnpLabs/DoctrineBehaviors
- Add locale parameter in services.yaml:
```yaml
parameters:
locale: 'en'
```
- Add to AppKernel:
```php
return [
...
Knp\DoctrineBehaviors\DoctrineBehaviorsBundle::class => ['all' => true],
];
```
- Add to DashboardController.php :
```php
use Artgris\Bundle\PageBundle\Entity\ArtgrisPage;
public function configureMenuItems(): iterable
{
...
yield MenuItem::linkToCrud('Page', 'fa fa-file-alt', ArtgrisPage::class);
}
```
### add a2lix_translation_form.yaml
ex:
```yaml
a2lix_translation_form:
locale_provider: default
locales: [fr, en]
default_locale: fr
```
### add artgris_page.yaml
not required, no minimal configuration
```yaml
artgris_page:
controllers: #Namespaces used to load the route selector
- 'App\Controller\MainController::index'
- 'App\Controller\Main\'
- 'App\Controller\'
- ...
types: # add your own types
- integer: 'Symfony\Component\Form\Extension\Core\Type\IntegerType'
- date: 'Symfony\Component\Form\Extension\Core\Type\DateType'
- time: 'Symfony\Component\Form\Extension\Core\Type\TimeType'
- custom: 'App\Form\CustomType'
- ...
default_types: true #load default form types [1]
hide_route_form: false #to hide the route selector (example of use: one page website)
redirect_after_update: false #always redirect the user to the configuration page after new/edit action
use_multiple_a2lix_form: false #to use multiple a2lix form
```
[1] Default form types list:
```yaml
source: Artgris\Bundle\PageBundle\Service\TypeService
'type.text' => ArtgrisTextType::class, => not required TextType
'type.textarea' => ArtgrisTextAreaType::class, => not required TextAreaType with rows = 8 + renderType: \nl2br
'type.section' => SectionType::class => h2 section, type hidden, to delimit "blocks"
```
## Usage:
**1 - Create a page and add blocks**
**2 - Edit the content of the blocks**
**3 - Retrieve a simple block by tag**
{{ blok('title') }}
=> return "My website"
use the debugging bar to easily find all blocks by route. (click on block tag to copy/paste code)
**Retrieve all blocks of the current page or not linked to a page**
bloks()
ex:
{% for blok in bloks() %}
{{ blok }}
{% endfor %}
**Retrieve all blocks by page tag**
page('page-tag')
ex:
{% for blok in page('homepage') %}
{{ blok }}
{% endfor %}
**Retrieve blocks with a regular expression**
> in an array
regex_array_blok('regex-expression')
ex:
{% for blok in regex_array_blok('^sidebar-*') %}
{{ blok }}
{% endfor %}
> implode in a string
regex_blok('regex-expression')
ex:
{{ regex_blok('^sidebar-*') }}
## Tips:
### custom block rendering
create a form type that implements PageFromInterface:
namespace App\Form;
use Artgris\Bundle\PageBundle\Form\Type\PageFromInterface;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\Extension\Core\Type\TextareaType;
use Symfony\Component\OptionsResolver\OptionsResolver;
class CustomType extends AbstractType implements PageFromInterface
{
public function configureOptions(OptionsResolver $resolver)
{
$resolver->setDefaults([
'attr' => [
'class' => 'custom',
],
'required' => false,
]);
}
public function getParent()
{
return TextareaType::class;
}
public static function getRenderType($value)
{
return $value. '
';
}
}
Edit the rendering as you wish using the getRenderType method.
## Commands
Export database model (no values) in a file ("/pages/model.yaml")
php bin/console artgris:page:export
/pages/model.yaml extract:
```yaml
page-2:
route: 'App\Controller\Main\MainController::index'
name: 'page 2'
blocks:
blok-10:
type: Artgris\Bundle\PageBundle\Form\Type\ArtgrisTextType
name: 'blok 10'
translatable: false
```
Import model ("/pages/model.yaml") in database
php bin/console artgris:page:import
add *--remove-deviants* to delete the content of types that have changed (ex: text type in yaml but integer type in bd)
php bin/console artgris:page:import --remove-deviants
add *--ignore-names* to ignore page and bloc names that have changed
php bin/console artgris:page:import --ignore-names
Remove extra pages/blocks (in database but not in model.yaml)
php bin/console artgris:page:remove:extra
## Tutorials
* [How to create a TinyMCE Type](doc/tutorials/tinymce.md)
## Cache Infos
All blocks of the current page or not linked to a page are cached (and present in the debug bar) after calling one of these twig functions:
- bloks()
- blok('block-linked-to-the-current-page') => via route selector in page configuration
- blok('block-linked-to-any-page') => route selector left empty
**content added to the cache after the first call:**
- blok('block-of-another-page')
**not in cache, required new db call after each call:**
- page('page-tag')
- regex_array_blok('regex-expression')
- regex_blok('regex-expression')