Dolibarr\Code\Variants\Classes\ProductCombination2ValuePair

Complexity

Total Complexity

9

Size/Duplication

Total Lines	153
Duplicated Lines	0 %

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	deleteByFkCombination()	0	9	2
A	__construct()	0	3	1
A	fetchByFkCombination()	0	31	3
A	create()	0	15	2
A	__toString()	0	12	1

<?php

/* Copyright (C) 2016       Marcos García               <marcosgdf@gmail.com>
 * Copyright (C) 2022       Open-Dsi		            <support@open-dsi.fr>
 * 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/>.
 */

namespace Dolibarr\Code\Variants\Classes;

use DoliDB;

/**
 *  \file       htdocs/variants/class/ProductCombination2ValuePair.class.php
 *  \ingroup    variants
 *  \brief      File of the ProductCombination2ValuePair class
 */

/**
 * Class ProductCombination2ValuePair
 * Used to represent the relation between a variant and its attributes.
 *
 * Example: a product "shirt" has a variant "shirt XL white" linked to the attributes "size: XL" and "color: white".
 * This is represented with two ProductCombination2ValuePair objects:
 * - One for "size: XL":
 *     * $object->fk_prod_combination    ID of the ProductCombination object between product "shirt" and its variant "shirt XL white"
 *     * $object->fk_prod_attr           ID of the ProductAttribute object "size"
 *     * $object->fk_prod_attr_val       ID of the ProductAttributeValue object "XL"
 * - Another for "color: white":
 *     * $object->fk_prod_combination    ID of the ProductCombination object between product "shirt" and its variant "shirt XL white"
 *     * $object->fk_prod_attr           ID of the ProductAttribute object "color"
 *     * $object->fk_prod_attr_val       ID of the ProductAttributeValue object "white"
 */
class ProductCombination2ValuePair
{
    /**
     * Database handler
     * @var DoliDB
     */
    private $db;

    /**
     * ID of this ProductCombination2ValuePair
     * @var int
     */
    public $id;

    /**
     * ID of the ProductCombination linked to this object
     * (ex: ID of the ProductCombination between product "shirt" and its variant "shirt XL white")
     * @var int
     */
    public $fk_prod_combination;

    /**
     * ID of the ProductAttribute linked to this object
     * (ex: ID of the ProductAttribute "color")
     * @var int
     */
    public $fk_prod_attr;

    /**
     * ID of the ProductAttributeValue linked to this object
     * (ex: ID of the ProductAttributeValue "white")
     * @var int
     */
    public $fk_prod_attr_val;

    /**
     * Error message
     * @var string
     */
    public $error;

    /**
     * Array of error messages
     * @var string[]
     */
    public $errors = array();

    /**
     * Constructor
     *
     * @param   DoliDB $db     Database handler
     */
    public function __construct(DoliDB $db)
    {
        $this->db = $db;
    }

    /**
     * Translates this class to a human-readable string
     *
     * @return string
     */
    public function __toString()
    {
        require_once constant('DOL_DOCUMENT_ROOT') . '/variants/class/ProductAttributeValue.class.php';
        require_once constant('DOL_DOCUMENT_ROOT') . '/variants/class/ProductAttribute.class.php';

        $prodattr = new ProductAttribute($this->db);
        $prodattrval = new ProductAttributeValue($this->db);

        $prodattr->fetch($this->fk_prod_attr);
        $prodattrval->fetch($this->fk_prod_attr_val);

        return $prodattr->label . ': ' . $prodattrval->value;
    }

    /**
     * Create a ProductCombination2ValuePair
     *
     * @param   User    $user       User that creates       //not used
     * @return  -1|1                1 if OK, -1 if KO

The doc comment -1|1 at position 0 could not be parsed: Unknown type name '-1' at position 0 in -1|1.

     */
    public function create($user)
    {
        $sql = "INSERT INTO " . MAIN_DB_PREFIX . "product_attribute_combination2val
		(fk_prod_combination, fk_prod_attr, fk_prod_attr_val)
		VALUES(" . (int) $this->fk_prod_combination . ", " . (int) $this->fk_prod_attr . ", " . (int) $this->fk_prod_attr_val . ")";

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

        if ($query) {
            $this->id = $this->db->last_insert_id(MAIN_DB_PREFIX . 'product_attribute_combination2val');

            return 1;
        }

        return -1;
    }

    /**
     * Retrieve all ProductCombination2ValuePair linked to a given ProductCombination ID.
     *
     * @param   int          $fk_combination           ID of the ProductCombination
     * @return  -1|ProductCombination2ValuePair[]      -1 if KO, array of ProductCombination2ValuePair if OK

The doc comment -1|ProductCombination2ValuePair[] at position 0 could not be parsed: Unknown type name '-1' at position 0 in -1|ProductCombination2ValuePair[].

     */
    public function fetchByFkCombination($fk_combination)
    {
        $sql = "SELECT
        c.rowid,
        c2v.fk_prod_attr_val,
        c2v.fk_prod_attr,
        c2v.fk_prod_combination
        FROM " . MAIN_DB_PREFIX . "product_attribute c LEFT JOIN " . MAIN_DB_PREFIX . "product_attribute_combination2val c2v ON c.rowid = c2v.fk_prod_attr
        WHERE c2v.fk_prod_combination = " . (int) $fk_combination;

        $sql .= $this->db->order('c.position', 'asc');

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

        if (!$query) {
            return -1;
        }

        $return = array();

        while ($obj = $this->db->fetch_object($query)) {
            $tmp = new ProductCombination2ValuePair($this->db);
            $tmp->fk_prod_attr_val = $obj->fk_prod_attr_val;
            $tmp->fk_prod_attr = $obj->fk_prod_attr;
            $tmp->fk_prod_combination = $obj->fk_prod_combination;
            $tmp->id = $obj->rowid;

            $return[] = $tmp;
        }

        return $return;
    }

    /**
     * Delete all ProductCombination2ValuePair linked to a given ProductCombination ID.
     *
     * @param       int     $fk_combination         ID of the ProductCombination
     * @return      -1|1                            -1 if KO, 1 if OK

The doc comment -1|1 at position 0 could not be parsed: Unknown type name '-1' at position 0 in -1|1.

     */
    public function deleteByFkCombination($fk_combination)
    {
        $sql = "DELETE FROM " . MAIN_DB_PREFIX . "product_attribute_combination2val WHERE fk_prod_combination = " . (int) $fk_combination;

        if ($this->db->query($sql)) {
            return 1;
        }

        return -1;
    }
}