2015-05-01 20:47:11 +00:00
|
|
|
<?php
|
2015-08-29 15:43:13 +00:00
|
|
|
/**
|
2016-05-07 17:22:09 +00:00
|
|
|
* FuzeWorks.
|
2015-08-29 15:43:13 +00:00
|
|
|
*
|
|
|
|
* The FuzeWorks MVC PHP FrameWork
|
|
|
|
*
|
|
|
|
* Copyright (C) 2015 TechFuze
|
|
|
|
*
|
|
|
|
* This program is free software: you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU General Public License as published by
|
|
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
|
|
* (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
*
|
2016-05-07 17:22:09 +00:00
|
|
|
* @author TechFuze
|
|
|
|
* @copyright Copyright (c) 2013 - 2016, Techfuze. (http://techfuze.net)
|
|
|
|
* @copyright Copyright (c) 1996 - 2015, Free Software Foundation, Inc. (http://www.fsf.org/)
|
|
|
|
* @license http://opensource.org/licenses/GPL-3.0 GPLv3 License
|
|
|
|
*
|
|
|
|
* @link http://fuzeworks.techfuze.net
|
|
|
|
* @since Version 0.0.1
|
|
|
|
*
|
|
|
|
* @version Version 0.0.1
|
2015-08-29 15:43:13 +00:00
|
|
|
*/
|
|
|
|
|
2015-05-01 20:47:11 +00:00
|
|
|
return array(
|
|
|
|
|
2015-09-05 17:06:19 +00:00
|
|
|
// The class name of the module. This class will be loaded upon requesting the module
|
2016-05-07 17:22:09 +00:00
|
|
|
'module_class' => 'Module\Example\Main',
|
2015-09-05 17:06:19 +00:00
|
|
|
|
|
|
|
// The file that will be loaded upon requesting the module
|
2016-05-07 17:22:09 +00:00
|
|
|
'module_file' => 'class.main.php',
|
2015-09-05 17:06:19 +00:00
|
|
|
|
2016-01-13 11:30:02 +00:00
|
|
|
// The name of the module; Appended into Modules::get('namespace/module_name');
|
2016-05-07 17:22:09 +00:00
|
|
|
'module_name' => 'Example',
|
2015-05-01 20:47:11 +00:00
|
|
|
|
2016-01-13 12:09:12 +00:00
|
|
|
// whether this module is an abstract. Making this abstract will only load the file, but not the class.
|
2016-05-07 17:22:09 +00:00
|
|
|
'abstract' => false,
|
2015-09-05 17:06:19 +00:00
|
|
|
|
|
|
|
// Other names for this module. Setting an alias will allow you to load the module with a different name.
|
2016-05-07 17:22:09 +00:00
|
|
|
'aliases' => array(),
|
2015-09-05 17:06:19 +00:00
|
|
|
|
|
|
|
// Array of modules that should be loaded before this module
|
2016-05-07 17:22:09 +00:00
|
|
|
'dependencies' => array(),
|
2015-05-01 20:47:11 +00:00
|
|
|
|
2015-09-05 17:06:19 +00:00
|
|
|
// Events that this module listens for. When the exampleEvent is fired, this module will be loaded so the module can handle the event
|
2016-05-07 17:22:09 +00:00
|
|
|
'events' => array('exampleEvent'),
|
2015-09-05 17:06:19 +00:00
|
|
|
|
2016-01-16 20:21:11 +00:00
|
|
|
// Routes that this module listens on. Any URL that matches this pattern will load this module
|
|
|
|
// If the URL /example/ gets called, this module will be loaded
|
|
|
|
// Everything after /example/ will be sent to the route() function in the matches array under the, in this example, 'data' key
|
2016-05-07 17:22:09 +00:00
|
|
|
'routes' => array('/^example(|\/(?P<data>.*?))$/'),
|
2015-10-11 18:14:49 +00:00
|
|
|
|
2016-01-16 20:21:11 +00:00
|
|
|
// Advertises some data with the key 'exampleAdvertisement'. This data will be sent to a module which listens for this key.
|
|
|
|
// This allows for some data to be sent to a module which listens to this key.
|
2016-05-07 17:22:09 +00:00
|
|
|
'advertise' => array('exampleAdvertisement' => array('exampleData')),
|
2016-01-16 20:21:11 +00:00
|
|
|
|
|
|
|
// Tells the module engine that this module would like all the data with the key 'exampleAdvertisement'.
|
2016-05-07 17:22:09 +00:00
|
|
|
'listenFor' => array('exampleAdvertisement'),
|
2016-01-16 20:21:11 +00:00
|
|
|
|
2015-09-05 17:06:19 +00:00
|
|
|
// The name of the module as it will be logged. This does not affect usage of the module in any way
|
2016-05-07 17:22:09 +00:00
|
|
|
'name' => 'FuzeWorks Example Module',
|
2015-09-05 17:06:19 +00:00
|
|
|
|
|
|
|
// A description of the module.
|
2016-05-07 17:22:09 +00:00
|
|
|
'description' => 'A descriptive module that functions as an example',
|
2015-09-05 17:06:19 +00:00
|
|
|
|
|
|
|
// The author of the module. The author is the first part of the module name used for requesting. eg mycorp/example
|
2016-05-07 17:22:09 +00:00
|
|
|
'author' => 'MyCorp',
|
2015-09-05 17:06:19 +00:00
|
|
|
|
|
|
|
// The current version of the module. Will be used for looking for updates
|
2016-05-07 17:22:09 +00:00
|
|
|
'version' => '1.0.0',
|
2015-09-05 17:06:19 +00:00
|
|
|
|
|
|
|
// The website to look at for the module update
|
2016-05-07 17:22:09 +00:00
|
|
|
'website' => 'http://fuzeworks.techfuze.net/',
|
2015-05-01 20:47:11 +00:00
|
|
|
|
2015-09-05 17:06:19 +00:00
|
|
|
// The initial creation of the module.
|
2016-05-07 17:22:09 +00:00
|
|
|
'date_created' => '29-04-2015',
|
2015-09-05 17:06:19 +00:00
|
|
|
|
|
|
|
// The last update of this module
|
2016-05-07 17:22:09 +00:00
|
|
|
'date_updated' => '29-04-2015',
|
2015-05-01 20:47:11 +00:00
|
|
|
|
2016-01-13 12:09:12 +00:00
|
|
|
// whether the module is enabled or not. If it is disabled, it can not be loaded.
|
2016-05-07 17:22:09 +00:00
|
|
|
'enabled' => true,
|
2015-05-01 20:47:11 +00:00
|
|
|
);
|