myobject.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2017       Laurent Destailleur      <eldy@users.sourceforge.net>
 * Copyright (C) 2023-2025  Frédéric France          <frederic.france@free.fr>
 * Copyright (C) ---Replace with 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/>.
 */
 
// Put here all includes required by your class file
require_once DOL_DOCUMENT_ROOT.'/core/class/commonobject.class.php';
//require_once DOL_DOCUMENT_ROOT . '/societe/class/societe.class.php';
//require_once DOL_DOCUMENT_ROOT . '/product/class/product.class.php';
 
class MyObject extends CommonObject
{
  public $module = 'mymodule';
 
  public $element = 'myobject';
 
  public $TRIGGER_PREFIX = 'MYMODULE_MYOBJECT'; // Will be used to build trgiger keys 'MYMODULE_MYOBJECT_MODIFY', ...
 
  public $table_element = 'mymodule_myobject';
 
  //public $element_for_permission = 'mymodule';
 
  public $picto = 'fa-file';
 
  public $isextrafieldmanaged = 0;
 
  public $ismultientitymanaged = 0;
 
 
  const STATUS_DRAFT = 0;
  const STATUS_VALIDATED = 1;
  const STATUS_CANCELED = 9;
 
  // BEGIN MODULEBUILDER PROPERTIES
  public $fields = array(
    'rowid' => array('type' => 'integer', 'label' => 'TechnicalID', 'enabled' => 1, 'position' => 1, 'notnull' => 1, 'visible' => 0, 'noteditable' => 1, 'index' => 1, 'css' => 'left', 'comment' => 'Id', 'lang' => 'mymodule@mymodule'),
    'ref' => array('type' => 'varchar(128)', 'label' => 'Ref', 'enabled' => 1, 'position' => 20, 'notnull' => 1, 'visible' => 1, 'index' => 1, 'searchall' => 1, 'showoncombobox' => 1, 'validate' => 1, 'comment' => 'Reference of object', 'lang' => 'mymodule@mymodule'),
    'label' => array('type' => 'varchar(255)', 'label' => 'Label', 'enabled' => 1, 'position' => 30, 'notnull' => 0, 'visible' => 1, 'alwayseditable' => 1, 'searchall' => 1, 'css' => 'minwidth300', 'cssview' => 'wordbreak', 'help' => 'Help text', 'showoncombobox' => 2, 'validate' => 1, 'lang' => 'mymodule@mymodule'),
    'amount' => array('type' => 'price', 'label' => 'Amount', 'enabled' => 1, 'position' => 40, 'notnull' => 0, 'visible' => 1, 'default' => 'null', 'isameasure' => 1, 'help' => 'Help text for amount', 'validate' => 1, 'lang' => 'mymodule@mymodule'),
    'qty' => array('type' => 'real', 'label' => 'Qty', 'enabled' => 1, 'position' => 45, 'notnull' => 0, 'visible' => 1, 'default' => '0', 'isameasure' => 1, 'css' => 'maxwidth75imp', 'help' => 'Help text for quantity', 'validate' => 1, 'lang' => 'mymodule@mymodule'),
    'fk_soc' => array('type' => 'integer:Societe:societe/class/societe.class.php:1:((status:=:1) AND (entity:IN:__SHARED_ENTITIES__))', 'label' => 'ThirdParty', 'picto' => 'company', 'enabled' => 'isModEnabled("societe")', 'position' => 50, 'notnull' => -1, 'visible' => 1, 'index' => 1, 'css' => 'maxwidth500 widthcentpercentminusxx', 'csslist' => 'tdoverflowmax150', 'help' => 'OrganizationEventLinkToThirdParty', 'validate' => 1, 'lang' => 'mymodule@mymodule'),
    'fk_project' => array('type' => 'integer:Project:projet/class/project.class.php:1', 'label' => 'Project', 'picto' => 'project', 'enabled' => 'isModEnabled("project")', 'position' => 52, 'notnull' => -1, 'visible' => -1, 'index' => 1, 'css' => 'maxwidth500 widthcentpercentminusxx', 'csslist' => 'tdoverflowmax150', 'validate' => 1, 'lang' => 'mymodule@mymodule'),
    'description' => array('type' => 'text', 'label' => 'Description', 'enabled' => 1, 'position' => 60, 'notnull' => 0, 'visible' => 3, 'validate' => 1, 'lang' => 'mymodule@mymodule'),
    'note_public' => array('type' => 'html', 'label' => 'NotePublic', 'enabled' => 1, 'position' => 61, 'notnull' => 0, 'visible' => 0, 'cssview' => 'wordbreak', 'validate' => 1, 'lang' => 'mymodule@mymodule'),
    'note_private' => array('type' => 'html', 'label' => 'NotePrivate', 'enabled' => 1, 'position' => 62, 'notnull' => 0, 'visible' => 0, 'cssview' => 'wordbreak', 'validate' => 1, 'lang' => 'mymodule@mymodule'),
    'date_creation' => array('type' => 'datetime', 'label' => 'DateCreation', 'enabled' => 1, 'position' => 500, 'notnull' => 1, 'visible' => -2, 'lang' => 'mymodule@mymodule'),
    'tms' => array('type' => 'timestamp', 'label' => 'DateModification', 'enabled' => 1, 'position' => 501, 'notnull' => 0, 'visible' => -2, 'lang' => 'mymodule@mymodule'),
    'fk_user_creat' => array('type' => 'integer:User:user/class/user.class.php', 'label' => 'UserAuthor', 'picto' => 'user', 'enabled' => 1, 'position' => 510, 'notnull' => 1, 'visible' => -2, 'foreignkey' => '0', 'csslist' => 'tdoverflowmax150', 'lang' => 'mymodule@mymodule'),
    'fk_user_modif' => array('type' => 'integer:User:user/class/user.class.php', 'label' => 'UserModif', 'picto' => 'user', 'enabled' => 1, 'position' => 511, 'notnull' => -1, 'visible' => -2, 'csslist' => 'tdoverflowmax150', 'lang' => 'mymodule@mymodule'),
    'last_main_doc' => array('type' => 'varchar(255)', 'label' => 'LastMainDoc', 'enabled' => 1, 'position' => 600, 'notnull' => 0, 'visible' => 0, 'lang' => 'mymodule@mymodule'),
    'import_key' => array('type' => 'varchar(14)', 'label' => 'ImportId', 'enabled' => 1, 'position' => 1000, 'notnull' => -1, 'visible' => -2, 'lang' => 'mymodule@mymodule'),
    'model_pdf' => array('type' => 'varchar(255)', 'label' => 'Model pdf', 'enabled' => 1, 'position' => 1010, 'notnull' => -1, 'visible' => 0, 'lang' => 'mymodule@mymodule'),
    'status' => array('type' => 'integer', 'label' => 'Status', 'enabled' => 1, 'position' => 2000, 'notnull' => 1, 'visible' => 1, 'index' => 1, 'arrayofkeyval' => array(0 => 'Draft', '1' => 'Validated', 9 => 'Canceled'), 'validate' => 1, 'lang' => 'mymodule@mymodule'),
  );
 
