AdherentType::getMailOnValid() - Code Metrics - Inspection of "Classes from the Adherents, Ai, Asset, Bom, BookCa..." - alxarafe/alixar - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — EXTRACT_CLASSES ( 231cec...0382f2 )

by Rafael
created 2024-08-23 08:35 UTC
AdherentType::getMailOnValid() A

↳ Parent: AdherentType
Complexity

Conditions	3
Paths	2
Size

Total Lines	7
Code Lines	3
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	3
eloc	3
nc	2
nop	0
dl	0
loc	7
rs	10
c	0
b	0
f	0
<?php

/* Copyright (C) 2002       Rodolphe Quiedeville        <[email protected]>
 * Copyright (C) 2004-2008	Laurent Destailleur		    <[email protected]>
 * Copyright (C) 2009-2017	Regis Houssin			    <[email protected]>
 * Copyright (C) 2016		Charlie Benke			    <[email protected]>
 * Copyright (C) 2018-2019  Thibault Foucart		    <[email protected]>
 * Copyright (C) 2021     	Waël Almoman                <[email protected]>
 * Copyright (C) 2024       Frédéric France             <[email protected]>
 * Copyright (C) 2024       Rafael San José             <[email protected]>
 *
 * 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/>.
 */

namespace Dolibarr\Code\Adherents\Classes;

/**
 *  \file       htdocs/adherents/class/adherent_type.class.php
 *  \ingroup    member
 *  \brief      File of class to manage members types
 */

use Dolibarr\Core\Base\CommonObject;


/**
 *  Class to manage members type
 */
class AdherentType extends CommonObject
{
    /**
     * @var string Name of table without prefix where object is stored
     */
    public $table_element = 'adherent_type';

    /**
     * @var string ID to identify managed object
     */
    public $element = 'adherent_type';

    /**
     * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png
     */
    public $picto = 'members';

    /**
     * @var string
     * @deprecated Use label
     * @see $label
     */
    public $libelle;

    /**
     * @var string Adherent type label
     */
    public $label;

    /**
     * @var string Adherent type nature
     */
    public $morphy;

    public $duration;

    /**
     * type expiration
     */
    public $duration_value;

    /**
     * Expiration unit
     */
    public $duration_unit;

    /**
     * @var int Subscription required (0 or 1)
     */
    public $subscription;

    /**
     * @var float|string    Amount for subscription (null or '' means not defined)
     */
    public $amount;

    /**
     * @var int Amount can be chosen by the visitor during subscription (0 or 1)
     */
    public $caneditamount;

    /**
     * @var string  Public note
     * @deprecated
     */
    public $note;

    /** @var string     Public note */
    public $note_public;

    /** @var integer    Can vote */
    public $vote;

    /** @var string Email sent during validation of member */
    public $mail_valid;

    /** @var string Email sent after recording a new subscription */
    public $mail_subscription = '';

    /** @var string Email sent after resiliation */
    public $mail_resiliate = '';

    /** @var string Email sent after exclude */
    public $mail_exclude = '';

    /** @var array Array of members */
    public $members = array();

    /**
     * @var string description
     */
    public $description;

    /**
     * @var string email
     */
    public $email;

    /**
     * @var array multilangs
     */
    public $multilangs = array();


    /**
     *  Constructor
     *
     *  @param      DoliDB      $db     Database handler

     */
    public function __construct($db)
    {
        $this->db = $db;

        $this->ismultientitymanaged = 1;
        $this->status = 1;
    }

    /**
     * Load array this->multilangs
     *
     * @return int        Return integer <0 if KO, >0 if OK
     */
    public function getMultiLangs()
    {
        global $langs;

        $current_lang = $langs->getDefaultLang();

        $sql = "SELECT lang, label, description, email";
        $sql .= " FROM " . MAIN_DB_PREFIX . "adherent_type_lang";
        $sql .= " WHERE fk_type = " . ((int) $this->id);

        $result = $this->db->query($sql);
        if ($result) {
            while ($obj = $this->db->fetch_object($result)) {
                //print 'lang='.$obj->lang.' current='.$current_lang.'<br>';
                if ($obj->lang == $current_lang) {  // si on a les traduct. dans la langue courante on les charge en infos principales.
                    $this->label        = $obj->label;
                    $this->description = $obj->description;
                    $this->email        = $obj->email;
                }
                $this->multilangs["$obj->lang"]["label"] = $obj->label;
                $this->multilangs["$obj->lang"]["description"] = $obj->description;
                $this->multilangs["$obj->lang"]["email"] = $obj->email;
            }
            return 1;
        } else {
            $this->error = "Error: " . $this->db->lasterror() . " - " . $sql;
            return -1;
        }
    }

