?i»?
Current Path : /home/scgforma/www/soc064/htdocs/core/modules/ |
Current File : /home/scgforma/www/soc064/htdocs/core/modules/modOpenSurvey.class.php |
<?php /* Copyright (C) 2013-2014 Laurent Destailleur <eldy@users.sourceforge.net> * Copyright (C) 2014 Marcos GarcĂa <marcosgdf@gmail.com> * * 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/>. */ /** * \defgroup opensurvey Module opensurvey * \brief Module to OpenSurvey integration. * \file htdocs/core/modules/modOpenSurvey.class.php * \ingroup opensurvey * \brief Description and activation file for module OpenSurvey */ include_once DOL_DOCUMENT_ROOT ."/core/modules/DolibarrModules.class.php"; /** * Description and activation class for module opensurvey */ class modOpenSurvey extends DolibarrModules { /** * Constructor. Define names, constants, directories, boxes, permissions * * @param DoliDB $db Database handler */ public function __construct($db) { global $langs,$conf; $this->db = $db; // Id for module (must be unique). // Use here a free id (See in Home -> System information -> Dolibarr for list of used module id). $this->numero = 55000; // Key text used to identify module (for permission, menus, etc...) $this->rights_class = 'opensurvey'; // Family can be 'crm','financial','hr','projects','product','technic','other' // It is used to group modules in module setup page $this->family = "portal"; $this->module_position = '40'; // Module label (no space allowed), used if translation string 'ModuleXXXName' not found (where XXX is value of numeric property 'numero' of module) $this->name = preg_replace('/^mod/i', '', get_class($this)); // Module description used if translation string 'ModuleXXXDesc' not found (XXX is value MyModule) $this->description = "Module to make online surveys (like Doodle, Studs, Rdvz, ...)"; // Possible values for version are: 'development', 'experimental', 'dolibarr' or version $this->version = 'dolibarr'; // Key used in llx_const table to save module status enabled/disabled (where MYMODULE is value of property name of module in uppercase) $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name); // Name of image file used for this module. // If file is in theme/yourtheme/img directory under name object_pictovalue.png, use this->picto='pictovalue' // If file is in module/img directory under name object_pictovalue.png, use this->picto='pictovalue@module' $this->picto='opensurvey.png@opensurvey'; // Data directories to create when module is enabled $this->dirs = array(); //$this->dirs[0] = DOL_DATA_ROOT.'/mymodule; //$this->dirs[1] = DOL_DATA_ROOT.'/mymodule/temp; // Dependencies $this->hidden = false; // A condition to hide module $this->depends = array(); // List of module class names as string that must be enabled if this module is enabled $this->requiredby = array(); // List of module ids to disable if this one is disabled $this->conflictwith = array(); // List of module class names as string this module is in conflict with $this->phpmin = array(5,4); // Minimum version of PHP required by module $this->need_dolibarr_version = array(3,4,0); // Minimum version of Dolibarr required by module // Constants $this->const = array(); // List of parameters // Dictionaries $this->dictionaries=array(); // Boxes $this->boxes = array(); // List of boxes $r=0; // Add here list of php file(s) stored in includes/boxes that contains class to show a box. // Example: //$this->boxes[$r][1] = "myboxa.php"; //$r++; //$this->boxes[$r][1] = "myboxb.php"; //$r++; // Permissions $this->rights = array(); // Permission array used by this module $r=0; // Add here list of permission defined by an id, a label, a boolean and two constant strings. // Example: $this->rights[$r][0] = 55001; // Permission id (must not be already used) $this->rights[$r][1] = 'Read surveys'; // Permission label $this->rights[$r][2] = 'r'; // Permission by default for new user (0/1) $this->rights[$r][3] = 0; // Permission by default for new user (0/1) $this->rights[$r][4] = 'read'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2) $r++; // Add here list of permission defined by an id, a label, a boolean and two constant strings. // Example: $this->rights[$r][0] = 55002; // Permission id (must not be already used) $this->rights[$r][1] = 'Create/modify surveys'; // Permission label $this->rights[$r][2] = 'w'; // Permission by default for new user (0/1) $this->rights[$r][3] = 0; // Permission by default for new user (0/1) $this->rights[$r][4] = 'write'; // In php code, permission will be checked by test if ($user->rights->permkey->level1->level2) $r++; // Menus //------- $r=0; $this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=tools', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode 'type'=>'left', 'titre'=>'Survey', 'mainmenu'=>'tools', 'leftmenu'=>'opensurvey', 'url'=>'/opensurvey/index.php?mainmenu=tools&leftmenu=opensurvey', 'langs'=>'opensurvey', 'position'=>200, 'enabled'=>'$conf->opensurvey->enabled', // Define condition to show or hide menu entry. Use '$conf->NewsSubmitter->enabled' if entry must be visible if module is enabled. 'perms'=>'$user->rights->opensurvey->read', 'target'=>'', 'user'=>0, ); $r++; $this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=tools,fk_leftmenu=opensurvey', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode 'type'=>'left', 'titre'=>'NewSurvey', 'mainmenu'=>'tools', 'leftmenu'=>'opensurvey_new', 'url'=>'/opensurvey/wizard/index.php', 'langs'=>'opensurvey', 'position'=>210, 'enabled'=>'$conf->opensurvey->enabled', // Define condition to show or hide menu entry. Use '$conf->NewsSubmitter->enabled' if entry must be visible if module is enabled. 'perms'=>'$user->rights->opensurvey->write', 'target'=>'', 'user'=>0, ); $r++; $this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=tools,fk_leftmenu=opensurvey', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' where xxx is mainmenucode and yyy is a leftmenucode 'type'=>'left', 'titre'=>'List', 'mainmenu'=>'tools', 'leftmenu'=>'opensurvey_list', 'url'=>'/opensurvey/list.php', 'langs'=>'opensurvey', 'position'=>220, 'enabled'=>'$conf->opensurvey->enabled', // Define condition to show or hide menu entry. Use '$conf->NewsSubmitter->enabled' if entry must be visible if module is enabled. 'perms'=>'$user->rights->opensurvey->read', 'target'=>'', 'user'=>0, ); $r++; } /** * Function called when module is enabled. * The init function add constants, boxes, permissions and menus (defined in constructor) into Dolibarr database. * It also creates data directories * * @param string $options Options when enabling module ('', 'noboxes') * @return int 1 if OK, 0 if KO */ public function init($options = '') { // Permissions $this->remove($options); $sql = array(); return $this->_init($sql, $options); } }