  public $rowid;
 
  public $ref;
 
  public $label;
 
  public $amount;
 
  public $socid;    // both socid and fk_soc are used
  public $fk_soc;   // both socid and fk_soc are used
 
  public $status;
 
  public $fk_user_creat;
 
  public $fk_user_modif;
 
  public $last_main_doc;
 
  public $import_key;
  // END MODULEBUILDER PROPERTIES
 
 
  // If this object has a subtable with lines
 
  // /**
  //  * @var string    Name of subtable line
  //  */
  // public $table_element_line = 'mymodule_myobjectline';
 
  // /**
  //  * @var string    Field name with ID of parent key if this object has a parent, Or Field name of in child tables to link to this record.
  //  */
  // public $fk_element = 'fk_myobject';
 
  // /**
  //  * @var string    Name of subtable class that manage subtable lines
  //  */
  // public $class_element_line = 'MyObjectline';
 
  // /**
  //  * @var array  List of child tables. To test if we can delete object.
  //  */
  // protected $childtables = array('mychildtable' => array('name'=>'MyObject', 'fk_element'=>'fk_myobject'));
 
  // /**
  //  * @var array    List of child tables. To know object to delete on cascade.
  //  *               If name matches '@ClassName:FilePathClass:ParentFkFieldName' (the recommended mode) it will
  //  *               call method ClassName->deleteByParentField(parentId, 'ParentFkFieldName') to fetch and delete child object.
  //  *               Using an array like childtables should not be implemented because a child may have other child, so we must only use the method that call deleteByParentField().
  //  */
  // protected $childtablesoncascade = array('mymodule_myobjectdet');
 
  // /**
  //  * @var MyObjectLine[]     Array of subtable lines
  //  */
  // public $lines = array();
 
 
 
  public function __construct(DoliDB $db)
  {
    global $langs;
 
    $this->db = $db;
 
    if (!getDolGlobalInt('MAIN_SHOW_TECHNICAL_ID') && isset($this->fields['rowid']) && !empty($this->fields['ref'])) {
      $this->fields['rowid']['visible'] = 0;
    }
    if (!isModEnabled('multicompany') && isset($this->fields['entity'])) {
      $this->fields['entity']['enabled'] = 0;
    }
 
    // Example to show how to set values of fields definition dynamically
    /*if ($user->hasRight('mymodule', 'myobject', 'read')) {
      $this->fields['myfield']['visible'] = 1;
      $this->fields['myfield']['noteditable'] = 0;
    }*/
 
    // Unset fields that are disabled
    foreach ($this->fields as $key => $val) {
      if (isset($val['enabled']) && empty($val['enabled'])) {
        unset($this->fields[$key]);
      }
    }
 
    // Translate some data of arrayofkeyval
    if (is_object($langs)) {
      foreach ($this->fields as $key => $val) {
        if (!empty($val['arrayofkeyval']) && is_array($val['arrayofkeyval'])) {
          foreach ($val['arrayofkeyval'] as $key2 => $val2) {
            $this->fields[$key]['arrayofkeyval'][$key2] = $langs->trans($val2);
          }
        }
      }
    }
  }
 
