Subscription::info() - 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
Subscription::info() A

↳ Parent: Subscription
Complexity

Conditions	3
Paths	3
Size

Total Lines	20
Code Lines	14
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	3
eloc	14
nc	3
nop	1
dl	0
loc	20
rs	9.7998
c	0
b	0
f	0
<?php

/* Copyright (C) 2002-2004  Rodolphe Quiedeville        <[email protected]>
 * Copyright (C) 2006-2015  Laurent Destailleur         <[email protected]>
 * Copyright (C) 2024		MDW							<[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/subscription.class.php
 *      \ingroup    member
 *      \brief      File of class to manage subscriptions of foundation members
 */

//namespace DolibarrMember;

use Dolibarr\Core\Base\CommonObject;


/**
 *  Class to manage subscriptions of foundation members
 */
class Subscription extends CommonObject
{
    /**
     * @var string ID to identify managed object
     */
    public $element = 'subscription';

    /**
     * @var string Name of table without prefix where object is stored
     */
    public $table_element = 'subscription';

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

    /**
     * Date creation record (datec)
     *
     * @var integer
     */
    public $datec;

    /**
     * Date modification record (tms)
     *
     * @var integer
     */
    public $datem;

    /**
     * Subscription start date (date subscription)
     *
     * @var integer
     */
    public $dateh;

    /**
     * Subscription end date
     *
     * @var integer
     */
    public $datef;

    /**
     * @var int ID
     */
    public $fk_type;

    /**
     * @var int Member ID
     */
    public $fk_adherent;

    /**
     * @var double amount subscription
     */
    public $amount;

    /**
     * @var int     ID of bank in llx_bank
     */
    public $fk_bank;

    /**
     * @var array<string,array{type:string,label:string,enabled:int<0,2>|string,position:int,notnull?:int,visible:int,noteditable?:int,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int,css?:string,csslist?:string,help?:string,showoncombobox?:int,disabled?:int,arrayofkeyval?:array<int,string>,comment?:string}>  Array with all fields and their property. Do not use it as a static var. It may be modified by constructor.

     */
    public $fields = array(
        'rowid' => array('type' => 'integer', 'label' => 'TechnicalID', 'enabled' => 1, 'visible' => -1, 'notnull' => 1, 'position' => 10),
        'tms' => array('type' => 'timestamp', 'label' => 'DateModification', 'enabled' => 1, 'visible' => -1, 'notnull' => 1, 'position' => 15),
        'datec' => array('type' => 'datetime', 'label' => 'DateCreation', 'enabled' => 1, 'visible' => -1, 'position' => 20),
        'fk_adherent' => array('type' => 'integer', 'label' => 'Member', 'enabled' => 1, 'visible' => -1, 'position' => 25),
        'dateadh' => array('type' => 'datetime', 'label' => 'DateSubscription', 'enabled' => 1, 'visible' => -1, 'position' => 30),
        'datef' => array('type' => 'datetime', 'label' => 'DateEndSubscription', 'enabled' => 1, 'visible' => -1, 'position' => 35),
        'subscription' => array('type' => 'double(24,8)', 'label' => 'Amount', 'enabled' => 1, 'visible' => -1, 'position' => 40, 'isameasure' => 1),
        'fk_bank' => array('type' => 'integer', 'label' => 'BankId', 'enabled' => 1, 'visible' => -1, 'position' => 45),
        'note' => array('type' => 'html', 'label' => 'Note', 'enabled' => 1, 'visible' => -1, 'position' => 50),
        'fk_type' => array('type' => 'integer', 'label' => 'MemberType', 'enabled' => 1, 'visible' => -1, 'position' => 55),
        'fk_user_creat' => array('type' => 'integer:User:user/class/user.class.php', 'label' => 'UserAuthor', 'enabled' => 1, 'visible' => -2, 'position' => 60),
        'fk_user_valid' => array('type' => 'integer:User:user/class/user.class.php', 'label' => 'UserValidation', 'enabled' => 1, 'visible' => -1, 'position' => 65),
    );


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

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

