Module File Headers

Module File Headers

Each module in Our CRM consist of init file which contains the general module configuration and includes headers containing meta-information regarding the module.

Module init file headers example

The follow example is taken from the default Our CRM module Menu Setup that comes with the installation.

<?php

 

defined('BASEPATH') or exit('No direct script access allowed');

 

/*

Module Name: Menu Setup

Description: Default module to apply changes to the menus

Version: 2.3.0

Requires at least: 2.3.*

*/

Available Headers

You can find below the list of available headers that can be added to module init file.

·         Module Name – required

·         Module URI – module URL

·         Version – the version of the module

·         Description – the description of the module, you can explain what does the module do.

·         Author – module author name

·         Author URI – module author URL

·         Requires at least – what version of Our CRM the module requires at least


    • Related Articles

    • Module Basics

      Modules location & Name All modules should be added in the modules folder in your root directory where Our CRM is installed and each module must have unique folder name and init file with the same name as your module folder name. Creating your first ...

    • Module Security

      So, you created your module and works fine, but is it secure? You must ensure that your module is secure and is not vulnerable to any SQL Injections are directory traversing. You can find below best practices to ensure that your module will be ...

    • Common Module Functions

      register_activation_hook /** * Register module activation hook * @param  string $module   module system name * @param  mixed $function  function for the hook * @return mixed */   register_activation_hook($module, $function) register_deactivation_hook ...

    • Allowed file extensions

      For the support feature allowed file extensions are separated from the global system allowed file extensions. To configure the support ticket file extensions navigate to Setup->Settings->Support-> Allowed file extensions. The file extensions added ...

    • Create Menu Items

      If you are creating your custom modules, probably you will want to create menu items that will be shown on admin area sidebar or clients area navigation. With Our CRM you can easily achieve this with few lines of code. The code samples below, should ...