  public function create(User $user, $notrigger = 0)
  {
    $result = $this->createCommon($user, $notrigger);
 
    // uncomment lines below if you want to validate object after creation
    // if ($result > 0) {
    // $this->fetch($this->id); // needed to retrieve some fields (ie date_creation for masked ref)
    // $resultupdate = $this->validate($user, $notrigger);
    // if ($resultupdate < 0) { return $resultupdate; }
    // }
 
    return $result;
  }
 
  public function createFromClone(User $user, $fromid)
  {
    global $langs, $extrafields;
    $error = 0;
 
    dol_syslog(__METHOD__, LOG_DEBUG);
 
    $object = new self($this->db);
 
    $this->db->begin();
 
    // Load source object
    $result = $object->fetchCommon($fromid);
    if ($result > 0 && !empty($object->table_element_line)) {
      $object->fetchLines();
    }
 
    // get lines so they will be clone
    //foreach($this->lines as $line)
    //  $line->fetch_optionals();
 
    // Reset some properties
    unset($object->id);
    unset($object->fk_user_creat);
    unset($object->import_key);
 
    // Clear fields
    if (property_exists($object, 'ref')) {
      $object->ref = empty($this->fields['ref']['default']) ? "Copy_Of_".$object->ref : $this->fields['ref']['default'];
    }
    if (property_exists($object, 'label')) {
      $object->label = empty($this->fields['label']['default']) ? $langs->trans("CopyOf")." ".$object->label : $this->fields['label']['default'];
    }
    if (property_exists($object, 'status')) {
      $object->status = self::STATUS_DRAFT;
    }
    if (property_exists($object, 'date_creation')) {
      $object->date_creation = dol_now();
    }
    if (property_exists($object, 'date_modification')) {
      $object->date_modification = null;
    }
    // ...
    // Clear extrafields that are unique
    if (is_array($object->array_options) && count($object->array_options) > 0) {
      $extrafields->fetch_name_optionals_label($this->table_element);
      foreach ($object->array_options as $key => $option) {
        $shortkey = preg_replace('/options_/', '', $key);
        if (!empty($extrafields->attributes[$this->table_element]['unique'][$shortkey])) {
          //var_dump($key);
          //var_dump($clonedObj->array_options[$key]); exit;
          unset($object->array_options[$key]);
        }
      }
    }
 
    // Create clone
    $object->context['createfromclone'] = 'createfromclone';
    $result = $object->createCommon($user);
    if ($result < 0) {
      $error++;
      $this->setErrorsFromObject($object);
    }
 
    if (!$error) {
      // copy internal contacts
      if ($this->copy_linked_contact($object, 'internal') < 0) {
        $error++;
      }
    }
 
    if (!$error) {
      // copy external contacts if same company
      if (!empty($object->socid) && ((property_exists($this, 'fk_soc') && ($this->fk_soc == $object->socid)) || (property_exists($this, 'socid') && ($this->socid == $object->socid)))) { // @phpstan-ignore-line
        if ($this->copy_linked_contact($object, 'external') < 0) {
          $error++;
        }
      }
    }
 
    unset($object->context['createfromclone']);
 
    // End
    if (!$error) {
      $this->db->commit();
      return $object;
    } else {
      $this->db->rollback();
      return -1;
    }
  }
 
  public function fetch($id, $ref = null, $noextrafields = 0, $nolines = 0)
  {
    $result = $this->fetchCommon($id, $ref, '', $noextrafields);
    if ($result > 0 && !empty($this->table_element_line) && empty($nolines)) {
      $this->fetchLines($noextrafields);
    }
    return $result;
  }
 
  public function fetchLines($noextrafields = 0)
  {
    $this->lines = array();
 
    $result = $this->fetchLinesCommon('', $noextrafields);
    return $result;
  }
 
 
  public function fetchAll($sortorder = '', $sortfield = '', $limit = 1000, $offset = 0, string $filter = '', $filtermode = 'AND')
  {
    dol_syslog(__METHOD__, LOG_DEBUG);
 
    $records = array();
 
    $sql = "SELECT ";
    $sql .= $this->getFieldList('t');
    $sql .= " FROM ".$this->db->prefix().$this->table_element." as t";
    if (!empty($this->isextrafieldmanaged) && $this->isextrafieldmanaged == 1) {
      $sql .= " LEFT JOIN ".$this->db->prefix().$this->table_element."_extrafields as te ON te.fk_object = t.rowid";
    }
    if (!empty($this->ismultientitymanaged) && (int) $this->ismultientitymanaged == 1) {
      $sql .= " WHERE t.entity IN (".getEntity($this->element).")";
    } elseif (preg_match('/^\w+@\w+$/', (string) $this->ismultientitymanaged)) {
      $tmparray = explode('@', (string) $this->ismultientitymanaged);
      $sql .= " LEFT JOIN ".$this->db->prefix().$tmparray[1]." as pt ON t.".$this->db->sanitize($tmparray[0])." = pt.rowid";
      $sql .= " WHERE pt.entity IN (".getEntity($this->element).")";
    } else {
      $sql .= " WHERE 1 = 1";
    }
 
    // Manage filter
    $errormessage = '';
    $sql .= forgeSQLFromUniversalSearchCriteria($filter, $errormessage);
    if ($errormessage) {
      $this->errors[] = $errormessage;
      dol_syslog(__METHOD__.' '.implode(',', $this->errors), LOG_ERR);
      return -1;
    }
 
    if (!empty($sortfield)) {
      $sql .= $this->db->order($sortfield, $sortorder);
    }
    if (!empty($limit)) {
      $sql .= $this->db->plimit($limit, $offset);
    }
 
    $resql = $this->db->query($sql);
    if ($resql) {
      $num = $this->db->num_rows($resql);
      $i = 0;
      while ($i < ($limit ? min($limit, $num) : $num)) {
        $obj = $this->db->fetch_object($resql);
 
        $record = new self($this->db);
        $record->setVarsFromFetchObj($obj);
 
        if (!empty($record->isextrafieldmanaged)) {
          $record->fetch_optionals();
        }
 
        $records[$record->id] = $record;
 
        $i++;
      }
      $this->db->free($resql);
 
      return $records;
    } else {
      $this->errors[] = 'Error '.$this->db->lasterror();
      dol_syslog(__METHOD__.' '.implode(',', $this->errors), LOG_ERR);
 
      return -1;
    }
  }
 
