melisplatform / melis-cms-prospects
Melis Platform prospects module
Installs: 3 960
Dependents: 2
Suggesters: 2
Security: 0
Stars: 2
Watchers: 8
Forks: 1
Open Issues: 0
Type:melisplatform-module
Requires
- php: ^8.1|^8.3
- laminas/laminas-mvc-plugin-flashmessenger: ^1.10
- melisplatform/melis-cms: ^5.2
- melisplatform/melis-core: ^5.2
- melisplatform/melis-engine: ^5.2
- melisplatform/melis-front: ^5.2
- dev-master
- v5.3.1
- v5.3.0
- v5.2.0
- v5.1.0
- v5.0.1
- v5.0.0
- v4.1.0
- v4.0.1
- v4.0.0
- v3.2.3
- v3.2.2
- v3.2.1
- v3.2.0
- v3.1.0
- v3.0.2
- v3.0.1
- v3.0.0
- v2.5.0
- v2.4.0
- v2.3.0
- v2.2.1
- v2.2.0
- v2.1.1
- v2.1
- dev-update/jquery3.7.1
- dev-develop
- dev-update/php83
- dev-update/utf8mb4
- dev-update/php-8-upgrade
- dev-php-7.0
- dev-migrate/laminas
- dev-zend-old-version
This package is auto-updated.
Last update: 2024-10-26 15:55:00 UTC
README
MelisCmsProspects provides a full Prospect 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 MelisCms.
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-prospects
Database
Database model is accessible on the MySQL Workbench file:
/melis-cms-prospects/install/sql/model
Database will be installed through composer and its hooks.
In case of problems, SQL files are located here:
/melis-cms-prospects/install/sql
Tools & Elements provided
- Prospects Tool
- Themes Tool
- Melis Templating Prospect Plugin (contact form & management)
- Dashboard item for prospects registration overview
Running the code
MelisCmsProspects Services
MelisCmsProspects provides many services to be used in other modules:
- MelisCmsProspects
Services to retrieve lists of prospects, prospects details and save a new prospect
File: /melis-cms-prospects/src/Service/MelisCmsProspectsService.php
// Get the service
$melisProspectsService = $this->getServiceManager()->get('MelisProspectsService');
// Get the number of prospects per month
$nb = $melisProspectsService->getProspectsDataByDate('monthly', '2017-10-04 12:00:00');
MelisCmsProspects Forms
Forms factories
All Melis CMS News forms are built using Form Factories.
All form configuration are available in the file: /melis-cms-prospects/config/app.tools.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(
// MelisCmsProspects array
'melistoolprospects' => array(
// Form key
'forms' => array(
// MelisCmsProspects update form
'melistoolprospects_tool_prospects_update' => array(
'attributes' => array(
'name' => 'prospectmanager',
'id' => 'idformprospectdata',
'method' => 'POST',
'action' => '',
),
'hydrator' => 'Laminas\Hydrator\ArraySerializableHydrator',
'elements' => array(
array(
'spec' => array(
...
),
),
),
'input_filter' => array(
'pros_id' => array(
...
),
),
),
),
),
),
),
Forms elements
MelisCmsProspects provides form elements to be used in forms:
- MelisCmsProspectThemeSelect: a dropdown to select a theme
- MelisCmsProspectThemeItemSelect: a dropdown to select a theme item
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(
'MelisCmsProspects',
array(
'meliscmsprospects_toolprospects_save_end',
),
function($e){
$sm = $e->getTarget()->getServiceManager();
$params = $e->getParams();
// Custom code
},
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