    /**
     * Update or add a translation for this member type
     *
     * @param  User $user Object user making update

     * @return int        Return integer <0 if KO, >0 if OK
     */
    public function setMultiLangs($user)
    {
        global $langs;

        $langs_available = $langs->get_available_languages(DOL_DOCUMENT_ROOT, 0, 2);
        $current_lang = $langs->getDefaultLang();

        foreach ($langs_available as $key => $value) {
            if ($key == $current_lang) {
                $sql = "SELECT rowid";
                $sql .= " FROM " . MAIN_DB_PREFIX . "adherent_type_lang";
                $sql .= " WHERE fk_type = " . ((int) $this->id);
                $sql .= " AND lang = '" . $this->db->escape($key) . "'";

                $result = $this->db->query($sql);

                if ($this->db->num_rows($result)) { // if there is already a description line for this language
                    $sql2 = "UPDATE " . MAIN_DB_PREFIX . "adherent_type_lang";
                    $sql2 .= " SET";
                    $sql2 .= " label = '" . $this->db->escape($this->label) . "',";
                    $sql2 .= " description = '" . $this->db->escape($this->description) . "'";
                    $sql2 .= " WHERE fk_type = " . ((int) $this->id) . " AND lang='" . $this->db->escape($key) . "'";
                } else {
                    $sql2 = "INSERT INTO " . MAIN_DB_PREFIX . "adherent_type_lang (fk_type, lang, label, description";
                    $sql2 .= ")";
                    $sql2 .= " VALUES(" . ((int) $this->id) . ",'" . $this->db->escape($key) . "','" . $this->db->escape($this->label) . "',";
                    $sql2 .= " '" . $this->db->escape($this->description) . "'";
                    $sql2 .= ")";
                }
                dol_syslog(get_class($this) . '::setMultiLangs key = current_lang = ' . $key);
                if (!$this->db->query($sql2)) {
                    $this->error = $this->db->lasterror();
                    return -1;
                }
            } elseif (isset($this->multilangs[$key])) {
                $sql = "SELECT rowid";
                $sql .= " FROM " . MAIN_DB_PREFIX . "adherent_type_lang";
                $sql .= " WHERE fk_type = " . ((int) $this->id);
                $sql .= " AND lang = '" . $this->db->escape($key) . "'";

                $result = $this->db->query($sql);

                if ($this->db->num_rows($result)) { // if there is already a description line for this language
                    $sql2 = "UPDATE " . MAIN_DB_PREFIX . "adherent_type_lang";
                    $sql2 .= " SET ";
                    $sql2 .= " label = '" . $this->db->escape($this->multilangs["$key"]["label"]) . "',";
                    $sql2 .= " description = '" . $this->db->escape($this->multilangs["$key"]["description"]) . "'";
                    $sql2 .= " WHERE fk_type = " . ((int) $this->id) . " AND lang='" . $this->db->escape($key) . "'";
                } else {
                    $sql2 = "INSERT INTO " . MAIN_DB_PREFIX . "adherent_type_lang (fk_type, lang, label, description";
                    $sql2 .= ")";
                    $sql2 .= " VALUES(" . ((int) $this->id) . ",'" . $this->db->escape($key) . "','" . $this->db->escape($this->multilangs["$key"]["label"]) . "',";
                    $sql2 .= " '" . $this->db->escape($this->multilangs["$key"]["description"]) . "'";
                    $sql2 .= ")";
                }

                // We do not save if main fields are empty
                if ($this->multilangs["$key"]["label"] || $this->multilangs["$key"]["description"]) {
                    if (!$this->db->query($sql2)) {
                        $this->error = $this->db->lasterror();
                        return -1;
                    }
                }
            } else {
                // language is not current language and we didn't provide a multilang description for this language
            }
        }

        // Call trigger
        $result = $this->call_trigger('MEMBER_TYPE_SET_MULTILANGS', $user);
        if ($result < 0) {
            $this->error = $this->db->lasterror();
            return -1;
        }
        // End call triggers

        return 1;
    }