  public function update(User $user, $notrigger = 0)
  {
    return $this->updateCommon($user, $notrigger);
  }
 
  public function delete(User $user, $notrigger = 0)
  {
    return $this->deleteCommon($user, $notrigger);
    //return $this->deleteCommon($user, $notrigger, 1);
  }
 
  public function deleteLine(User $user, $idline, $notrigger = 0)
  {
    if ($this->status < 0) {
      $this->error = 'ErrorDeleteLineNotAllowedByObjectStatus';
      return -2;
    }
 
    return $this->deleteLineCommon($user, $idline, $notrigger);
  }
 
 
  public function validate($user, $notrigger = 0)
  {
    global $conf;
 
    require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
 
    $error = 0;
 
    // Protection
    if ($this->status == self::STATUS_VALIDATED) {
      dol_syslog(get_class($this)."::validate action abandoned: already validated", LOG_WARNING);
      return 0;
    }
 
    /* if (! ((!getDolGlobalInt('MAIN_USE_ADVANCED_PERMS') && $user->hasRight('mymodule', 'myobject', 'write'))
     || (getDolGlobalInt('MAIN_USE_ADVANCED_PERMS') && $user->hasRight('mymodule', 'myobject_advance', 'validate')))
     {
     $this->error='NotEnoughPermissions';
     dol_syslog(get_class($this)."::valid ".$this->error, LOG_ERR);
     return -1;
     }*/
 
    $now = dol_now();
 
    $this->db->begin();
 
    // Define new ref
    if (preg_match('/^[\‍(]?PROV/i', $this->ref) || empty($this->ref)) { // empty should not happened, but when it occurs, the test save life
      $num = $this->getNextNumRef();
    } else {
      $num = (string) $this->ref;
    }
    $this->newref = $num;
 
    if (!empty($num)) {
      // Validate
      $sql = "UPDATE ".$this->db->prefix().$this->table_element;
      $sql .= " SET ";
      if (!empty($this->fields['ref'])) {
        $sql .= " ref = '".$this->db->escape($num)."',";
      }
      $sql .= " status = ".self::STATUS_VALIDATED;
      if (!empty($this->fields['date_validation'])) {
        $sql .= ", date_validation = '".$this->db->idate($now)."'";
      }
      if (!empty($this->fields['fk_user_valid'])) {
        $sql .= ", fk_user_valid = ".((int) $user->id);
      }
      $sql .= " WHERE rowid = ".((int) $this->id);
 
      dol_syslog(get_class($this)."::validate()", LOG_DEBUG);
      $resql = $this->db->query($sql);
      if (!$resql) {
        dol_print_error($this->db);
        $this->error = $this->db->lasterror();
        $error++;
      }
 
      if (!$error && !$notrigger) {
        // Call trigger
        $result = $this->call_trigger('MYOBJECT_VALIDATE', $user);
        if ($result < 0) {
          $error++;
        }
        // End call triggers
      }
    }
 
    if (!$error) {
      $this->oldref = $this->ref;
 
      // Rename directory if dir was a temporary ref
      if (preg_match('/^[\‍(]?PROV/i', $this->ref)) {
        // Now we rename also files into index
        $sql = 'UPDATE '.$this->db->prefix()."ecm_files set filename = CONCAT('".$this->db->escape($this->newref)."', SUBSTR(filename, ".(strlen($this->ref) + 1).")), filepath = 'myobject/".$this->db->escape($this->newref)."'";
        $sql .= " WHERE filename LIKE '".$this->db->escape($this->ref)."%' AND filepath = 'myobject/".$this->db->escape($this->ref)."' and entity = ".$conf->entity;
        $resql = $this->db->query($sql);
        if (!$resql) {
          $error++;
          $this->error = $this->db->lasterror();
        }
        $sql = 'UPDATE '.$this->db->prefix()."ecm_files set filepath = 'myobject/".$this->db->escape($this->newref)."'";
        $sql .= " WHERE filepath = 'myobject/".$this->db->escape($this->ref)."' and entity = ".$conf->entity;
        $resql = $this->db->query($sql);
        if (!$resql) {
          $error++;
          $this->error = $this->db->lasterror();
        }
 
        // We rename directory ($this->ref = old ref, $num = new ref) in order not to lose the attachments
        $oldref = dol_sanitizeFileName($this->ref);
        $newref = dol_sanitizeFileName($num);
        $dirsource = $conf->mymodule->dir_output.'/myobject/'.$oldref;
        $dirdest = $conf->mymodule->dir_output.'/myobject/'.$newref;
        if (!$error && file_exists($dirsource)) {
          dol_syslog(get_class($this)."::validate() rename dir ".$dirsource." into ".$dirdest);
 
          if (@rename($dirsource, $dirdest)) {
            dol_syslog("Rename ok");
            // Rename docs starting with $oldref with $newref
            $listoffiles = dol_dir_list($conf->mymodule->dir_output.'/myobject/'.$newref, 'files', 1, '^'.preg_quote($oldref, '/'));
            foreach ($listoffiles as $fileentry) {
              $dirsource = $fileentry['name'];
              $dirdest = preg_replace('/^'.preg_quote($oldref, '/').'/', $newref, $dirsource);
              $dirsource = $fileentry['path'].'/'.$dirsource;
              $dirdest = $fileentry['path'].'/'.$dirdest;
              @rename($dirsource, $dirdest);
            }
          }
        }
      }
    }
 
    // Set new ref and current status
    if (!$error) {
      $this->ref = $num;
      $this->status = self::STATUS_VALIDATED;
    }
 
    if (!$error) {
      $this->db->commit();
      return 1;
    } else {
      $this->db->rollback();
      return -1;
    }
  }
 
 
  public function setDraft($user, $notrigger = 0)
  {
    // Protection
    if ($this->status <= self::STATUS_DRAFT) {
      return 0;
    }
 
    /* if (! ((!getDolGlobalInt('MAIN_USE_ADVANCED_PERMS') && $user->hasRight('mymodule','write'))
     || (getDolGlobalInt('MAIN_USE_ADVANCED_PERMS') && $user->hasRight('mymodule','mymodule_advance','validate'))))
     {
     $this->error='Permission denied';
     return -1;
     }*/
 
    return $this->setStatusCommon($user, self::STATUS_DRAFT, $notrigger, 'MYMODULE_MYOBJECT_UNVALIDATE');
  }
 
