Oledrion_manufacturer

Complexity

Total Complexity

24

Size/Duplication

Total Lines	163
Duplicated Lines	17.79 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	16	1
A	getPictureUrl()	9	9	3
A	getPicturePath()	9	9	3
B	pictureExists()	0	14	5
A	deletePicture()	0	10	4
A	deletePictures()	0	6	2
A	getLink()	11	11	2
A	getHrefTitle()	0	4	1
A	getInitial()	0	4	1
A	toArray()	0	13	2

<?php

For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 28 and the first side effect is on line 23.

/*
 You may not change or alter any portion of this comment or credits
 of supporting developers from this source code or any supporting source code
 which is considered copyrighted (c) material of the original comment or credit authors.

 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.
*/

/**
 * oledrion
 *
 * @copyright   {@link http://xoops.org/ XOOPS Project}
 * @license     {@link http://www.fsf.org/copyleft/gpl.html GNU public license}
 * @author      Hervé Thouzard (http://www.herve-thouzard.com/)
 */

/**
 * Gestion des fabricants
 */
require __DIR__ . '/classheader.php';

/**
 * Class Oledrion_manufacturer
 */
class Oledrion_manufacturer extends Oledrion_Object

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
    /**
     * constructor
     *
     * normally, this is called from child classes only
     *
     * @access public
     */
    public function __construct()
    {
        $this->initVar('manu_id', XOBJ_DTYPE_INT, null, false);
        $this->initVar('manu_name', XOBJ_DTYPE_TXTBOX, null, false);
        $this->initVar('manu_commercialname', XOBJ_DTYPE_TXTBOX, null, false);
        $this->initVar('manu_email', XOBJ_DTYPE_TXTBOX, null, false);
        $this->initVar('manu_bio', XOBJ_DTYPE_TXTAREA, null, false);
        $this->initVar('manu_url', XOBJ_DTYPE_TXTBOX, null, false);
        $this->initVar('manu_photo1', XOBJ_DTYPE_TXTBOX, null, false);
        $this->initVar('manu_photo2', XOBJ_DTYPE_TXTBOX, null, false);
        $this->initVar('manu_photo3', XOBJ_DTYPE_TXTBOX, null, false);
        $this->initVar('manu_photo4', XOBJ_DTYPE_TXTBOX, null, false);
        $this->initVar('manu_photo5', XOBJ_DTYPE_TXTBOX, null, false);
        // Pour autoriser le html
        $this->initVar('dohtml', XOBJ_DTYPE_INT, 1, false);
    }

    /**
     * Retourne l'URL d'une des 5 images du fabricant courant
     *
     * @param  integer $pictureNumber Le numéro (de 1 à 5) de l'image que l'on souhaite récupérer
     * @return mixed   L'URL    Soit l'url de l'image soit False si l'indice passé en paramètre n'est pas correct
     */
    public function getPictureUrl($pictureNumber)

This method seems to be duplicated in your project.

    {
        $pictureNumber = (int)$pictureNumber;
        if ($pictureNumber > 0 && $pictureNumber < 6) {
            return OLEDRION_PICTURES_URL . '/' . $this->getVar('manu_photo' . $pictureNumber);
        } else {
            return false;
        }
    }

    /**
     * Retourne le chemin de l'une des 5 images du fabricant courant
     *
     * @param  integer $pictureNumber Le numéro (de 1 à 5) de l'image que l'on souhaite récupérer
     * @return string  Le chemin

Should the return type not be string|false?

     */
    public function getPicturePath($pictureNumber)

This method seems to be duplicated in your project.

    {
        $pictureNumber = (int)$pictureNumber;
        if ($pictureNumber > 0 && $pictureNumber < 6) {
            return OLEDRION_PICTURES_PATH . '/' . $this->getVar('manu_photo' . $pictureNumber);
        } else {
            return false;
        }
    }

    /**
     * Indique si une des 5 images du fabricant existe
     *
     * @param  integer $pictureNumber Le numéro (de 1 à 5) de l'image que l'on souhaite récupérer
     * @return boolean Vrai si l'image existe sinon faux
     */
    public function pictureExists($pictureNumber)
    {
        $pictureNumber = (int)$pictureNumber;
        $return        = false;
        if ($pictureNumber > 0 && $pictureNumber < 6) {
            if (xoops_trim($this->getVar('manu_photo' . $pictureNumber)) != ''
                && file_exists(OLEDRION_PICTURES_PATH . '/' . $this->getVar('manu_photo' . $pictureNumber))
            ) {
                $return = true;
            }
        }

        return $return;
    }

    /**
     * Supprime une des 5 images du fabricant
     *
     * @param  integer $pictureNumber Le numéro (de 1 à 5) de l'image que l'on souhaite récupérer
     * @return void
     */
    public function deletePicture($pictureNumber)
    {
        $pictureNumber = (int)$pictureNumber;
        if ($pictureNumber > 0 && $pictureNumber < 6) {
            if ($this->pictureExists($pictureNumber)) {
                @unlink(OLEDRION_PICTURES_PATH . '/' . $this->getVar('manu_photo' . $pictureNumber));

It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

            }
            $this->setVar('manu_photo' . $pictureNumber, '');
        }
    }

    /**
     * Supprime toutes les images du fabricant (raccourcis)
     * @return void
     */
    public function deletePictures()
    {
        for ($i = 1; $i <= 5; ++$i) {
            $this->deletePicture($i);
        }
    }

    /**
     * Retourne l'url à utiliser pour accéder à la page d'un fabricant
     *
     * @return string
     */
    public function getLink()