        $this->ismultientitymanaged = 'fk_adherent@adherent';
$answer = 42;

$correct = false;

$correct = (bool) $answer;
    }


    /**
     *  Function who permitted creation of the subscription
     *
     *  @param  User    $user           User that create

     *  @param  int     $notrigger      0=launch triggers after, 1=disable triggers
     *  @return int                     Return integer <0 if KO, Id subscription created if OK
     */
    public function create($user, $notrigger = 0)
    {
        global $langs;

        $error = 0;

        $now = dol_now();

        // Check parameters
        if ($this->datef <= $this->dateh) {
            $this->error = $langs->trans("ErrorBadValueForDate");
            return -1;
        }
        if (empty($this->datec)) {
            $this->datec = $now;
        }

        $this->db->begin();

        $sql = "INSERT INTO " . MAIN_DB_PREFIX . "subscription (fk_adherent, fk_type, datec, dateadh, datef, subscription, note)";

        require_once constant('DOL_DOCUMENT_ROOT') . '/adherents/class/adherent.class.php';
        $member = new Adherent($this->db);
        $result = $member->fetch($this->fk_adherent);

        if ($this->fk_type == null) {   // If type not defined, we use the type of member
            $type = $member->typeid;
        } else {
            $type = $this->fk_type;
        }
        $sql .= " VALUES (" . ((int) $this->fk_adherent) . ", '" . $this->db->escape($type) . "', '" . $this->db->idate($now) . "',";
        $sql .= " '" . $this->db->idate($this->dateh) . "',";
        $sql .= " '" . $this->db->idate($this->datef) . "',";
        $sql .= " " . ((float) $this->amount) . ",";
        $sql .= " '" . $this->db->escape($this->note_public ? $this->note_public : $this->note) . "')";
        $sql .= " '" . $this->db->escape($this->note_public ? $this->note_public : /** @scrutinizer ignore-deprecated */ $this->note) . "')";

        $resql = $this->db->query($sql);
        if (!$resql) {
            $error++;
            $this->errors[] = $this->db->lasterror();
        }

        if (!$error) {
            $this->id = $this->db->last_insert_id(MAIN_DB_PREFIX . $this->table_element);
            $this->fk_type = $type;
        }

        if (!empty($this->linkedObjectsIds) && empty($this->linked_objects)) {  // To use new linkedObjectsIds instead of old linked_objects
            $this->linked_objects = $this->linkedObjectsIds; // TODO Replace linked_objects with linkedObjectsIds
        }

        // Add object linked
        if (!$error && $this->id && !empty($this->linked_objects) && is_array($this->linked_objects)) {
            foreach ($this->linked_objects as $origin => $tmp_origin_id) {
                if (is_array($tmp_origin_id)) {       // New behaviour, if linked_object can have several links per type, so is something like array('contract'=>array(id1, id2, ...))
                    foreach ($tmp_origin_id as $origin_id) {
                        $ret = $this->add_object_linked($origin, $origin_id);
                        if (!$ret) {
                            $this->error = $this->db->lasterror();
                            $error++;
                        }
                    }
                } else { // Old behaviour, if linked_object has only one link per type, so is something like array('contract'=>id1))
                    $origin_id = $tmp_origin_id;
                    $ret = $this->add_object_linked($origin, $origin_id);
                    if (!$ret) {
                        $this->error = $this->db->lasterror();
                        $error++;
                    }
                }
            }
        }

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

        // Commit or rollback
        if ($error) {
            $this->db->rollback();
            return -1;
        } else {
            $this->db->commit();
            return $this->id;
        }
    }


    /**
     *  Method to load a subscription
     *
     *  @param  int     $rowid      Id subscription
     *  @return int                 Return integer <0 if KO, =0 if not found, >0 if OK
     */
    public function fetch($rowid)
    {
        $sql = "SELECT rowid, fk_type, fk_adherent, datec,";
        $sql .= " tms,";
        $sql .= " dateadh as dateh,";
        $sql .= " datef,";
        $sql .= " subscription, note as note_public, fk_bank";
        $sql .= " FROM " . MAIN_DB_PREFIX . "subscription";
        $sql .= " WHERE rowid = " . ((int) $rowid);

        dol_syslog(get_class($this) . "::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->fk_type        = $obj->fk_type;
                $this->fk_adherent    = $obj->fk_adherent;
                $this->datec          = $this->db->jdate($obj->datec);
                $this->datem          = $this->db->jdate($obj->tms);
                $this->dateh          = $this->db->jdate($obj->dateh);
                $this->datef          = $this->db->jdate($obj->datef);
                $this->amount         = $obj->subscription;
                $this->note           = $obj->note_public;  // deprecated
                /** @scrutinizer ignore-deprecated */ $this->note           = $obj->note_public;  // deprecated
                $this->note_public    = $obj->note_public;
                $this->fk_bank        = $obj->fk_bank;
                return 1;
            } else {
                return 0;
            }
        } else {
            $this->error = $this->db->lasterror();
            return -1;
        }
    }


    /**
     *  Update subscription
     *
     *  @param  User    $user           User who updated
     *  @param  int     $notrigger      0=Disable triggers
     *  @return int                     Return integer <0 if KO, >0 if OK
     */
    public function update($user, $notrigger = 0)
    {
        $error = 0;

        $this->db->begin();

        if (!is_numeric($this->amount)) {
            $this->error = 'BadValueForParameterAmount';
            return -1;
        }

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

        $sql = "UPDATE " . MAIN_DB_PREFIX . "subscription SET ";
        $sql .= " fk_type = " . ((int) $this->fk_type) . ",";
        $sql .= " fk_adherent = " . ((int) $this->fk_adherent) . ",";
        $sql .= " note = " . ($this->note_public ? "'" . $this->db->escape($this->note_public) . "'" : 'null') . ",";
        $sql .= " subscription = " . (float) price2num($this->amount) . ",";
        $sql .= " dateadh = '" . $this->db->idate($this->dateh) . "',";
        $sql .= " datef = '" . $this->db->idate($this->datef) . "',";
        $sql .= " datec = '" . $this->db->idate($this->datec) . "',";
        $sql .= " fk_bank = " . ($this->fk_bank ? ((int) $this->fk_bank) : 'null');
        $sql .= " WHERE rowid = " . ((int) $this->id);

        dol_syslog(get_class($this) . "::update", LOG_DEBUG);
        $resql = $this->db->query($sql);
        if ($resql) {
            require_once constant('DOL_DOCUMENT_ROOT') . '/adherents/class/adherent.class.php';
            $member = new Adherent($this->db);
            $result = $member->fetch($this->fk_adherent);
            $result = $member->update_end_date($user);

            if (!$error && !$notrigger) {
                $this->context = array('member' => $member);
                // Call triggers
                $result = $this->call_trigger('MEMBER_SUBSCRIPTION_MODIFY', $user);
                if ($result < 0) {
                    $error++;
                } //Do also here what you must do to rollback action if trigger fail
                // End call triggers
            }
        } else {
            $error++;
            $this->error = $this->db->lasterror();
        }

        // Commit or rollback
        if ($error) {
            $this->db->rollback();
            return -1;
        } else {
            $this->db->commit();
            return $this->id;
        }
    }

    /**
     *  Delete a subscription
     *
     *  @param  User    $user       User that delete
     *  @param  int     $notrigger  0=launch triggers after, 1=disable triggers
     *  @return int                 Return integer <0 if KO, 0 if not found, >0 if OK
     */
    public function delete($user, $notrigger = 0)
    {
        $error = 0;

        // It subscription is linked to a bank transaction, we get it
        if ($this->fk_bank > 0) {
            require_once constant('DOL_DOCUMENT_ROOT') . '/compta/bank/class/account.class.php';
            $accountline = new AccountLine($this->db);

            $result = $accountline->fetch($this->fk_bank);
        }

        $this->db->begin();

        if (!$error) {
            if (!$notrigger) {
                // Call triggers
                $result = $this->call_trigger('MEMBER_SUBSCRIPTION_DELETE', $user);
                if ($result < 0) {
                    $error++;
                } // Do also here what you must do to rollback action if trigger fail
                // End call triggers
            }
        }

        if (!$error) {
            $sql = "DELETE FROM " . MAIN_DB_PREFIX . "subscription WHERE rowid = " . ((int) $this->id);
            dol_syslog(get_class($this) . "::delete", LOG_DEBUG);
            $resql = $this->db->query($sql);
            if ($resql) {
                $num = $this->db->affected_rows($resql);
                if ($num) {
                    require_once constant('DOL_DOCUMENT_ROOT') . '/adherents/class/adherent.class.php';
                    $member = new Adherent($this->db);
                    $result = $member->fetch($this->fk_adherent);
                    $result = $member->update_end_date($user);

                    if ($this->fk_bank > 0 && is_object($accountline) && $accountline->id > 0) {    // If we found bank account line (this means this->fk_bank defined)
                        $result = $accountline->delete($user); // Return false if refused because line is reconciled
                        if ($result > 0) {
                            $this->db->commit();
                            return 1;
                        } else {
                            $this->error = $accountline->error;
                            $this->db->rollback();
                            return -1;
                        }
                    } else {
                        $this->db->commit();
                        return 1;
                    }
                } else {
                    $this->db->commit();
                    return 0;
                }
            } else {
                $error++;
                $this->error = $this->db->lasterror();
            }
        }

        // Commit or rollback
        if ($error) {
            $this->db->rollback();
            return -1;
        } else {
            $this->db->commit();
            return 1;
        }
    }


    /**
     *  Return clicable name (with picto eventually)
     *
     *  @param  int     $withpicto                  0=No picto, 1=Include picto into link, 2=Only picto
     *  @param  int     $notooltip                  1=Disable tooltip
     *  @param  string  $option                     Page for link ('', 'nolink', ...)
     *  @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                              Chaine avec URL
     */
    public function getNomUrl($withpicto = 0, $notooltip = 0, $option = '', $morecss = '', $save_lastsearch_value = -1)
    {
        global $langs;

        $result = '';

        $langs->load("members");

        $label = img_picto('', $this->picto) . ' <u class="paddingrightonly">' . $langs->trans("Subscription") . '</u>';
        /*if (isset($this->statut)) {
            $label .= ' '.$this->getLibStatut(5);
        }*/
        $label .= '<br><b>' . $langs->trans('Ref') . ':</b> ' . $this->ref;
        if (!empty($this->dateh)) {
            $label .= '<br><b>' . $langs->trans('DateStart') . ':</b> ' . dol_print_date($this->dateh, 'day');
        }
        if (!empty($this->datef)) {
            $label .= '<br><b>' . $langs->trans('DateEnd') . ':</b> ' . dol_print_date($this->datef, 'day');
        }

        $url = constant('BASE_URL') . '/adherents/subscription/card.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 . '" class="classfortooltip" title="' . dol_escape_htmltag($label, 1) . '">';
        $linkend = '</a>';

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

        return $result;
    }


    /**
     *  Return the label of the status
     *
     *  @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 '';
    }

	// phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
    /**
     *  Return the label of a given status
     *
     *  @param  int     $status        Id status
     *  @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 LibStatut($status, $mode = 0)
    {
		// phpcs:enable

        //$langs->load("members");

        return '';
    }

    /**
     *  Load information of the subscription object
     *
     *  @param  int     $id       Id subscription
     *  @return void
     */
    public function info($id)
    {
        $sql = 'SELECT c.rowid, c.datec,';
        $sql .= ' c.tms as datem';
        $sql .= ' FROM ' . MAIN_DB_PREFIX . 'subscription as c';
        $sql .= ' WHERE c.rowid = ' . ((int) $id);

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

                $this->date_creation = $this->db->jdate($obj->datec);
                $this->date_modification = $this->db->jdate($obj->datem);
            }

            $this->db->free($resql);
        } else {
            dol_print_error($this->db);
        }
    }

    /**
     *  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)
    {
        $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">';
        $return .= $this->getNomUrl(0);
        $return .= '</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, 'dateh') || property_exists($this, 'datef')) {
            $return .= '<br><span class="info-box-status opacitymedium small">' . dol_print_date($this->dateh, 'day') . ' - ' . dol_print_date($this->datef, 'day') . '</span>';
        }

        if (!empty($arraydata['member']) && is_object($arraydata['member'])) {
            $return .= '<br><div class="inline-block tdoverflowmax150">' . $arraydata['member']->getNomUrl(-4) . '</div>';
        }

        if (property_exists($this, 'amount')) {
            $return .= '<br><span class="amount inline-block">' . price($this->amount) . '</span>';
            if (!empty($arraydata['bank'])) {
                $return .= ' &nbsp; <span class="info-box-label ">' . $arraydata['bank']->getNomUrl(-1) . '</span>';
            }
        }
        $return .= '</div>';
        $return .= '</div>';
        $return .= '</div>';
        return $return;
    }
}

alxarafe / alixar

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

Subscription::info() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
