actions_mymodule.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) ---Put here your own copyright and developer email---
 *
 * 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/>.
 */

class ActionsMyModule
{
  public $db;

  public $error = '';

  public $errors = array();


  public $results = array();

  public $resprints;


  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)
  {
    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'
    {
      // Do what you want here...
      // You can for example call global vars like $fieldstosearchall to overwrite them, or update database depending on $action and $_POST 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;
    }
  }


  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'
    {
      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;
    }
  }


  public function addMoreMassActions($parameters, &$object, &$action, $hookmanager)
  {
    global $conf, $user, $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; */
    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; */
    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 $conf, $user, $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;

    return 1;
  }



  public function restrictedArea($parameters, &$action, $hookmanager)
  {
    global $user;

    if ($parameters['features'] == 'myobject') {
      if ($user->rights->mymodule->myobject->read) {
        $this->results['result'] = 1;
        return 1;
      } else {
        $this->results['result'] = 0;
        return 1;
      }
    }

    return 0;
  }

  /* Add here any other hooked methods... */
}