  public function cancel($user, $notrigger = 0)
  {
    // Protection
    if ($this->status != self::STATUS_VALIDATED) {
      return 0;
    }
 
    /* if (! ((!getDolGlobalInt('MAIN_USE_ADVANCED_PERMS') && $user->hasRight('mymodule','write'))
     || (getDolGlobalInt('MAIN_USE_ADVANCED_PERMS') && $user->hasRight('mymodule','mymodule_advance','validate'))))
     {
     $this->error='Permission denied';
     return -1;
     }*/
 
    return $this->setStatusCommon($user, self::STATUS_CANCELED, $notrigger, 'MYMODULE_MYOBJECT_CANCEL');
  }
 
  public function reopen($user, $notrigger = 0)
  {
    // Protection
    if ($this->status == self::STATUS_VALIDATED) {
      return 0;
    }
 
    /*if (! ((!getDolGlobalInt('MAIN_USE_ADVANCED_PERMS') && $user->hasRight('mymodule','write'))
     || (getDolGlobalInt('MAIN_USE_ADVANCED_PERMS') && $user->hasRight('mymodule','mymodule_advance','validate'))))
     {
     $this->error='Permission denied';
     return -1;
     }*/
 
    return $this->setStatusCommon($user, self::STATUS_VALIDATED, $notrigger, 'MYMODULE_MYOBJECT_REOPEN');
  }
 
  public function getTooltipContentArray($params)
  {
    global $langs;
 
    $datas = [];
 
    if (getDolGlobalInt('MAIN_OPTIMIZEFORTEXTBROWSER')) {
      return ['optimize' => $langs->trans("ShowMyObject")];
    }
    $datas['picto'] = img_picto('', $this->picto).' <u>'.$langs->trans("MyObject").'</u>';
    if (isset($this->status)) {
      $datas['picto'] .= ' '.$this->getLibStatut(5);
    }
    if (property_exists($this, 'ref')) {
      $datas['ref'] = '<br><b>'.$langs->trans('Ref').':</b> '.$this->ref;
    }
    if (property_exists($this, 'label')) {
      $datas['label'] = '<br>'.$langs->trans('Label').':</b> '.$this->label;
    }
 
    return $datas;
  }
 
