actions_mymodule.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2023   Laurent Destailleur     <eldy@users.sourceforge.net>
 * Copyright (C) ---Replace with your own copyright and developer email---
 * Copyright (C) 2026       Frédéric France         <frederic.france@free.fr>
 *
 * 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 <https://www.gnu.org/licenses/>.
 */
 
require_once DOL_DOCUMENT_ROOT.'/core/class/commonhookactions.class.php';
 
class ActionsMyModule extends CommonHookActions
{
  public $db;
 
  public $error = '';
 
  public $errors = array();
 
 
  public $results = array();
 
  public $resprints;
 
  public $priority;
 
 
  public function __construct($db)
  {
    $this->db = $db;
  }
 
 
  public function getNomUrl($parameters, &$object, &$action)
  {
    global $db, $langs, $conf, $user;
    $this->resprints = '';
    return 0;
  }
 
  public function doActions($parameters, &$object, &$action, $hookmanager)
  {
    $error = 0; // Error counter
 
    /* print_r($parameters); print_r($object); echo "action: " . $action; */
    if (in_array($parameters['currentcontext'], array('somecontext1', 'somecontext2'))) {     // do something only for the context 'somecontext1' or 'somecontext2'
      // Do what you want here...
      // You can for example load and use call global vars like $fieldstosearchall to overwrite them, or update the database depending on $action and GETPOST values.
 
      if (!$error) {
        $this->results = array('myreturn' => 999);
        $this->resprints = 'A text to show';
        return 0; // or return 1 to replace standard code
      } else {
        $this->errors[] = 'Error message';
        return -1;
      }
    }
 
    return 0;
  }
 
 
  public function doMassActions($parameters, &$object, &$action, $hookmanager)
  {
    global $conf, $user, $langs;
 
    $error = 0; // Error counter
 
    /* print_r($parameters); print_r($object); echo "action: " . $action; */
    if (in_array($parameters['currentcontext'], array('somecontext1', 'somecontext2'))) {   // do something only for the context 'somecontext1' or 'somecontext2'
      // @phan-suppress-next-line PhanPluginEmptyStatementForeachLoop
      foreach ($parameters['toselect'] as $objectid) {
        // Do action on each object id
      }
 
      if (!$error) {
        $this->results = array('myreturn' => 999);
        $this->resprints = 'A text to show';
        return 0; // or return 1 to replace standard code
      } else {
        $this->errors[] = 'Error message';
        return -1;
      }
    }
 
    return 0;
  }
 
 
  public function addMoreMassActions($parameters, &$object, &$action, $hookmanager)
  {
    global $langs;
 
    $error = 0; // Error counter
    $disabled = 1;
 
    /* print_r($parameters); print_r($object); echo "action: " . $action; */
    if (in_array($parameters['currentcontext'], array('somecontext1', 'somecontext2'))) {   // do something only for the context 'somecontext1' or 'somecontext2'
      $this->resprints = '<option value="0"'.($disabled ? ' disabled="disabled"' : '').'>'.$langs->trans("MyModuleMassAction").'</option>';
    }
 
    if (!$error) {
      return 0; // or return 1 to replace standard code
    } else {
      $this->errors[] = 'Error message';
      return -1;
    }
  }
 
 
 
  public function beforePDFCreation($parameters, &$object, &$action)
  {
    global $conf, $user, $langs;
    global $hookmanager;
 
    $outputlangs = $langs;
 
    $ret = 0;
    $deltemp = array();
    dol_syslog(get_class($this).'::executeHooks action='.$action);
 
    /* print_r($parameters); print_r($object); echo "action: " . $action; */
    // @phan-suppress-next-line PhanPluginEmptyStatementIf
    if (in_array($parameters['currentcontext'], array('somecontext1', 'somecontext2'))) {
      // do something only for the context 'somecontext1' or 'somecontext2'
    }
 
    return $ret;
  }
 
  public function afterPDFCreation($parameters, &$pdfhandler, &$action)
  {
    global $conf, $user, $langs;
    global $hookmanager;
 
    $outputlangs = $langs;
 
    $ret = 0;
    $deltemp = array();
    dol_syslog(get_class($this).'::executeHooks action='.$action);
 
    /* print_r($parameters); print_r($object); echo "action: " . $action; */
    // @phan-suppress-next-line PhanPluginEmptyStatementIf
    if (in_array($parameters['currentcontext'], array('somecontext1', 'somecontext2'))) {
      // do something only for the context 'somecontext1' or 'somecontext2'
    }
 
    return $ret;
  }
 
 
 
