DoliCore\Model\CommonPeople

Complexity

Total Complexity

77

Size/Duplication

Total Lines	283
Duplicated Lines	0 %

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
B	getFullName()	0	21	10
F	getBannerAddress()	0	172	58
B	setUpperOrLowerCase()	0	26	9

<?php

/* Copyright (C) 2023       Frédéric France     <frederic.france@netlogic.fr>
 * Copyright (C) 2024		MDW						<mdeweerd@users.noreply.github.com>
 * Copyright (C) 2024       Rafael San José         <rsanjose@alxarafe.com>
 *
 * 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/>.
 */

/**
 *       \file       htdocs/core/class/commonpeople.class.php
 *       \ingroup    core
 *       \brief      File of the superclass of object classes that support people
 */


namespace DoliCore\Model;

use Contact;
use ExtraLanguages;
use Form;
use Societe;
use Translate;
use User;

/**
 *      Support class for thirdparties, contacts, members, users or resources
 */
trait CommonPeople
{
    /**
     * @var string Address
     */
    public $address;

    /**
     * @var string zip code
     */
    public $zip;

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

    /**
     * @var int $state_id
     */
    public $state_id; // The state/department
    public $state_code;
    public $state;

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

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


    /**
     *  Return full name (civility+' '+name+' '+lastname)
     *
     * @param Translate $langs     Language object for translation of civility (used only if option is 1)
     * @param int       $option    0=No option, 1=Add civility
     * @param int       $nameorder -1=Auto, 0=Lastname+Firstname, 1=Firstname+Lastname, 2=Firstname, 3=Firstname if
     *                             defined else lastname, 4=Lastname, 5=Lastname if defined else firstname
     * @param int       $maxlen    Maximum length
     *
     * @return string                      String with full name
     */
    public function getFullName($langs, $option = 0, $nameorder = -1, $maxlen = 0)
    {
        //print "lastname=".$this->lastname." name=".$this->name." nom=".$this->nom."<br>\n";
        $lastname = $this->lastname;
        $firstname = $this->firstname;
        if (empty($lastname)) {
            $lastname = (isset($this->lastname) ? $this->lastname : (isset($this->name) ? $this->name : (isset($this->nom) ? $this->nom : (isset($this->societe) ? $this->societe : (isset($this->company) ? $this->company : '')))));
        }

        $ret = '';
        if (!empty($option) && !empty($this->civility_code)) {
            if ($langs->transnoentitiesnoconv("Civility" . $this->civility_code) != "Civility" . $this->civility_code) {
                $ret .= $langs->transnoentitiesnoconv("Civility" . $this->civility_code) . ' ';
            } else {
                $ret .= $this->civility_code . ' ';
            }
        }

        $ret .= dolGetFirstLastname($firstname, $lastname, $nameorder);

        return dol_string_nohtmltag(dol_trunc($ret, $maxlen));
    }