    /**
        * Delete a language for this member type
        *
        * @param string $langtodelete   Language code to delete
        * @param User   $user           Object user making delete
        * @return int                   Return integer <0 if KO, >0 if OK
        */
    public function delMultiLangs($langtodelete, $user)
    {
        $sql = "DELETE FROM " . MAIN_DB_PREFIX . "adherent_type_lang";
        $sql .= " WHERE fk_type = " . ((int) $this->id) . " AND lang = '" . $this->db->escape($langtodelete) . "'";

        dol_syslog(get_class($this) . '::delMultiLangs', LOG_DEBUG);
        $result = $this->db->query($sql);
        if ($result) {
            // Call trigger
            $result = $this->call_trigger('MEMBER_TYPE_DEL_MULTILANGS', $user);
            if ($result < 0) {
                $this->error = $this->db->lasterror();
                dol_syslog(get_class($this) . '::delMultiLangs error=' . $this->error, LOG_ERR);
                return -1;
            }
            // End call triggers
            return 1;
        } else {
            $this->error = $this->db->lasterror();
            dol_syslog(get_class($this) . '::delMultiLangs error=' . $this->error, LOG_ERR);
            return -1;
        }
    }

    /**
     *  Function to create the member type
     *
     *  @param  User    $user           User making creation
     *  @param  int     $notrigger      1=do not execute triggers, 0 otherwise
     *  @return int                     >0 if OK, < 0 if KO
     */
    public function create($user, $notrigger = 0)
    {
        global $conf;

        $error = 0;

        $this->status = (int) $this->status;
        $this->label = trim($this->label);

        $this->db->begin();

        $sql = "INSERT INTO " . MAIN_DB_PREFIX . "adherent_type (";
        $sql .= " morphy";
        $sql .= ", libelle";
        $sql .= ", entity";
        $sql .= ") VALUES (";
        $sql .= "'" . $this->db->escape($this->morphy) . "'";
        $sql .= ", '" . $this->db->escape($this->label) . "'";
        $sql .= ", " . ((int) $conf->entity);
        $sql .= ")";

        dol_syslog("Adherent_type::create", LOG_DEBUG);
        $result = $this->db->query($sql);
        if ($result) {
            $this->id = $this->db->last_insert_id(MAIN_DB_PREFIX . "adherent_type");

            $result = $this->update($user, 1);
            if ($result < 0) {
                $this->db->rollback();
                return -3;
            }

            if (!$notrigger) {
                // Call trigger
                $result = $this->call_trigger('MEMBER_TYPE_CREATE', $user);
                if ($result < 0) {
                    $error++;
                }
                // End call triggers
            }

            if (!$error) {
                $this->db->commit();
                return $this->id;
            } else {
                dol_syslog(get_class($this) . "::create " . $this->error, LOG_ERR);
                $this->db->rollback();
                return -2;
            }
        } else {
            $this->error = $this->db->lasterror();
            $this->db->rollback();
            return -1;
        }
    }