  public function loadDataForCustomReports($parameters, &$action, $hookmanager)
  {
    global $langs;
 
    $langs->load("mymodule@mymodule");
 
    $this->results = array();
 
    $head = array();
    $h = 0;
 
    if ($parameters['tabfamily'] == 'mymodule') {
      $head[$h][0] = dol_buildpath('/module/index.php', 1);
      $head[$h][1] = $langs->trans("Home");
      $head[$h][2] = 'home';
      $h++;
 
      $this->results['title'] = $langs->trans("MyModule");
      $this->results['picto'] = 'mymodule@mymodule';
    }
 
    $head[$h][0] = 'customreports.php?objecttype='.$parameters['objecttype'].(empty($parameters['tabfamily']) ? '' : '&tabfamily='.$parameters['tabfamily']);
    $head[$h][1] = $langs->trans("CustomReports");
    $head[$h][2] = 'customreports';
 
    $this->results['head'] = $head;
 
    $arrayoftypes = array();
    //$arrayoftypes['mymodule_myobject'] = array('label' => 'MyObject', 'picto'=>'myobject@mymodule', 'ObjectClassName' => 'MyObject', 'enabled' => isModEnabled('mymodule'), 'ClassPath' => "/mymodule/class/myobject.class.php", 'langs'=>'mymodule@mymodule')
 
    $this->results['arrayoftype'] = $arrayoftypes;
 
    return 0;
  }
 
 
 
  public function restrictedArea($parameters, $object, &$action, $hookmanager)
  {
    global $user;
 
    if ($parameters['features'] == 'myobject') {
      if ($user->hasRight('mymodule', 'myobject', 'read')) {
        $this->results['result'] = 1;
        return 1;
      } else {
        $this->results['result'] = 0;
        return 1;
      }
    }
 
    return 0;
  }
 
  public function completeTabsHead(&$parameters, &$object, &$action, $hookmanager)
  {
    global $langs, $conf, $user;
 
    if (!isset($parameters['object']->element)) {
      return 0;
    }
    if ($parameters['mode'] == 'remove') {
      // used to make some tabs removed
      return 0;
    } elseif ($parameters['mode'] == 'add') {
      $langs->load('mymodule@mymodule');
      // used when we want to add some tabs
      $counter = count($parameters['head']);
      $element = $parameters['object']->element;
      $id = $parameters['object']->id;
      // check the tab type like member_stats where it should not appear
      // if (in_array($element, ['societe', 'member', 'contrat', 'fichinter', 'project', 'propal', 'commande', 'facture', 'order_supplier', 'invoice_supplier'])) {
      if (in_array($element, ['context1', 'context2'])) {
        $datacount = 0;
 
        $parameters['head'][$counter][0] = dol_buildpath('/mymodule/mymodule_tab.php', 1) . '?id=' . $id . '&amp;module='.$element;
        $parameters['head'][$counter][1] = $langs->trans('MyModuleTab');
        if ($datacount > 0) {
          $parameters['head'][$counter][1] .= '<span class="badge marginleftonlyshort">' . $datacount . '</span>';
        }
        $parameters['head'][$counter][2] = 'mymoduleemails';
        $counter++;
      }
      if ($counter > 0 && (int) DOL_VERSION < 14) {  // @phpstan-ignore-line
        $this->results = $parameters['head'];
        // return 1 to replace standard code
        return 1;
      } else {
        // From V14 onwards, $parameters['head'] is modifiable by reference
        return 0;
      }
    } else {
      // Bad value for $parameters['mode']
      return -1;
    }
  }
 
 
  public function showLinkToObjectBlock($parameters, &$object, &$action, $hookmanager)
  {
    $myobject = new MyObject($object->db);
    $this->results = array('myobject@mymodule' => array(
      'enabled' => isModEnabled('mymodule'),
      'perms' => 1,
      'label' => 'LinkToMyObject',
      'sql' => "SELECT t.rowid, t.ref, t.ref as 'name' FROM " . $this->db->prefix() . $myobject->table_element. " as t "),);
 
    return 1;
  }
  /* Add other hook methods here... */
}