    /**
     *  Return full address for banner
     *
     * @param string $htmlkey HTML id to make banner content unique
     * @param Object $object  Object (thirdparty, thirdparty of contact for contact, null for a member)
     *
     * @return     string                          Full address string
     */
    public function getBannerAddress($htmlkey, $object)
    {
        global $conf, $langs, $form, $extralanguages;

        $countriesusingstate = ['AU', 'US', 'IN', 'GB', 'ES', 'UK', 'TR']; // See also option MAIN_FORCE_STATE_INTO_ADDRESS

        $contactid = 0;
        $thirdpartyid = 0;
        $elementforaltlanguage = $this->element;
        if ($this->element == 'societe') {
            /** @var Societe $this */
            $thirdpartyid = $this->id;
        }
        if ($this->element == 'contact') {
            /** @var Contact $this */
            $contactid = $this->id;
            $thirdpartyid = empty($this->fk_soc) ? 0 : $this->fk_soc;
        }
        if ($this->element == 'user') {
            /** @var User $this */
            $contactid = $this->contact_id;
            $thirdpartyid = empty($object->fk_soc) ? 0 : $object->fk_soc;
        }

        $out = '';

        $outdone = 0;
        $coords = $this->getFullAddress(1, ', ', getDolGlobalInt('MAIN_SHOW_REGION_IN_STATE_SELECT'));

It seems like getFullAddress() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        if ($coords) {
            if (!empty($conf->use_javascript_ajax)) {
                // Add picto with tooltip on map
                $namecoords = '';
                if ($this->element == 'contact' && getDolGlobalString('MAIN_SHOW_COMPANY_NAME_IN_BANNER_ADDRESS')) {
                    $namecoords .= $object->name . '<br>';
                }
                $namecoords .= $this->getFullName($langs, 1) . '<br>' . $coords;
                // hideonsmatphone because copyToClipboard call jquery dialog that does not work with jmobile
                $out .= '<a href="#" class="hideonsmartphone" onclick="return copyToClipboard(\'' . dol_escape_js($namecoords) . '\',\'' . dol_escape_js($langs->trans("HelpCopyToClipboard")) . '\');">';
                $out .= img_picto($langs->trans("Address"), 'map-marker-alt');
                $out .= '</a> ';
            }
            $address = dol_print_address($coords, 'address_' . $htmlkey . '_' . $this->id, $this->element, $this->id, 1, ', ');
            if ($address) {
                $out .= $address;
                $outdone++;
            }
            $outdone++;

            // List of extra languages
            $arrayoflangcode = [];
            if (getDolGlobalString('PDF_USE_ALSO_LANGUAGE_CODE')) {
                $arrayoflangcode[] = getDolGlobalString('PDF_USE_ALSO_LANGUAGE_CODE');
            }

            if (is_array($arrayoflangcode) && count($arrayoflangcode)) {
                if (!is_object($extralanguages)) {
                    include_once DOL_DOCUMENT_ROOT . '/core/class/extralanguages.class.php';
                    $extralanguages = new ExtraLanguages($this->db);
                }
                $extralanguages->fetch_name_extralanguages($elementforaltlanguage);

                if (!empty($extralanguages->attributes[$elementforaltlanguage]['address']) || !empty($extralanguages->attributes[$elementforaltlanguage]['town'])) {
                    $out .= "<!-- alternatelanguage for '" . $elementforaltlanguage . "' set to fields '" . implode(',', $extralanguages->attributes[$elementforaltlanguage]) . "' -->\n";
                    $this->fetchValuesForExtraLanguages();

It seems like fetchValuesForExtraLanguages() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                    if (!is_object($form)) {
                        $form = new Form($this->db);
                    }
                    $htmltext = '';
                    // If there is extra languages
                    foreach ($arrayoflangcode as $extralangcode) {
                        $s = picto_from_langcode($extralangcode, 'class="pictoforlang paddingright"');
                        // This also call dol_format_address()
                        $coords = $this->getFullAddress(1, ', ', $conf->global->MAIN_SHOW_REGION_IN_STATE_SELECT, $extralangcode);
                        $htmltext .= $s . dol_print_address($coords, 'address_' . $htmlkey . '_' . $this->id, $this->element, $this->id, 1, ', ');
                    }
                    $out .= $form->textwithpicto('', $htmltext, -1, 'language', 'opacitymedium paddingleft');
                }
            }
        }

        // If MAIN_FORCE_STATE_INTO_ADDRESS is on, state is already returned previously with getFullAddress
        if (
            !in_array($this->country_code, $countriesusingstate) && !getDolGlobalString('MAIN_FORCE_STATE_INTO_ADDRESS')
            && !getDolGlobalString('SOCIETE_DISABLE_STATE') && $this->state
        ) {
            if (getDolGlobalInt('MAIN_SHOW_REGION_IN_STATE_SELECT') == 1 && $this->region) {
                $out .= ($outdone ? ' - ' : '') . $this->region . ' - ' . $this->state;
            } else {
                $out .= ($outdone ? ' - ' : '') . $this->state;
            }
            $outdone++;
        }

        if ($outdone) {
            $out = '<div class="address inline-block">' . $out . '</div>';
        }

        if (!empty($this->phone) || !empty($this->phone_pro) || !empty($this->phone_mobile) || !empty($this->phone_perso) || !empty($this->fax) || !empty($this->office_phone) || !empty($this->user_mobile) || !empty($this->office_fax)) {
            $out .= ($outdone ? '<br>' : '');
        }
        if (!empty($this->phone) && empty($this->phone_pro)) {      // For objects that store pro phone into ->phone
            $out .= dol_print_phone($this->phone, $this->country_code, $contactid, $thirdpartyid, 'AC_TEL', '&nbsp;', 'phone', $langs->trans("PhonePro"));
            $outdone++;
        }
        if (!empty($this->phone_pro)) {
            $out .= dol_print_phone($this->phone_pro, $this->country_code, $contactid, $thirdpartyid, 'AC_TEL', '&nbsp;', 'phone', $langs->trans("PhonePro"));
            $outdone++;
        }
        if (!empty($this->phone_mobile)) {
            $out .= dol_print_phone($this->phone_mobile, $this->country_code, $contactid, $thirdpartyid, 'AC_TEL', '&nbsp;', 'mobile', $langs->trans("PhoneMobile"));
            $outdone++;
        }
        if (!empty($this->phone_perso)) {
            $out .= dol_print_phone($this->phone_perso, $this->country_code, $contactid, $thirdpartyid, 'AC_TEL', '&nbsp;', 'phone', $langs->trans("PhonePerso"));
            $outdone++;
        }
        if (!empty($this->office_phone)) {
            $out .= dol_print_phone($this->office_phone, $this->country_code, $contactid, $thirdpartyid, 'AC_TEL', '&nbsp;', 'phone', $langs->trans("PhonePro"));
            $outdone++;
        }
        if (!empty($this->user_mobile)) {
            $out .= dol_print_phone($this->user_mobile, $this->country_code, $contactid, $thirdpartyid, 'AC_TEL', '&nbsp;', 'mobile', $langs->trans("PhoneMobile"));
            $outdone++;
        }
        if (!empty($this->fax)) {
            $out .= dol_print_phone($this->fax, $this->country_code, $contactid, $thirdpartyid, 'AC_FAX', '&nbsp;', 'fax', $langs->trans("Fax"));
            $outdone++;
        }
        if (!empty($this->office_fax)) {
            $out .= dol_print_phone($this->office_fax, $this->country_code, $contactid, $thirdpartyid, 'AC_FAX', '&nbsp;', 'fax', $langs->trans("Fax"));
            $outdone++;
        }

        if ($out) {
            $out .= '<div style="clear: both;"></div>';
        }
        $outdone = 0;
        if (!empty($this->email)) {
            $out .= dol_print_email($this->email, $this->id, $object->id, 1, 0, 0, 1);
            $outdone++;
        }
        if (!empty($this->url)) {
            //$out.=dol_print_url($this->url,'_goout',0,1);//steve changed to blank
            if (!empty($this->email)) {
                $out .= ' ';
            }
            $out .= dol_print_url($this->url, '_blank', 0, 1);
            $outdone++;
        }

        if (isModEnabled('socialnetworks')) {
            $outsocialnetwork = '';

            if (!empty($this->socialnetworks) && is_array($this->socialnetworks) && count($this->socialnetworks) > 0) {
                $socialnetworksdict = getArrayOfSocialNetworks();
                foreach ($this->socialnetworks as $key => $value) {
                    if ($value) {
                        $outsocialnetwork .= dol_print_socialnetworks($value, $this->id, $object->id, $key, $socialnetworksdict);
                    }
                    $outdone++;
                }
            }

            if ($outsocialnetwork) {
                $out .= '<div style="clear: both;">' . $outsocialnetwork . '</div>';
            }
        }

        if ($out) {
            return '<!-- BEGIN part to show address block -->' . "\n" . $out . '<!-- END Part to show address block -->' . "\n";
        } else {
            return '';
        }
    }