This method seems to be duplicated in your project.

    {
        $url = '';

$url is not used, you could remove the assignment.

        if (Oledrion_utils::getModuleOption('urlrewriting') == 1) { // On utilise l'url rewriting
            $url = OLEDRION_URL . 'manufacturer-' . $this->getVar('manu_id') . Oledrion_utils::makeSeoUrl($this->getVar('manu_commercialname', 'n') . ' ' . $this->getVar('manu_name')) . '.html';
        } else { // Pas d'utilisation de l'url rewriting
            $url = OLEDRION_URL . 'manufacturer.php?manu_id=' . $this->getVar('manu_id');
        }

        return $url;
    }

    /**
     * Rentourne la chaine à envoyer dans une balise <a> pour l'attribut href
     *
     * @return string
     */
    public function getHrefTitle()
    {
        return Oledrion_utils::makeHrefTitle($this->getVar('manu_commercialname') . ' ' . $this->getVar('manu_name'));
    }

    /**
     * Retourne l'initiale du fabricant (à modifier selon le sens de l'écriture !)
     * @return string L'initiale
     */
    public function getInitial()
    {
        return strtoupper(substr($this->getVar('manu_name'), 0, 1));
    }

    /**
     * Retourne les éléments du fabricant formatés pour affichage
     *
     * @param  string $format Le format à utiliser
     * @return array  Les informations formatées
     */
    public function toArray($format = 's')
    {
        $ret = array();

$ret is not used, you could remove the assignment.

        $ret = parent::toArray($format);
        for ($i = 1; $i <= 5; ++$i) {
            $ret['manu_photo' . $i . '_url'] = $this->getPictureUrl($i);
        }
        $ret['manu_url_rewrited'] = $this->getLink();
        $ret['manu_href_title']   = $this->getHrefTitle();
        $ret['manu_initial']      = $this->getInitial();

        return $ret;
    }
}

/**
 * Class OledrionOledrion_manufacturerHandler
 */
class OledrionOledrion_manufacturerHandler extends Oledrion_XoopsPersistableObjectHandler

PSR1 recommends that each class should be in its own file to aid autoloaders.

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
    /**
     * OledrionOledrion_manufacturerHandler constructor.
     * @param XoopsDatabase|null $db
     */
    public function __construct(XoopsDatabase $db)
    { //                            Table                   Classe               Id            Identifiant
        parent::__construct($db, 'oledrion_manufacturer', 'oledrion_manufacturer', 'manu_id', 'manu_commercialname');
    }

    /**
     * Renvoie l'alphabet à partir de la première lettre du nom des fabricants
     *
     * @return array l'alphabet des lettres utilisées !
     */
    public function getAlphabet()

This method seems to be duplicated in your project.

    {
        global $myts;

Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

        $ret    = array();
        $sql    = 'SELECT DISTINCT (UPPER(SUBSTRING(manu_name, 1, 1))) as oneletter FROM ' . $this->table;
        $result = $this->db->query($sql);
        if (!$result) {
            return $ret;
        }
        while ($myrow = $this->db->fetchArray($result)) {
            $ret[] = $myts->htmlSpecialChars($myrow['oneletter']);
        }

        return $ret;
    }

    /**
     * Supprime un fabricant et tout ce qui est relatif
     *
     * @param  oledrion_manufacturer $manufacturer
     * @return boolean               Le résultat de la suppression
     */
    public function deleteManufacturer(Oledrion_manufacturer $manufacturer)
    {
        $manufacturer->deletePictures();

        return $this->delete($manufacturer, true);
    }

    /**
     * Retourne le nombre de produits associés à un fabricant
     *
     * @param  integer $manu_id L'identifiant du fabricant
     * @return integer Le nombre de produis associés à un fabricant
     */
    public function getManufacturerProductsCount($manu_id)
    {
        global $h_oledrion_productsmanu;

Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

        return $h_oledrion_productsmanu->getManufacturerProductsCount($manu_id);
    }

    /**
     * Retourne des fabricants en fonction de leur IDs
     *
     * @param  array $ids Les identifiants des produits
     * @return array Tableau d'objets de type oledrion_productsmanu
     */
    public function getManufacturersFromIds($ids)

This method seems to be duplicated in your project.

    {
        $ret = array();
        if (is_array($ids) && count($ids) > 0) {
            $criteria = new Criteria('manu_id', '(' . implode(',', $ids) . ')', 'IN');
            $ret      = $this->getObjects($criteria, true, true, '*', false);
        }

        return $ret;
    }

    /**
     * Retourne les produits d'un fabricant (note, ce code serait mieux dans une facade)
     *
     * @param  integer $manu_id Le fabricant dont on veut récupérer les produits
     * @param  integer $start   Position de départ
     * @param  integer $limit   Nombre maximum d'enregistrements à renvoyer
     * @return array   Objects de type oledrion_products
     */
    public function getManufacturerProducts($manu_id, $start = 0, $limit = 0)
    {
        $ret = $productsIds = array();

$productsIds is not used, you could remove the assignment.

$ret is not used, you could remove the assignment.

        global $h_oledrion_productsmanu, $h_oledrion_products;

Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

        // On commence par récupérer les ID des produits
        $productsIds = $h_oledrion_productsmanu->getProductsIdsFromManufacturer($manu_id, $start, $limit);
        // Puis les produits eux même
        $ret = $h_oledrion_products->getProductsFromIDs($productsIds);

        return $ret;
    }
}