Dolibarr\Modules\Projet::__construct()

Complexity

Conditions	18
Paths	1728

Size

Total Lines	314
Code Lines	239

Duplication

Lines	0
Ratio	0 %

Importance

Changes

0

<?php
    public function __construct($db)
    {
        global $conf;

        $this->db = $db;
        $this->numero = 400;

        $this->family = "projects";
        $this->module_position = '14';
        // 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));
        $this->description = "Gestion des projects";
        // Possible values for version are: 'development', 'experimental', 'dolibarr' or version
        $this->version = 'dolibarr';

        $this->const_name = 'MAIN_MODULE_' . static::getNameOf($this->name); // strtoupper($this->name);
        $this->config_page_url = array("project.php@projet");
        $this->picto = 'project';

        // Data directories to create when module is enabled
        $this->dirs = array("/projet/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('modEventOrganization'); // 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(7, 0); // Minimum version of PHP required by module
        $this->langfiles = array('projects');

        // Constants
        $this->const = array();
        $r = 0;

        $this->const[$r][0] = "PROJECT_ADDON_PDF";
        $this->const[$r][1] = "chaine";
        $this->const[$r][2] = "baleine";
        $this->const[$r][3] = 'Name of PDF/ODT project manager class';
        $this->const[$r][4] = 0;
        $r++;

        $this->const[$r][0] = "PROJECT_ADDON";
        $this->const[$r][1] = "chaine";
        $this->const[$r][2] = "mod_project_simple";
        $this->const[$r][3] = 'Name of Numbering Rule project manager class';
        $this->const[$r][4] = 0;
        $r++;

        $this->const[$r][0] = "PROJECT_ADDON_PDF_ODT_PATH";
        $this->const[$r][1] = "chaine";
        $this->const[$r][2] = "DOL_DATA_ROOT/doctemplates/projects";
        $this->const[$r][3] = "";
        $this->const[$r][4] = 0;
        $r++;

        $this->const[$r][0] = "PROJECT_TASK_ADDON_PDF";
        $this->const[$r][1] = "chaine";
        $this->const[$r][2] = "";
        $this->const[$r][3] = 'Name of PDF/ODT tasks manager class';
        $this->const[$r][4] = 0;
        $r++;

        $this->const[$r][0] = "PROJECT_TASK_ADDON";
        $this->const[$r][1] = "chaine";
        $this->const[$r][2] = "mod_task_simple";
        $this->const[$r][3] = 'Name of Numbering Rule task manager class';
        $this->const[$r][4] = 0;
        $r++;

        $this->const[$r][0] = "PROJECT_TASK_ADDON_PDF_ODT_PATH";
        $this->const[$r][1] = "chaine";
        $this->const[$r][2] = "DOL_DATA_ROOT/doctemplates/tasks";
        $this->const[$r][3] = "";
        $this->const[$r][4] = 0;
        $r++;

        $this->const[$r][0] = "PROJECT_USE_OPPORTUNITIES";
        $this->const[$r][1] = "chaine";
        $this->const[$r][2] = "1";
        $this->const[$r][3] = "";
        $this->const[$r][4] = 0;
        $r++;

        // Boxes
        $this->boxes = array(
            0 => array('file' => 'box_project.php', 'enabledbydefaulton' => 'Home'),  // open projects
            1 => array('file' => 'box_project_opportunities.php', 'enabledbydefaulton' => 'Home'),    // open opportunities
            2 => array('file' => 'box_task.php', 'enabledbydefaulton' => 'Home'),
            3 => array('file' => 'box_validated_projects.php', 'enabledbydefaulton' => 'Home'),   // task without timespent
            4 => array('file' => 'box_funnel_of_prospection.php', 'enabledbydefaulton' => 'Home'),
        );
        // Cronjobs
        $this->cronjobs[] = array(
            'label' => 'WeeklyWorkingHoursReport',
            'jobtype' => 'method',
            'class' => 'projet/class/project.class.php',
            'objectname' => 'Project',
            'method' => 'createWeeklyReport',
            'parameters' => '',
            'comment' => 'Generates and sends a weekly report on time worked',
            'frequency' => 1,
            'unitfrequency' => 86400 * 7,
            'status' => 0,
            'test' => '$conf->projet->enabled',
        );
        // Permissions
        $this->rights = array();
        $this->rights_class = 'projet';
        $r = 0;

        $r++;
        $this->rights[$r][0] = 41; // id de la permission
        $this->rights[$r][1] = "Read projects and tasks (shared projects or projects I am contact for)"; // libelle de la permission
        $this->rights[$r][2] = 'r'; // type de la permission (deprecated)
        $this->rights[$r][3] = 0; // La permission est-elle une permission par default
        $this->rights[$r][4] = 'lire';

        $r++;
        $this->rights[$r][0] = 42; // id de la permission
        $this->rights[$r][1] = "Create/modify projects and tasks (shared projects or projects I am contact for)"; // libelle de la permission
        $this->rights[$r][2] = 'w'; // type de la permission (deprecated)
        $this->rights[$r][3] = 0; // La permission est-elle une permission par default
        $this->rights[$r][4] = 'creer';

        $r++;
        $this->rights[$r][0] = 44; // id de la permission
        $this->rights[$r][1] = "Delete project and tasks (shared projects or projects I am contact for)"; // libelle de la permission
        $this->rights[$r][2] = 'd'; // type de la permission (deprecated)
        $this->rights[$r][3] = 0; // La permission est-elle une permission par default
        $this->rights[$r][4] = 'supprimer';

        $r++;
        $this->rights[$r][0] = 45; // id de la permission
        $this->rights[$r][1] = "Export projects"; // libelle de la permission
        $this->rights[$r][2] = 'd'; // type de la permission (deprecated)
        $this->rights[$r][3] = 0; // La permission est-elle une permission par default
        $this->rights[$r][4] = 'export';

        $r++;
        $this->rights[$r][0] = 141; // id de la permission
        $this->rights[$r][1] = "Read all projects and tasks (also private projects I am not contact for)"; // libelle de la permission
        $this->rights[$r][2] = 'r'; // type de la permission (deprecated)
        $this->rights[$r][3] = 0; // La permission est-elle une permission par default
        $this->rights[$r][4] = 'all';
        $this->rights[$r][5] = 'lire';

        $r++;
        $this->rights[$r][0] = 142; // id de la permission
        $this->rights[$r][1] = "Create/modify all projects and tasks (also private projects I am not contact for)"; // libelle de la permission
        $this->rights[$r][2] = 'w'; // type de la permission (deprecated)
        $this->rights[$r][3] = 0; // La permission est-elle une permission par default
        $this->rights[$r][4] = 'all';
        $this->rights[$r][5] = 'creer';

        $r++;
        $this->rights[$r][0] = 144; // id de la permission
        $this->rights[$r][1] = "Delete all projects and tasks (also private projects I am not contact for)"; // libelle de la permission
        $this->rights[$r][2] = 'd'; // type de la permission (deprecated)
        $this->rights[$r][3] = 0; // La permission est-elle une permission par default
        $this->rights[$r][4] = 'all';
        $this->rights[$r][5] = 'supprimer';

        $r++;
        $this->rights[$r][0] = 145; // id de la permission
        $this->rights[$r][1] = "Can enter time consumed on assigned tasks (timesheet)"; // libelle de la permission
        $this->rights[$r][2] = 'w'; // type de la permission (deprecated)
        $this->rights[$r][3] = 0; // La permission est-elle une permission par default
        $this->rights[$r][4] = 'time';

        // Menus
        //-------
        $this->menu = 1; // This module add menu entries. They are coded into menu manager.


        // Exports
        //--------
        $r = 1;

        $this->export_code[$r] = $this->rights_class . '_' . $r;
        $this->export_label[$r] = 'ProjectsAndTasksLines'; // Translation key (used only if key ExportDataset_xxx_z not found)
        $this->export_permission[$r] = array(array("projet", "export"));
        $this->export_dependencies_array[$r] = array('projecttask' => 'pt.rowid', 'task_time' => 'ptt.rowid');

        $this->export_TypeFields_array[$r] = array(
            's.rowid' => "Numeric", 's.nom' => 'Text', 's.address' => 'Text', 's.zip' => 'Text', 's.town' => 'Text', 's.fk_pays' => 'List:c_country:label',
            's.phone' => 'Text', 's.email' => 'Text', 's.siren' => 'Text', 's.siret' => 'Text', 's.ape' => 'Text', 's.idprof4' => 'Text', 's.code_compta' => 'Text', 's.code_compta_fournisseur' => 'Text',
            'p.rowid' => "Numeric", 'p.ref' => "Text", 'p.title' => "Text",
            'p.usage_opportunity' => 'Boolean', 'p.usage_task' => 'Boolean', 'p.usage_bill_time' => 'Boolean',
            'p.datec' => "Date", 'p.dateo' => "Date", 'p.datee' => "Date", 'p.fk_statut' => 'Status', 'cls.code' => "Text", 'p.opp_percent' => 'Numeric', 'p.opp_amount' => 'Numeric', 'p.description' => "Text", 'p.entity' => 'Numeric', 'p.budget_amount' => 'Numeric',
            'pt.rowid' => 'Numeric', 'pt.ref' => 'Text', 'pt.label' => 'Text', 'pt.dateo' => "Date", 'pt.datee' => "Date", 'pt.duration_effective' => "Duree", 'pt.planned_workload' => "Numeric", 'pt.progress' => "Numeric", 'pt.description' => "Text",
            'ptt.rowid' => 'Numeric', 'ptt.element_date' => 'Date', 'ptt.element_duration' => "Duree", 'ptt.fk_user' => "FormSelect:select_dolusers", 'ptt.note' => "Text"
        );
        $this->export_entities_array[$r] = array(
            's.rowid' => "company", 's.nom' => 'company', 's.address' => 'company', 's.zip' => 'company', 's.town' => 'company', 's.fk_pays' => 'company',
            's.phone' => 'company', 's.email' => 'company', 's.siren' => 'company', 's.siret' => 'company', 's.ape' => 'company', 's.idprof4' => 'company', 's.code_compta' => 'company', 's.code_compta_fournisseur' => 'company'
        );
        $this->export_fields_array[$r] = array(
            's.rowid' => "IdCompany", 's.nom' => 'CompanyName', 's.address' => 'Address', 's.zip' => 'Zip', 's.town' => 'Town', 's.fk_pays' => 'Country',
            's.phone' => 'Phone', 's.email' => 'Email', 's.siren' => 'ProfId1', 's.siret' => 'ProfId2', 's.ape' => 'ProfId3', 's.idprof4' => 'ProfId4', 's.code_compta' => 'CustomerAccountancyCode', 's.code_compta_fournisseur' => 'SupplierAccountancyCode',
            'p.rowid' => "ProjectId", 'p.ref' => "RefProject", 'p.title' => 'ProjectLabel',
            'p.usage_opportunity' => 'ProjectFollowOpportunity', 'p.usage_task' => 'ProjectFollowTasks', 'p.usage_bill_time' => 'BillTime',
            'p.datec' => "DateCreation", 'p.dateo' => "DateStart", 'p.datee' => "DateEnd", 'p.fk_statut' => 'ProjectStatus', 'cls.code' => 'OpportunityStatus', 'p.opp_percent' => 'OpportunityProbability', 'p.opp_amount' => 'OpportunityAmount', 'p.budget_amount' => 'Budget', 'p.description' => "Description"
        );
        // Add multicompany field
        if (getDolGlobalString('MULTICOMPANY_ENTITY_IN_EXPORT_IF_SHARED')) {
            $nbofallowedentities = count(explode(',', getEntity('project'))); // If project are shared, nb will be > 1
            if (isModEnabled('multicompany') && $nbofallowedentities > 1) {
                $this->export_fields_array[$r] += array('p.entity' => 'Entity');
            }
        }
        if (!getDolGlobalString('PROJECT_USE_OPPORTUNITIES')) {
            unset($this->export_fields_array[$r]['p.opp_percent']);
            unset($this->export_fields_array[$r]['p.opp_amount']);
            unset($this->export_fields_array[$r]['cls.code']);
        }

        // Add fields for project
        $this->export_fields_array[$r] = array_merge($this->export_fields_array[$r], array());
        // Add extra fields for project
        $keyforselect = 'projet';
        $keyforelement = 'project';
        $keyforaliasextra = 'extra';
        include DOL_DOCUMENT_ROOT . '/core/extrafieldsinexport.inc.php';
        // Add fields for tasks
        $this->export_fields_array[$r] = array_merge($this->export_fields_array[$r], array('pt.rowid' => 'TaskId', 'pt.ref' => 'RefTask', 'pt.label' => 'LabelTask', 'pt.dateo' => "TaskDateStart", 'pt.datee' => "TaskDateEnd", 'pt.duration_effective' => "DurationEffective", 'pt.planned_workload' => "PlannedWorkload", 'pt.progress' => "Progress", 'pt.description' => "TaskDescription"));
        $this->export_entities_array[$r] = array_merge($this->export_entities_array[$r], array('pt.rowid' => 'projecttask', 'pt.ref' => 'projecttask', 'pt.label' => 'projecttask', 'pt.dateo' => "projecttask", 'pt.datee' => "projecttask", 'pt.duration_effective' => "projecttask", 'pt.planned_workload' => "projecttask", 'pt.progress' => "projecttask", 'pt.description' => "projecttask"));
        // Add extra fields for task
        $keyforselect = 'projet_task';
        $keyforelement = 'projecttask';
        $keyforaliasextra = 'extra2';
        include DOL_DOCUMENT_ROOT . '/core/extrafieldsinexport.inc.php';
        // End add extra fields
        $this->export_fields_array[$r] = array_merge($this->export_fields_array[$r], array('ptt.rowid' => 'IdTaskTime', 'ptt.element_date' => 'TaskTimeDate', 'ptt.element_duration' => "TimeSpent", 'ptt.fk_user' => "TaskTimeUser", 'ptt.note' => "TaskTimeNote"));
        $this->export_entities_array[$r] = array_merge($this->export_entities_array[$r], array('ptt.rowid' => 'task_time', 'ptt.element_date' => 'task_time', 'ptt.element_duration' => "task_time", 'ptt.fk_user' => "task_time", 'ptt.note' => "task_time"));
        if (!getDolGlobalString('PROJECT_HIDE_TASKS')) {
            $this->export_fields_array[$r] = array_merge($this->export_fields_array[$r], array('f.ref' => "Billed"));
            $this->export_entities_array[$r] = array_merge($this->export_entities_array[$r], array('f.ref' => "task_time"));
        }
        $this->export_sql_start[$r] = 'SELECT DISTINCT ';
        $this->export_sql_end[$r] = ' FROM ' . MAIN_DB_PREFIX . 'projet as p';
        $this->export_sql_end[$r] .= ' LEFT JOIN ' . MAIN_DB_PREFIX . 'projet_extrafields as extra ON p.rowid = extra.fk_object';
        $this->export_sql_end[$r] .= ' LEFT JOIN ' . MAIN_DB_PREFIX . 'c_lead_status as cls ON p.fk_opp_status = cls.rowid';
        $this->export_sql_end[$r] .= ' LEFT JOIN ' . MAIN_DB_PREFIX . "projet_task as pt ON p.rowid = pt.fk_projet";
        $this->export_sql_end[$r] .= ' LEFT JOIN ' . MAIN_DB_PREFIX . 'projet_task_extrafields as extra2 ON pt.rowid = extra2.fk_object';
        $this->export_sql_end[$r] .= ' LEFT JOIN ' . MAIN_DB_PREFIX . "element_time as ptt ON (pt.rowid = ptt.fk_element AND ptt.elementtype = 'task')";
        $this->export_sql_end[$r] .= ' LEFT JOIN ' . MAIN_DB_PREFIX . 'societe as s ON p.fk_soc = s.rowid';
        if (!getDolGlobalString('PROJECT_HIDE_TASKS')) {
            $this->export_sql_end[$r] .= ' LEFT JOIN ' . MAIN_DB_PREFIX . 'facture as f ON ptt.invoice_id = f.rowid';
        }
        $this->export_sql_end[$r] .= " WHERE p.entity IN (" . getEntity('project') . ")";

        // Import project/opportunities
        $r++;
        $this->import_code[$r] = 'projects';
        $this->import_label[$r] = 'ImportDatasetProjects';
        $this->import_icon[$r] = 'project';
        $this->import_entities_array[$r] = array(); // We define here only fields that use another icon that the one defined into import_icon
        $this->import_tables_array[$r] = array('t' => MAIN_DB_PREFIX . 'projet', 'extra' => MAIN_DB_PREFIX . 'projet_extrafields'); // List of tables to insert into (insert done in same order)
        $this->import_fields_array[$r] = array('t.ref' => 'ProjectRef*', 't.title' => 'Label*', 't.description' => "Description", 't.fk_soc' => 'ThirdPartyName', 't.public' => "Public", 't.fk_statut' => "Status");
        $this->import_fields_array[$r] = array_merge($this->import_fields_array[$r], array('t.fk_opp_status' => "OpportunityStatus", 't.opp_percent' => "OpportunityProbability", 't.opp_amount' => "OpportunityAmount", 't.note_public' => "NotePublic", 't.note_private' => "NotePrivate", 't.budget_amount' => "Budget", 't.dateo' => "DateStart", 't.datee' => "DateEnd"));
        // Add extra fields
        $sql = "SELECT name, label, fieldrequired FROM " . MAIN_DB_PREFIX . "extrafields WHERE type <> 'separate' AND elementtype = 'projet' AND entity IN (0," . $conf->entity . ")";
        $resql = $this->db->query($sql);
        if ($resql) {    // This can fail when class is used on old database (during migration for example)
            while ($obj = $this->db->fetch_object($resql)) {
                $fieldname = 'extra.' . $obj->name;
                $fieldlabel = ucfirst($obj->label);
                $this->import_fields_array[$r][$fieldname] = $fieldlabel . ($obj->fieldrequired ? '*' : '');
            }
        }
        // End add extra fields
        $this->import_fieldshidden_array[$r] = array('t.fk_user_creat' => 'user->id', 'extra.fk_object' => 'lastrowid-' . MAIN_DB_PREFIX . 'projet'); // aliastable.field => ('user->id' or 'lastrowid-'.tableparent)
        $this->import_convertvalue_array[$r] = array(
            't.ref' => array('rule' => 'getrefifauto', 'class' => (!getDolGlobalString('PROJECT_ADDON') ? 'mod_project_simple' : $conf->global->PROJECT_ADDON), 'path' => "/core/modules/project/" . (!getDolGlobalString('PROJECT_ADDON') ? 'mod_project_simple' : $conf->global->PROJECT_ADDON) . '.php'),
            't.fk_soc' => array(
                'rule' => 'fetchidfromref',
                'file' => '/societe/class/societe.class.php',
                'class' => 'Societe',
                'method' => 'fetch',
                'element' => 'ThirdParty'
            ),
        );
        //$this->import_convertvalue_array[$r]=array('s.fk_soc'=>array('rule'=>'lastrowid',table='t');
        $this->import_regex_array[$r] = array('t.dateo' => '^[0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9]$', 't.datee' => '^[0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9]$', 't.datec' => '^[0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9]( [0-9][0-9]:[0-9][0-9]:[0-9][0-9])?$');
        $this->import_examplevalues_array[$r] = array('t.fk_soc' => 'ThirdParty', 't.ref' => "auto or PJ2010-1234", 't.title' => "My project", 't.fk_statut' => '0,1 or 2', 't.datec' => '1972-10-10', 't.note_private' => "My private note", 't.note_public' => "My public note");

        // Import list of tasks
        if (!getDolGlobalString('PROJECT_HIDE_TASKS')) {
            $r++;
            $this->import_code[$r] = 'tasksofprojects';
            $this->import_label[$r] = 'ImportDatasetTasks';
            $this->import_icon[$r] = 'task';
            $this->import_entities_array[$r] = array('t.fk_projet' => 'project'); // We define here only fields that use another icon that the one defined into import_icon
            $this->import_tables_array[$r] = array('t' => MAIN_DB_PREFIX . 'projet_task', 'extra' => MAIN_DB_PREFIX . 'projet_task_extrafields'); // List of tables to insert into (insert done in same order)
            $this->import_fields_array[$r] = array('t.fk_projet' => 'ProjectRef*', 't.ref' => 'RefTask*', 't.label' => 'LabelTask*', 't.dateo' => "DateStart", 't.datee' => "DateEnd", 't.planned_workload' => "PlannedWorkload", 't.progress' => "Progress", 't.note_private' => "NotePrivate", 't.note_public' => "NotePublic", 't.datec' => "DateCreation");
            // Add extra fields
            $sql = "SELECT name, label, fieldrequired FROM " . MAIN_DB_PREFIX . "extrafields WHERE type <> 'separate' AND elementtype = 'projet_task' AND entity IN (0," . $conf->entity . ")";
            $resql = $this->db->query($sql);
            if ($resql) {    // This can fail when class is used on old database (during migration for example)
                while ($obj = $this->db->fetch_object($resql)) {
                    $fieldname = 'extra.' . $obj->name;
                    $fieldlabel = ucfirst($obj->label);
                    $this->import_fields_array[$r][$fieldname] = $fieldlabel . ($obj->fieldrequired ? '*' : '');
                }
            }
            // End add extra fields
            $this->import_fieldshidden_array[$r] = array('t.fk_user_creat' => 'user->id', 'extra.fk_object' => 'lastrowid-' . MAIN_DB_PREFIX . 'projet_task'); // aliastable.field => ('user->id' or 'lastrowid-'.tableparent)
            $this->import_convertvalue_array[$r] = array(
                't.fk_projet' => array('rule' => 'fetchidfromref', 'classfile' => '/projet/class/project.class.php', 'class' => 'Project', 'method' => 'fetch', 'element' => 'Project'),
                't.ref' => array('rule' => 'getrefifauto', 'class' => (!getDolGlobalString('PROJECT_TASK_ADDON') ? 'mod_task_simple' : $conf->global->PROJECT_TASK_ADDON), 'path' => "/core/modules/project/task/" . (!getDolGlobalString('PROJECT_TASK_ADDON') ? 'mod_task_simple' : $conf->global->PROJECT_TASK_ADDON) . '.php')
            );
            //$this->import_convertvalue_array[$r]=array('s.fk_soc'=>array('rule'=>'lastrowid',table='t');
            $this->import_regex_array[$r] = array('t.dateo' => '^[0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9]$', 't.datee' => '^[0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9]$', 't.datec' => '^[0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9]( [0-9][0-9]:[0-9][0-9]:[0-9][0-9])?$');
            $this->import_examplevalues_array[$r] = array('t.fk_projet' => 'MyProjectRef', 't.ref' => "auto or TK2010-1234", 't.label' => "My task", 't.progress' => "0 (not started) to 100 (finished)", 't.datec' => '1972-10-10', 't.note_private' => "My private note", 't.note_public' => "My public note");
        }