    /**
     *  Updating the type in the database
     *
     *  @param  User    $user           Object user making change
     *  @param  int     $notrigger      1=do not execute triggers, 0 otherwise
     *  @return int                     >0 if OK, < 0 if KO
     */
    public function update($user, $notrigger = 0)
    {
        global $langs;

        $error = 0;

        $this->label = trim($this->label);

        if (empty($this->note_public) && !empty($this->note)) {     // For backward compatibility
            $this->note_public = $this->note;
        }

        $this->db->begin();

        $sql = "UPDATE " . MAIN_DB_PREFIX . "adherent_type ";
        $sql .= "SET ";
        $sql .= "statut = " . ((int) $this->status) . ",";
        $sql .= "libelle = '" . $this->db->escape($this->label) . "',";
        $sql .= "morphy = '" . $this->db->escape($this->morphy) . "',";
        $sql .= "subscription = '" . $this->db->escape($this->subscription) . "',";
        $sql .= "amount = " . ((empty($this->amount) && $this->amount == '') ? "null" : ((float) $this->amount)) . ",";
        $sql .= "caneditamount = " . ((int) $this->caneditamount) . ",";
        $sql .= "duration = '" . $this->db->escape($this->duration_value . $this->duration_unit) . "',";
        $sql .= "note = '" . $this->db->escape($this->note_public) . "',";
        $sql .= "vote = " . (int) $this->db->escape($this->vote) . ",";
        $sql .= "mail_valid = '" . $this->db->escape($this->mail_valid) . "'";
        $sql .= " WHERE rowid =" . ((int) $this->id);

        $result = $this->db->query($sql);
        if ($result) {
            $this->description = $this->db->escape($this->note_public);

            // Multilangs
            if (getDolGlobalInt('MAIN_MULTILANGS')) {
                if ($this->setMultiLangs($user) < 0) {
                    $this->error = $langs->trans("Error") . " : " . $this->db->error() . " - " . $sql;
                    return -2;
                }
            }

            // Actions on extra fields
            if (!$error) {
                $result = $this->insertExtraFields();
                if ($result < 0) {
                    $error++;
                }
            }

            if (!$error && !$notrigger) {
                // Call trigger
                $result = $this->call_trigger('MEMBER_TYPE_MODIFY', $user);
                if ($result < 0) {
                    $error++;
                }
                // End call triggers
            }

            if (!$error) {
                $this->db->commit();
                return 1;
            } else {
                $this->db->rollback();
                dol_syslog(get_class($this) . "::update " . $this->error, LOG_ERR);
                return -$error;
            }
        } else {
            $this->error = $this->db->lasterror();
            $this->db->rollback();
            return -1;
        }
    }

    /**
     *  Function to delete the member's status
     *
     *  @param  User    $user       User making the deletion
     *  @return int                 > 0 if OK, 0 if not found, < 0 if KO
     */
    public function delete($user)
    {
        $error = 0;

        $sql = "DELETE FROM " . MAIN_DB_PREFIX . "adherent_type";
        $sql .= " WHERE rowid = " . ((int) $this->id);

        $resql = $this->db->query($sql);
        if ($resql) {
            // Call trigger
            $result = $this->call_trigger('MEMBER_TYPE_DELETE', $user);
            if ($result < 0) {
                $error++;
                $this->db->rollback();
                return -2;
            }
            // End call triggers

            $this->db->commit();
            return 1;
        } else {
            $this->db->rollback();
            $this->error = $this->db->lasterror();
            return -1;
        }
    }

    /**
     *  Function that retrieves the properties of a membership type
     *
     *  @param      int     $rowid          Id of member type to load
     *  @return     int                     Return integer <0 if KO, >0 if OK
     */
    public function fetch($rowid)
    {
        $sql = "SELECT d.rowid, d.libelle as label, d.morphy, d.statut as status, d.duration, d.subscription, d.amount, d.caneditamount, d.mail_valid, d.note as note_public, d.vote";
        $sql .= " FROM " . MAIN_DB_PREFIX . "adherent_type as d";
        $sql .= " WHERE d.rowid = " . (int) $rowid;

        dol_syslog("Adherent_type::fetch", LOG_DEBUG);

        $resql = $this->db->query($sql);
        if ($resql) {
            if ($this->db->num_rows($resql)) {
                $obj = $this->db->fetch_object($resql);

                $this->id             = $obj->rowid;
                $this->ref            = $obj->rowid;
                $this->label          = $obj->label;
                $this->morphy         = $obj->morphy;
                $this->status         = $obj->status;
                $this->duration       = $obj->duration;
                $this->duration_value = substr($obj->duration, 0, dol_strlen($obj->duration) - 1);
                $this->duration_unit  = substr($obj->duration, -1);
                $this->subscription   = $obj->subscription;
                $this->amount         = $obj->amount;
                $this->caneditamount  = $obj->caneditamount;
                $this->mail_valid     = $obj->mail_valid;
                $this->note           = $obj->note_public;  // deprecated
                $this->note_public    = $obj->note_public;
                $this->vote           = $obj->vote;

                // multilangs
                if (getDolGlobalInt('MAIN_MULTILANGS')) {
                    $this->getMultiLangs();
                }

                // fetch optionals attributes and labels
                $this->fetch_optionals();
                return $this->id;
            } else {
                return 0;
            }
        } else {
            $this->error = $this->db->lasterror();
            return -1;
        }
    }

	// phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
    /**
     *  Return list of members' type
     *
     *  @param  int     $status         Filter on status of type
     *  @return array                   List of types of members
     */
    public function liste_array($status = -1)
    {
		// phpcs:enable
        global $langs;

        $adherenttypes = array();

        $sql = "SELECT rowid, libelle as label";
        $sql .= " FROM " . MAIN_DB_PREFIX . "adherent_type";
        $sql .= " WHERE entity IN (" . getEntity('member_type') . ")";
        if ($status >= 0) {
            $sql .= " AND statut = " . ((int) $status);
        }

        $resql = $this->db->query($sql);
        if ($resql) {
            $nump = $this->db->num_rows($resql);

            if ($nump) {
                $i = 0;
                while ($i < $nump) {
                    $obj = $this->db->fetch_object($resql);

                    $adherenttypes[$obj->rowid] = $langs->trans($obj->label);
                    $i++;
                }
            }
        } else {
            print $this->db->error();
        }
        return $adherenttypes;
    }

    /**
     *  Return the array of all amounts per membership type id
     *
     *  @param  int     $status         Filter on status of type
     *  @return array                   Array of membership type
     */
    public function amountByType($status = null)
    {
        $amountbytype = array();

        $sql = "SELECT rowid, amount";
        $sql .= " FROM " . MAIN_DB_PREFIX . "adherent_type";
        $sql .= " WHERE entity IN (" . getEntity('member_type') . ")";
        if ($status !== null) {
            $sql .= " AND statut = " . ((int) $status);
        }

        $resql = $this->db->query($sql);
        if ($resql) {
            $nump = $this->db->num_rows($resql);

            if ($nump) {
                $i = 0;
                while ($i < $nump) {
                    $obj = $this->db->fetch_object($resql);

                    $amountbytype[$obj->rowid] = $obj->amount;
                    $i++;
                }
            }
        } else {
            print $this->db->error();
        }

        return $amountbytype;
    }

    /**
     *  Return array of Member objects for member type this->id (or all if this->id not defined)
     *
     *  @param  string  $excludefilter      Filter to exclude. This value must not come from a user input.
     *  @param  int     $mode               0=Return array of member instance
     *                                      1=Return array of member instance without extra data
     *                                      2=Return array of members id only
     *  @return mixed                       Array of members or -1 on error
     */
    public function listMembersForMemberType($excludefilter = '', $mode = 0)
    {
        $ret = array();

        $sql = "SELECT a.rowid";
        $sql .= " FROM " . MAIN_DB_PREFIX . "adherent as a";
        $sql .= " WHERE a.entity IN (" . getEntity('member') . ")";
        $sql .= " AND a.fk_adherent_type = " . ((int) $this->id);
        if (!empty($excludefilter)) {
            $sql .= ' AND (' . $excludefilter . ')';
        }

        dol_syslog(get_class($this) . "::listMembersForMemberType", LOG_DEBUG);
        $resql = $this->db->query($sql);
        if ($resql) {
            while ($obj = $this->db->fetch_object($resql)) {
                if (!array_key_exists($obj->rowid, $ret)) {
                    if ($mode < 2) {
                        $memberstatic = new Adherent($this->db);
                        if ($mode == 1) {
                            $memberstatic->fetch($obj->rowid, '', '', '', false, false);
                        } else {
                            $memberstatic->fetch($obj->rowid);
                        }
                        $ret[$obj->rowid] = $memberstatic;
                    } else {
                        $ret[$obj->rowid] = $obj->rowid;
                    }
                }
            }

            $this->db->free($resql);

            $this->members = $ret;

            return $ret;
        } else {
            $this->error = $this->db->lasterror();
            return -1;
        }
    }

    /**
     *  Return translated label by the nature of a adherent (physical or moral)
     *
     *  @param  string      $morphy     Nature of the adherent (physical or moral)
     *  @return string                  Label
     */
    public function getmorphylib($morphy = '')
    {
        global $langs;
        if ($morphy == 'phy') {
            return $langs->trans("Physical");
        } elseif ($morphy == 'mor') {
            return $langs->trans("Moral");
        } else {
            return $langs->trans("MorAndPhy");
        }
        //return $morphy;
    }