    /**
     * Set to upper or ucwords/lower if needed
     *
     * @return void
     */
    public function setUpperOrLowerCase()
    {
        if (getDolGlobalString('MAIN_FIRST_TO_UPPER')) {
            $this->lastname = dol_ucwords(dol_strtolower($this->lastname));
            $this->firstname = dol_ucwords(dol_strtolower($this->firstname));
            $this->name = dol_ucwords(dol_strtolower($this->name));
            if (property_exists($this, 'name_alias')) {
                $this->name_alias = isset($this->name_alias) ? dol_ucwords(dol_strtolower($this->name_alias)) : '';
            }
        }
        if (getDolGlobalString('MAIN_ALL_TO_UPPER')) {
            $this->lastname = dol_strtoupper($this->lastname);
            $this->name = dol_strtoupper($this->name);
            if (property_exists($this, 'name_alias')) {
                $this->name_alias = dol_strtoupper($this->name_alias);
            }
        }
        if (getDolGlobalString('MAIN_ALL_TOWN_TO_UPPER')) {
            $this->address = dol_strtoupper($this->address);
            $this->town = dol_strtoupper($this->town);
        }
        if (isset($this->email)) {
            $this->email = dol_strtolower($this->email);
        }
        if (isset($this->personal_email)) {
            $this->personal_email = dol_strtolower($this->personal_email);
        }
    }
}