melisplatform / melis-cms-slider
Melis Platform slider module
Installs: 3 742
Dependents: 3
Suggesters: 3
Security: 0
Stars: 1
Watchers: 8
Forks: 0
Open Issues: 0
Type:melisplatform-module
Requires
- php: ^8.1|^8.3
- melisplatform/melis-cms: ^5.2
- melisplatform/melis-core: ^5.2
- melisplatform/melis-engine: ^5.2
- melisplatform/melis-front: ^5.2
- dev-master
- v5.3.0
- v5.2.0
- v5.1.0
- v5.0.1
- v5.0.0
- v4.1.0
- v4.0.3
- v4.0.2
- v4.0.1
- v4.0.0
- v3.2.2
- v3.2.1
- v3.2.0
- v3.1.1
- v3.1.0
- v3.0.1
- v3.0.0
- v2.5.0
- v2.4.0
- v2.3.1
- v2.3.0
- v2.2.1
- v2.2.0
- v2.1.1
- v2.1
- dev-develop
- dev-update/jquery3.7.1
- dev-update/php83
- dev-update/utf8mb4
- dev-update/php-8-upgrade
- dev-fix/slider-conflict
- dev-fix/datatable-ordering
- dev-feature/tinymce-custom-plugin
- dev-php7.4
- dev-migrate/laminas
- dev-zend-old-version
This package is auto-updated.
Last update: 2024-10-25 05:20:55 UTC
README
MelisCmsSlider provides a full Slider system for Melis Platform, including templating plugins.
Getting Started
These instructions will get you a copy of the project up and running on your machine.
This Melis Platform module is made to work with the MelisCore.
Prerequisites
You will need to install melisplatform/melis-cms in order to have this module running.
This will automatically be done when using composer.
Installing
Run the composer command:
composer require melisplatform/melis-cms-slider
See Full documentation on Melis CMS Slider here
Database
Database model is accessible on the MySQL Workbench file:
/melis-cms-slider/install/sql/model
Database will be installed through composer and its hooks.
In case of problems, SQL files are located here:
/melis-cms-slider/install/sql
Tools & Elements provided
- Slider Tool
- Melis Templating Slider Plugin (SliderShow)
- News with Sliders when MelisCmsNews Module is installed
Running the code
MelisCmsSlider Services
MelisCmsSlider provides many services to be used in other modules:
- MelisCmsNewsService
Services to retrieve lists of sliders, slider details and save sliders
File: /melis-cms-slider/src/Service/MelisCmsSliderService.php
// Get the service
$sliderService = $this->getServiceManager()->get('MelisCmsSliderService');
// Get slider by id
$data = $sliderService->getSlider($sliderId);
MelisSlider Forms
Forms factories
All Melis CMS Slider forms are built using Form Factories.
All form configuration are available in the file: /melis-cms-slider/config/app.forms.php
Any module can override or add items in this form by building the keys in an array and marge it in the Module.php config creation part.
return array(
'plugins' => array(
// MelisCmsNews array
'MelisCmsSlider' => array(
// Form key
'forms' => array(
// MelisCmsNews Properties form
'MelisTechnologySlider_details_form' => array(
'attributes' => array(
'name' => 'sliderDetailsForm',
'id' => 'sliderDetailsForm',
'enctype' => "multipart/form-data",
'method' => 'POST',
'action' => '',
),
'hydrator' => 'Laminas\Hydrator\ArraySerializableHydrator',
'elements' => array(
array(
'spec' => array(
...
),
),
),
'input_filter' => array(
'mcsdetail_id' => array(
...
),
),
),
),
),
),
),
Forms elements
MelisCmsSlider provides form elements to be used in forms:
- CmsSliderSelect: a dropdown to select a slider
Listening to services and update behavior with custom code
Most services trigger events so that the behavior can be modified.
public function attach(EventManagerInterface $events)
{
$sharedEvents = $events->getSharedManager();
$callBackHandler = $sharedEvents->attach(
'MelisCmsSlider',
array(
'meliscmsslider_delete_details_end',
),
function($e){
$sm = $e->getTarget()->getEvent()->getApplication()->getServiceManager()
$sm = $e->getTarget()->getEvent()->getApplication()->getServiceManager()
$params = $e->getParams();
// Custom code here
},
100);
$this->listeners[] = $callBackHandler;
}
Authors
- Melis Technology - www.melistechnology.com
See also the list of contributors who participated in this project.
License
This project is licensed under the OSL-3.0 License - see the LICENSE.md file for details