The NetworkingInitCmsBundle relies on a few other bundles which need to be configure first before you can get the CMS up and running.
You will need to provide configuration for the SonataAdminBundle, LexikTranslationBundle, and the SonataUserBundle either in your on existing configuration files, or add them to the networking_init_cms.ymal file created by the recipe if installed using flex.
A simple configuration should look something like the following, with special attention paid to the sonata_user configuration as this will create the admin interface for administering users in the cms.
lexik_translation:
fallback_locale: '%env(LOCALE)%' # (required) default locale to use
managed_locales: [ 'de', 'fr', 'it', 'en'] # !IMPORTANT: Change to strings and not environment variables
resources_registration:
type: all # all | files | database
managed_locales_only: false # set to true to only include managed_localessonata_user:
security_acl: false
impersonating:
route: networking_init_cms_admin
parameters: { path: /}
class:
user: 'App\Entity\User'
resetting:
email:
template: '@NetworkingInitCms/Admin/Security/Resetting/email.html.twig'
address: '%env(ADMIN_EMAIL_ADDRESS)%'
sender_name: InitCms
admin: # Admin Classes
user:
class: 'Networking\InitCmsBundle\Admin\UserAdmin'
controller: 'Networking\InitCmsBundle\Controller\UserAdminController'
translation: 'SonataUserBundle'The NetworkingInitCmsBundle has (for the time being) just a few configurable parameters which should be enough to get you started.
This is an example of a possible CMS configuration:
networking_init_cms:
class:
page: 'App\Entity\Page' #default value, extends the base page class
user: 'App\Entity\User' #default value, extends the base user class
email_address:
from_name: 'InitCMS'
from_address: '%env(ADMIN_EMAIL_ADDRESS)%'
webauthn:
enabled: false #default is false, if set to true the webauthn login will be enabled for the admin
admin_toolbar:
toolbar: true #default is true, will be included
allow_locale_cookie: true #default is true, if set to false the locale will be added to the url
single_language: false #default is false, if set to true, the website will only be available in one language and no cookie or url parameter will be used
2fa_authenticator:
enabled: true #default is false, if set to true the 2fa authenticator login will be enabled for the admin
server: 'example.com'
trusted_ip_list:
- 127.0.0.1
forced_for_role:
- ROLE_SONATA_ADMIN
- ROLE_SUPER_ADMIN
languages:
- { label: English, locale: en }
- { label: Deutsch, locale: de }
templates:
one_column_template:
template: "@NetworkingInitCms/Default/one_column.html.twig"
name: "Single Column"
icon: "bundles/networkinginitcms/img/template_header_one_column.png"
controller: MyBundle::index
zones:
- { name: header, class: 'col-12' }
- { name: main_content, class: 'col-12'}
two_column_template:
template: "@NetworkingInitCms/Default/two_column.html.twig"
name: "Two Column"
icon: "bundles/networkinginitcms/img/template_header_two_column.png"
zones:
- { name: header , class: 'col-12', max_content_items: 1, restricted_types: Networking\InitCmsBundle\Entity\Gallery}
- { name: left , class: 'col-3'}
- { name: right , class: 'col-9'}
content_types:
-
name: "Text" #display name in the backend
class: 'Networking\InitCmsBundle\Entity\Text' #entity class
icon: 'ki-outline ki-text-align-left' #icon to display in the backend
default_template: '@NetworkingInitCms/Text/frontend_text_block.html.twig' #default template to use in the frontend
-
name: "Gallery"
class: 'Networking\InitCmsBundle\Entity\GalleryView'
icon: 'ki-outline ki-picture'
default_template: '@NetworkingInitCms/GalleryView/gallery_view.html.twig'- Configure the languages
The first parameter is an array of languages which configure the websites frontend language setup, each language consists of two parameters: 1. The label, used for display in the frontend 2. The locale 3. The short_label, which can be used in a language switch navigation for example
languages:
- {label: English, locale: en_US, short_label: en}
- {label: Deutsch, locale: de_CH, short_label: de}
- Configure the frontend templates
The template configuration consists of an array where the array key is the name and location of the template as you would write it in a twig template include.
The parameters fo the template include: 1. "template": which template to render the page with 2. "name": used for display in the backend 3. "icon": a picture that should be no bigger than 175px wide. This will be shown in the backend to help the cms user visualise what the page could look like 4. "controller": used to direct the request to the correct controller. default is NetworkingInitCmsBundle:FrontendPage:index if not set 5. "zones": These are the areas in the template where content will be assigned to. Each zone has a "name" property (something sensible so the user can imagine what sort of content my go there), and "class" property which enables the CMS to roughly approximate the dimensions of the template. The class property allows you to set a class for display the width and offset of a column, to use this feature you should be familiar with Bootstrap 3.
templates:
'sandbox_one_column':
template: "@NetworkingInitCms/Default/one_column.html.twig"
name: "Single Column"
icon: "bundles/networkinginitcms/img/template_header_one_column.png"
controller: MyBundle::index # default NetworkingInitCmsBundle:FrontendPage:index
zones:
- { name: header, class: 'col-md-12', max_content_items: 1, restricted_types: Networking\InitCmsBundle\Entity\Gallery }
- { name: main_content, class: 'col-md-12'}
'sandbox_two_column':
template: "@NetworkingInitCms/Default/two_column.html.twig"
name: "Two Column"
icon: "bundles/networkinginitcms/img/template_header_two_column.png"
zones:
- { name: header , class: 'col-md-12'}
- { name: left , class: 'col-md-3'}
- { name: right , class: 'col-md-9'}
Special attention should be made to the parameter "controller", this allows you to override the default action that a route should be executed with. It is a good idea to extend the Networking\InitCmsBundle\Controller\FrontendController and use the indexAction of the class so as to get all the right published or draft attributes. Then you can add your own functionality afterwards e.g.
use Networking\InitCmsBundle\Controller\FrontendController
class DefaultController extends FrontendController
{
public function indexAction(Request $request)
{
$params = parent::indexAction($request);
//do some extra stuff here, may be add some parameters etc
return $params;
}
}Also it is possible to restrict certain content zones to a specific content type using the "restricted_types" param as well as limit the number of items allowed in a certain zone with the "max_content_items" parameter, the default is 0 which means unlimited. If you don't want any content in a zone, use -1, for example if you need to display an area, which the user can not put content in;
To learn more about templates see: Creating Templates
- Configure the content types
This is where you can start to add you own content types as well as configure which ones of ours you would like to use.
Each content type consists of two properties: 1. "name": once more a display name for the backend 2. "class": the entity (including namespace) which will be used to contain the user input. 3. "icon": a css icon class name to display in the backend, fontawesome, and line awesome are included by default, as well as a few others. 4. "default_template": the template to use to render the content in the frontend. This template will also be used to render the content in the backend if no other template is defined.
Content types can be simple entities consisting of just one field (such as the Text content type), or more of a configuration entity, which configures an links to another entity (such as the Gallery content type), which has a many-to-one relationship with a Networking\MediaBundle\Entity\Gallery entity (which actually contains the images).
content_types:
-
name: "Text" #display name in the backend
class: 'Networking\InitCmsBundle\Entity\Text' #entity class
icon: 'ki-outline ki-text-align-left' #icon to display in the backend
default_template: '@NetworkingInitCms/Text/frontend_text_block.html.twig' #default template to use in the frontend
-
name: "Gallery"
class: 'Networking\InitCmsBundle\Entity\GalleryView'
icon: 'ki-outline ki-picture'
default_template: '@NetworkingInitCms/GalleryView/gallery_view.html.twig'To learn more about templates see: Creating content types