  public function getNomUrl($withpicto = 0, $option = '', $notooltip = 0, $morecss = '', $save_lastsearch_value = -1)
  {
    global $conf, $langs, $hookmanager;
 
    if (!empty($conf->dol_no_mouse_hover)) {
      $notooltip = 1; // Force disable tooltips
    }
 
    $result = '';
    $params = [
      'id' => (string) $this->id,
      'objecttype' => $this->element.($this->module ? '@'.$this->module : ''),
      'option' => $option,
    ];
    $classfortooltip = 'classfortooltip';
    $dataparams = '';
    if (getDolGlobalInt('MAIN_ENABLE_AJAX_TOOLTIP')) {
      $classfortooltip = 'classforajaxtooltip';
      $dataparams = ' data-params="'.dol_escape_htmltag(json_encode($params)).'"';
      $label = '';
    } else {
      $label = implode($this->getTooltipContentArray($params));
    }
 
    $baseurl = dol_buildpath('/mymodule/myobject_card.php', 1);
    $query = ['id' => $this->id];
    if ($option !== 'nolink') {
      // Add param to save lastsearch_values or not
      $add_save_lastsearch_values = ($save_lastsearch_value == 1 ? 1 : 0);
      if ($save_lastsearch_value == -1 && isset($_SERVER["PHP_SELF"]) && preg_match('/list\.php/', $_SERVER["PHP_SELF"])) {
        $add_save_lastsearch_values = 1;
      }
      if ($add_save_lastsearch_values) {
        $query = array_merge($query, ['save_lastsearch_values' => 1]);
      }
    }
    $url = dolBuildUrl($baseurl, $query);
 
    $linkclose = '';
    if (empty($notooltip)) {
      if (getDolGlobalInt('MAIN_OPTIMIZEFORTEXTBROWSER')) {
        $label = $langs->trans("ShowMyObject");
        $linkclose .= ' alt="'.dolPrintHTMLForAttribute($label).'"';
      }
      $linkclose .= ($label ? ' title="'.dolPrintHTMLForAttribute($label).'"' : ' title="tocomplete"');
      $linkclose .= $dataparams.' class="'.$classfortooltip.($morecss ? ' '.$morecss : '').'"';
    } else {
      $linkclose = ($morecss ? ' class="'.$morecss.'"' : '');
    }
 
    if ($option == 'nolink') {
      $linkstart = '<span';
    } else {
      $linkstart = '<a href="'.$url.'"';
    }
    $linkstart .= $linkclose.'>';
    if ($option == 'nolink') {
      $linkend = '</span>';
    } else {
      $linkend = '</a>';
    }
 
    $result .= $linkstart;
 
    if (empty($this->showphoto_on_popup)) {
      if ($withpicto) {
        $result .= img_object(($notooltip ? '' : $label), ($this->picto ? $this->picto : 'generic'), (($withpicto != 2) ? 'class="paddingright"' : ''), 0, 0, $notooltip ? 0 : 1);
      }
    } else {
      if ($withpicto) {
        require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
 
        list($class, $module) = explode('@', $this->picto);
        $upload_dir = $conf->$module->multidir_output[$conf->entity]."/$class/".dol_sanitizeFileName($this->ref);
        $filearray = dol_dir_list($upload_dir, "files");
        $filename = $filearray[0]['name'];
        if (!empty($filename)) {
          $pospoint = strpos($filearray[0]['name'], '.');
 
          $pathtophoto = $class.'/'.$this->ref.'/thumbs/'.substr($filename, 0, $pospoint).'_mini'.substr($filename, $pospoint);
          if (!getDolGlobalString(strtoupper($module.'_'.$class).'_FORMATLISTPHOTOSASUSERS')) {
            $result .= '<div class="floatleft inline-block valignmiddle divphotoref"><div class="photoref"><img class="photo'.$module.'" alt="No photo" border="0" src="'.DOL_URL_ROOT.'/viewimage.php?modulepart='.$module.'&entity='.$conf->entity.'&file='.urlencode($pathtophoto).'"></div></div>';
          } else {
            $result .= '<div class="floatleft inline-block valignmiddle divphotoref"><img class="photouserphoto userphoto" alt="No photo" border="0" src="'.DOL_URL_ROOT.'/viewimage.php?modulepart='.$module.'&entity='.$conf->entity.'&file='.urlencode($pathtophoto).'"></div>';
          }
 
          $result .= '</div>';
        } else {
          $result .= img_object(($notooltip ? '' : $label), ($this->picto ? $this->picto : 'generic'), ($notooltip ? (($withpicto != 2) ? 'class="paddingright"' : '') : 'class="'.(($withpicto != 2) ? 'paddingright ' : '').'"'), 0, 0, $notooltip ? 0 : 1);
        }
      }
    }
 
    if ($withpicto != 2) {
      $result .= $this->ref;
    }
 
    $result .= $linkend;
    //if ($withpicto != 2) $result.=(($addlabel && $this->label) ? $sep . dol_trunc($this->label, ($addlabel > 1 ? $addlabel : 0)) : '');
 
    global $action, $hookmanager;
    $hookmanager->initHooks(array($this->element.'dao'));
    $parameters = array('id' => $this->id, 'getnomurl' => &$result);
    $reshook = $hookmanager->executeHooks('getNomUrl', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
    if ($reshook > 0) {
      $result = $hookmanager->resPrint;
    } else {
      $result .= $hookmanager->resPrint;
    }
 
    return $result;
  }
 
  public function getKanbanView($option = '', $arraydata = null)
  {
    global $conf, $langs;
 
    $selected = (empty($arraydata['selected']) ? 0 : $arraydata['selected']);
 
    $return = '<div class="box-flex-item box-flex-grow-zero">';
    $return .= '<div class="info-box info-box-sm">';
    $return .= '<span class="info-box-icon bg-infobox-action">';
    $return .= img_picto('', $this->picto);
    $return .= '</span>';
    $return .= '<div class="info-box-content">';
    $return .= '<span class="info-box-ref inline-block tdoverflowmax150 valignmiddle">'.(method_exists($this, 'getNomUrl') ? $this->getNomUrl() : $this->ref).'</span>';
    if ($selected >= 0) {
      $return .= '<input id="cb'.$this->id.'" class="flat checkforselect fright" type="checkbox" name="toselect[]" value="'.$this->id.'"'.($selected ? ' checked="checked"' : '').'>';
    }
    if (property_exists($this, 'label')) {
      $return .= ' <div class="inline-block opacitymedium valignmiddle tdoverflowmax100">'.$this->label.'</div>';
    }
    if (property_exists($this, 'thirdparty') && is_object($this->thirdparty)) {
      $return .= '<br><div class="info-box-ref tdoverflowmax150">'.$this->thirdparty->getNomUrl(1).'</div>';
    }
    if (property_exists($this, 'amount')) {
      $return .= '<br>';
      $return .= '<span class="info-box-label amount">'.price($this->amount, 0, $langs, 1, -1, -1, $conf->currency).'</span>';
    }
    if (method_exists($this, 'getLibStatut')) {
      $return .= '<br><div class="info-box-status">'.$this->getLibStatut(3).'</div>';
    }
    $return .= '</div>';
    $return .= '</div>';
    $return .= '</div>';
 
    return $return;
  }
 
  public function getLabelStatus($mode = 0)
  {
    return $this->LibStatut($this->status, $mode);
  }
 
  public function getLibStatut($mode = 0)
  {
    return $this->LibStatut($this->status, $mode);
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function LibStatut($status, $mode = 0)
  {
    // phpcs:enable
    if (is_null($status)) {
      return '';
    }
 
    $paramsBadge = array('badgeParams' => array('attr' => array(
      'data-status-element' => $this->element,
      'data-status' => (int) $status
    )));
 
 
    if (empty($this->labelStatus) || empty($this->labelStatusShort)) {
      global $langs;
      //$langs->load("mymodule@mymodule");
      $this->labelStatus[self::STATUS_DRAFT] = $langs->transnoentitiesnoconv('Draft');
      $this->labelStatus[self::STATUS_VALIDATED] = $langs->transnoentitiesnoconv('Enabled');
      $this->labelStatus[self::STATUS_CANCELED] = $langs->transnoentitiesnoconv('Disabled');
      $this->labelStatusShort[self::STATUS_DRAFT] = $langs->transnoentitiesnoconv('Draft');
      $this->labelStatusShort[self::STATUS_VALIDATED] = $langs->transnoentitiesnoconv('Enabled');
      $this->labelStatusShort[self::STATUS_CANCELED] = $langs->transnoentitiesnoconv('Disabled');
    }
 
    $statusType = 'status'.$status;
    //if ($status == self::STATUS_VALIDATED) $statusType = 'status1';
    if ($status == self::STATUS_CANCELED) {
      $statusType = 'status6';
    }
 
    return dolGetStatus($this->labelStatus[$status], $this->labelStatusShort[$status], '', $statusType, $mode, '', $paramsBadge);
  }
 
  public function info($id)
  {
    $sql = "SELECT t.rowid, t.date_creation as datec";
    if (!empty($this->isextrafieldmanaged) && $this->isextrafieldmanaged == 1) {
      $sql .= ", GREATEST(t.tms, COALESCE(te.tms, t.tms)) as datem";
    } else {
      $sql .= ", t.tms as datem";
    }
    if (!empty($this->fields['date_validation'])) {
      $sql .= ", t.date_validation as datev";
    }
    if (!empty($this->fields['fk_user_creat'])) {
      $sql .= ", t.fk_user_creat";
    }
    if (!empty($this->fields['fk_user_modif'])) {
      $sql .= ", t.fk_user_modif";
    }
    if (!empty($this->fields['fk_user_valid'])) {
      $sql .= ", t.fk_user_valid";
    }
    $sql .= " FROM ".$this->db->prefix().$this->table_element." as t";
    if (!empty($this->isextrafieldmanaged) && $this->isextrafieldmanaged == 1) {
      $sql .= " LEFT JOIN ".$this->db->prefix().$this->table_element."_extrafields as te ON te.fk_object = t.rowid";
    }
    $sql .= " WHERE t.rowid = ".((int) $id);
 
    $result = $this->db->query($sql);
    if ($result) {
      if ($this->db->num_rows($result)) {
        $obj = $this->db->fetch_object($result);
 
        $this->id = $obj->rowid;
 
        if (!empty($this->fields['fk_user_creat'])) {
          $this->user_creation_id = $obj->fk_user_creat;
        }
        if (!empty($this->fields['fk_user_modif'])) {
          $this->user_modification_id = $obj->fk_user_modif;
        }
        if (!empty($this->fields['fk_user_valid'])) {
          $this->user_validation_id = $obj->fk_user_valid;
        }
        $this->date_creation = $this->db->jdate($obj->datec);
        $this->date_modification = empty($obj->datem) ? '' : $this->db->jdate($obj->datem);
        if (!empty($obj->datev)) {
          $this->date_validation = empty($obj->datev) ? '' : $this->db->jdate($obj->datev);
        }
      }
 
      $this->db->free($result);
    } else {
      dol_print_error($this->db);
    }
  }
 
  public function initAsSpecimen()
  {
    // Set here init that are not commonf fields
    // $this->property1 = ...
    // $this->property2 = ...
 
    return $this->initAsSpecimenCommon();
  }
 
  public function getLinesArray()
  {
    $this->lines = array();
 
    $objectline = new MyObjectLine($this->db);
    $result = $objectline->fetchAll('ASC', 'position', 0, 0, '(fk_myobject:=:'.((int) $this->id).')');
 
    if (is_numeric($result)) {
      $this->setErrorsFromObject($objectline);
      return $result;
    } else {
      $this->lines = $result;
      return $this->lines;
    }
  }
 
  public function getNextNumRef()
  {
    global $langs, $conf;
    $langs->load("mymodule@mymodule");
 
    if (!getDolGlobalString('MYMODULE_MYOBJECT_ADDON')) {
      $conf->global->MYMODULE_MYOBJECT_ADDON = 'mod_myobject_standard';
    }
 
    if (getDolGlobalString('MYMODULE_MYOBJECT_ADDON')) {
      $mybool = false;
 
      $file = getDolGlobalString('MYMODULE_MYOBJECT_ADDON').".php";
      $classname = getDolGlobalString('MYMODULE_MYOBJECT_ADDON');
 
      // Include file with class
      $dirmodels = array_merge(array('/'), (array) $conf->modules_parts['models']);
      foreach ($dirmodels as $reldir) {
        $dir = dol_buildpath($reldir."core/modules/mymodule/");
 
        // Load file with numbering class (if found)
        $mybool = $mybool || @include_once $dir.$file;
      }
 
      if (!$mybool) {
        dol_print_error(null, "Failed to include file ".$file);
        return '';
      }
 
      if (class_exists($classname)) {
        $obj = new $classname();
        '@phan-var-force ModeleNumRefMyObject $obj';
        $numref = $obj->getNextValue($this);
 
        if ($numref != '' && $numref != '-1') {
          return $numref;
        } else {
          $this->error = $obj->error;
          //dol_print_error($this->db,get_class($this)."::getNextNumRef ".$obj->error);
          return "";
        }
      } else {
        print $langs->trans("Error")." ".$langs->trans("ClassNotFound").' '.$classname;
        return "";
      }
    } else {
      print $langs->trans("ErrorNumberingModuleNotSetup", $this->element);
      return "";
    }
  }
 
  public function generateDocument($modele, $outputlangs, $hidedetails = 0, $hidedesc = 0, $hideref = 0, $moreparams = null)
  {
    global $langs;
 
    $result = 0;
    $includedocgeneration = 0;
 
    $langs->load("mymodule@mymodule");
 
    if (!dol_strlen($modele)) {
      if (!empty($this->model_pdf)) {
        $modele = $this->model_pdf;
      } else {
        $modele = getDolGlobalString('MYOBJECT_ADDON_PDF', 'standard_myobject');
      }
    }
 
    $modelpath = "core/modules/mymodule/doc/";
 
    if ($includedocgeneration && !empty($modele)) {
      $result = $this->commonGenerateDocument($modelpath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams);
    }
 
    return $result;
  }
 
  public function validateField($fields, $fieldKey, $fieldValue)
  {
    // Add your own validation rules here.
    // ...
 
    return parent::validateField($fields, $fieldKey, $fieldValue);
  }
 
  public function doScheduledJob()
  {
    //global $conf, $langs;
 
    //$conf->global->SYSLOG_FILE = 'DOL_DATA_ROOT/dolibarr_mydedicatedlogfile.log';
 
    $error = 0;
    $this->output = '';
    $this->error = '';
 
    dol_syslog(__METHOD__." start", LOG_INFO);
 
    $now = dol_now();
 
    $this->db->begin();
 
    // ...
 
    $this->db->commit();
 
    dol_syslog(__METHOD__." end", LOG_INFO);
 
    return $error;
  }
}
 
 
require_once DOL_DOCUMENT_ROOT.'/core/class/commonobjectline.class.php';
 
class MyObjectLine extends CommonObjectLine
{
  // To complete with content of an object MyObjectLine
  // We should have a field rowid, fk_myobject and position
 
  public $parent_element = '';    // Example: '' or 'myobject'
 
  public $fk_parent_attribute = ''; // Example: '' or 'fk_myobject'
 
  public $isextrafieldmanaged = 0;
 
  public $ismultientitymanaged = 0;
 
 
  public function __construct(DoliDB $db)
  {
    $this->db = $db;
  }
}