    /**
     * getTooltipContentArray
     * @param array $params params to construct tooltip data
     * @since v18
     * @return array
     */
    public function getTooltipContentArray($params)
    {
        global $langs;

        $langs->load('members');

        $datas = [];
        $datas['picto'] = img_picto('', $this->picto) . ' <u class="paddingrightonly">' . $langs->trans("MemberType") . '</u> ' . $this->getLibStatut(4);
        $datas['label'] = '<br>' . $langs->trans("Label") . ': ' . $this->label;
        if (isset($this->subscription)) {
            $datas['subscription'] = '<br>' . $langs->trans("SubscriptionRequired") . ': ' . yn($this->subscription);
        }
        if (isset($this->vote)) {
            $datas['vote'] = '<br>' . $langs->trans("VoteAllowed") . ': ' . yn($this->vote);
        }
        if (isset($this->duration)) {
            $datas['duration'] = '<br>' . $langs->trans("Duration") . ': ' . $this->duration_value;
            if ($this->duration_value > 1) {
                $dur = array("i" => $langs->trans("Minutes"), "h" => $langs->trans("Hours"), "d" => $langs->trans("Days"), "w" => $langs->trans("Weeks"), "m" => $langs->trans("Months"), "y" => $langs->trans("Years"));
            } elseif ($this->duration_value > 0) {
                $dur = array("i" => $langs->trans("Minute"), "h" => $langs->trans("Hour"), "d" => $langs->trans("Day"), "w" => $langs->trans("Week"), "m" => $langs->trans("Month"), "y" => $langs->trans("Year"));
            }
            $datas['duration'] .= "&nbsp;" . (!empty($this->duration_unit) && isset($dur[$this->duration_unit]) ? $langs->trans($dur[$this->duration_unit]) : '');
        }

        return $datas;
    }

    /**
     *  Return clicable name (with picto eventually)
     *
     *  @param      int     $withpicto                  0=No picto, 1=Include picto into link, 2=Only picto
     *  @param      int     $maxlen                     length max label
     *  @param      int     $notooltip                  1=Disable tooltip
     *  @param      string  $morecss                    Add more css on link
     *  @param      int     $save_lastsearch_value      -1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking
     *  @return     string                              String with URL
     */
    public function getNomUrl($withpicto = 0, $maxlen = 0, $notooltip = 0, $morecss = '', $save_lastsearch_value = -1)
    {
        $result = '';
        $option = '';

        $classfortooltip = 'classfortooltip';
        $dataparams = '';
        $params = [
            'id' => $this->id,
            'objecttype' => $this->element,
            'option' => $option,
            'nofetch' => 1,
        ];
        if (getDolGlobalInt('MAIN_ENABLE_AJAX_TOOLTIP')) {
            $classfortooltip = 'classforajaxtooltip';
            $dataparams = ' data-params="' . dol_escape_htmltag(json_encode($params)) . '"';
            $label = '';
        } else {
            $label = implode($this->getTooltipContentArray($params));
        }

        $url = constant('BASE_URL') . '/adherents/type.php?rowid=' . ((int) $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) {
                $url .= '&save_lastsearch_values=1';
            }
        }
        $linkstart = '<a href="' . $url . '"';
        $linkstart .= ($label ? ' title="' . dol_escape_htmltag($label, 1) . '"' : ' title="tocomplete"');
        $linkstart .= $dataparams . ' class="' . $classfortooltip . '">';

        $linkend = '</a>';

        $result .= $linkstart;
        if ($withpicto) {
            $result .= img_object(($notooltip ? '' : $label), ($this->picto ? $this->picto : 'generic'), (' class="' . (($withpicto != 2) ? 'paddingright' : '') . '"'), 0, 0, $notooltip ? 0 : 1);
        }
        if ($withpicto != 2) {
            $result .= ($maxlen ? dol_trunc($this->label, $maxlen) : $this->label);
        }
        $result .= $linkend;

        return $result;
    }

    /**
     *    Return label of status (activity, closed)
     *
     *    @param    int     $mode       0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto
     *    @return   string              Label of status
     */
    public function getLibStatut($mode = 0)
    {
        return $this->LibStatut($this->status, $mode);
    }

	// phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
    /**
     *  Return the label of a given status
     *
     *  @param  int     $status         Status id
     *  @param  int     $mode           0=Long label, 1=Short label, 2=Picto + Short label, 3=Picto, 4=Picto + Long label, 5=Short label + Picto, 6=Long label + Picto
     *  @return string                  Status label
     */
    public function LibStatut($status, $mode = 0)
    {
		// phpcs:enable
        global $langs;
        $langs->load('companies');

        $statusType = 'status4';
        if ($status == 0) {
            $statusType = 'status5';
        }

        if (empty($this->labelStatus) || empty($this->labelStatusShort)) {
            $this->labelStatus[0] = $langs->transnoentitiesnoconv("ActivityCeased");
            $this->labelStatus[1] = $langs->transnoentitiesnoconv("InActivity");
            $this->labelStatusShort[0] = $langs->transnoentitiesnoconv("ActivityCeased");
            $this->labelStatusShort[1] = $langs->transnoentitiesnoconv("InActivity");
        }

        return dolGetStatus($this->labelStatus[$status], $this->labelStatusShort[$status], '', $statusType, $mode);
    }

	// phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
	// phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
    /**
     *  Retourne chaine DN complete dans l'annuaire LDAP pour l'objet
     *
     *  @param      array   $info       Info array loaded by _load_ldap_info
     *  @param      int     $mode       0=Return full DN (uid=qqq,ou=xxx,dc=aaa,dc=bbb)
     *                                  1=Return DN without key inside (ou=xxx,dc=aaa,dc=bbb)
     *                                  2=Return key only (uid=qqq)
     *  @return     string              DN
     */
    public function _load_ldap_dn($info, $mode = 0)
    {
		// phpcs:enable
        $dn = '';
        if ($mode == 0) {
            $dn = getDolGlobalString('LDAP_KEY_MEMBERS_TYPES') . "=" . $info[getDolGlobalString('LDAP_KEY_MEMBERS_TYPES')] . "," . getDolGlobalString('LDAP_MEMBER_TYPE_DN');
        }
        if ($mode == 1) {
            $dn = getDolGlobalString('LDAP_MEMBER_TYPE_DN');
        }
        if ($mode == 2) {
            $dn = getDolGlobalString('LDAP_KEY_MEMBERS_TYPES') . "=" . $info[getDolGlobalString('LDAP_KEY_MEMBERS_TYPES')];
        }
        return $dn;
    }


	// phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
	// phpcs:disable PEAR.NamingConventions.ValidFunctionName.PublicUnderscore
    /**
     *  Initialize the info array (array of LDAP values) that will be used to call LDAP functions
     *
     *  @return     array       Tableau info des attributes
     */
    public function _load_ldap_info()
    {
		// phpcs:enable
        $info = array();

        // Object classes
        $info["objectclass"] = explode(',', getDolGlobalString('LDAP_MEMBER_TYPE_OBJECT_CLASS'));

        if (empty($this->note_public) && !empty($this->note)) {     // For backward compatibility
            $this->note_public = $this->note;
        }

        // Champs
        if ($this->label && getDolGlobalString('LDAP_MEMBER_TYPE_FIELD_FULLNAME')) {
            $info[getDolGlobalString('LDAP_MEMBER_TYPE_FIELD_FULLNAME')] = $this->label;
        }
        if ($this->note_public && getDolGlobalString('LDAP_MEMBER_TYPE_FIELD_DESCRIPTION')) {
            $info[getDolGlobalString('LDAP_MEMBER_TYPE_FIELD_DESCRIPTION')] = dol_string_nohtmltag($this->note_public, 0, 'UTF-8', 1);
        }
        if (getDolGlobalString('LDAP_MEMBER_TYPE_FIELD_GROUPMEMBERS')) {
            $valueofldapfield = array();
            foreach ($this->members as $key => $val) {    // This is array of users for group into dolibarr database.
                $member = new Adherent($this->db);
                $member->fetch($val->id, '', '', '', false, false);
                $info2 = $member->_load_ldap_info();
                $valueofldapfield[] = $member->_load_ldap_dn($info2);
            }
            $info[getDolGlobalString('LDAP_MEMBER_TYPE_FIELD_GROUPMEMBERS')] = (!empty($valueofldapfield) ? $valueofldapfield : '');
        }
        return $info;
    }

    /**
     *  Initialise an instance with random values.
     *  Used to build previews or test instances.
     *  id must be 0 if object instance is a specimen.
     *
     *  @return int
     */
    public function initAsSpecimen()
    {
        global $user;

        // Initialise parameters
        $this->id = 0;
        $this->ref = 'MTSPEC';
        $this->specimen = 1;

        $this->label = 'MEMBERS TYPE SPECIMEN';
        $this->note_public = 'This is a public note';
        $this->mail_valid = 'This is welcome email';
        $this->subscription = 1;
        $this->caneditamount = 0;
        $this->vote = 0;

        $this->status = 1;

        // Members of this member type is just me
        $this->members = array(
            $user->id => $user
        );

        return 1;
    }

    /**
     *     getMailOnValid
     *
     *     @return string     Return mail content of type or empty
     */
    public function getMailOnValid()
    {
        if (!empty($this->mail_valid) && trim(dol_htmlentitiesbr_decode($this->mail_valid))) {
            return $this->mail_valid;
        }

        return '';
    }

    /**
     *     getMailOnSubscription
     *
     *     @return string     Return mail content of type or empty
     */
    public function getMailOnSubscription()
    {
        // mail_subscription not  defined so never used
        if (!empty($this->mail_subscription) && trim(dol_htmlentitiesbr_decode($this->mail_subscription))) {  // Property not yet defined
            return $this->mail_subscription;
        }

        return '';
    }

    /**
     *     getMailOnResiliate
     *
     *     @return string     Return mail model content of type or empty
     */
    public function getMailOnResiliate()
    {
        // NOTE mail_resiliate not defined so never used
        if (!empty($this->mail_resiliate) && trim(dol_htmlentitiesbr_decode($this->mail_resiliate))) {  // Property not yet defined
            return $this->mail_resiliate;
        }

        return '';
    }

    /**
     *     getMailOnExclude
     *
     *     @return string     Return mail model content of type or empty
     */
    public function getMailOnExclude()
    {
        // NOTE mail_exclude not defined so never used
        if (!empty($this->mail_exclude) && trim(dol_htmlentitiesbr_decode($this->mail_exclude))) {  // Property not yet defined
            return $this->mail_exclude;
        }

        return '';
    }


    /**
     *  Return clicable link of object (with eventually picto)
     *
     *  @param      string      $option                 Where point the link (0=> main card, 1,2 => shipment, 'nolink'=>No link)
     *  @param      array       $arraydata              Array of data
     *  @return     string                              HTML Code for Kanban thumb.
     */
    public function getKanbanView($option = '', $arraydata = null)
    {
        global $langs, $user;

        //$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>';

        //$return .= '<input id="cb'.$this->id.'" class="flat checkforselect fright" type="checkbox" name="toselect[]" value="'.$this->id.'"'.($selected ? ' checked="checked"' : '').'>';

        if ($user->hasRight('adherent', 'configurer')) {
            $return .= '<span class="right paddingleft"><a class="editfielda" href="' . $_SERVER["PHP_SELF"] . '?action=edit&rowid=' . urlencode($this->ref) . '">' . img_edit() . '</a></span>';
        } else {
            $return .= '<span class="right">&nbsp;</span>';
        }
        if (property_exists($this, 'vote')) {
            $return .= '<br><span class="info-box-label opacitymedium">' . $langs->trans("VoteAllowed") . ' : ' . yn($this->vote) . '</span>';
        }
        if (property_exists($this, 'amount')) {
            if (is_null($this->amount) || $this->amount === '') {
                $return .= '<br>';
            } else {
                $return .= '<br><span class="info-box-label opacitymedium">' . $langs->trans("Amount") . '</span>';
                $return .= '<span class="amount"> : ' . price($this->amount) . '</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;
    }
}

alxarafe / alixar

Push — EXTRACT_CLASSES ( 231cec...0382f2 )

AdherentType::getMailOnValid() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
