Part-DB.Part-DB-server/src/Entity/Orderdetail.php

<?php
/**
 * Created by PhpStorm.
 * User: janhb
 * Date: 23.02.2019
 * Time: 19:14
 */

namespace App\Entity;


use Doctrine\ORM\Mapping as ORM;

/**
 * Class Orderdetail
 * @package App\Entity
 *
 * @ORM\Table("oderdetails")
 * @ORM\Entity()
 */
class Orderdetail extends DBElement
{

    /**
     * @var Part
     * @ORM\ManyToOne(targetEntity="Part", inversedBy="orderdetails")
     * @ORM\JoinColumn(name="part_id", referencedColumnName="id")
     */
    protected $part;

    /**
     * @var Supplier
     * @ORM\ManyToOne(targetEntity="Supplier", inversedBy="orderdetails")
     * @ORM\JoinColumn(name="id_supplier", referencedColumnName="id")
     */
    protected $supplier;

    /**
     * @ORM\OneToMany(targetEntity="Pricedetail", mappedBy="orderdetail")
     */
    protected $pricedetails;

    /**
     * @var string
     * @ORM\Column(type="string")
     */
    protected $supplierpartnr;

    /**
     * @var bool
     * @ORM\Column(type="boolean")
     */
    protected $obsolete;

    /**
     * @var string
     * @ORM\Column(type="string")
     */
    protected $supplier_product_url;

    /**
     * Returns the ID as an string, defined by the element class.
     * This should have a form like P000014, for a part with ID 14.
     * @return string The ID as a string;
     */
    public function getIDString(): string
    {
        return 'O' . sprintf('%06d', $this->getID());
    }

    /********************************************************************************
     *
     *   Getters
     *
     *********************************************************************************/

    /**
     * Get the part
     *
     * @return Part     the part of this orderdetails
     */
    public function getPart() : Part
    {
        return $this->part;
    }

    /**
     * Get the supplier
     *
     * @return Supplier     the supplier of this orderdetails
     *
     * @throws DatabaseException if there was an error
     */
    public function getSupplier() : Supplier
    {
        return $this->supplier;
    }

    /**
     * Get the supplier part-nr.
     *
     * @return string       the part-nr.
     */
    public function getSupplierPartNr() : string
    {
        return $this->supplierpartnr;
    }

    /**
     * Get if this orderdetails is obsolete
     *
     * "Orderdetails is obsolete" means that the part with that supplier-part-nr
     * is no longer available from the supplier of that orderdetails.
     *
     * @return boolean      @li true if this part is obsolete at that supplier
     *                      @li false if this part isn't obsolete at that supplier
     */
    public function getObsolete() : bool
    {
        return (bool) $this->obsolete;
    }

    /**
     * Get the link to the website of the article on the suppliers website.
     *
     * @param $no_automatic_url bool Set this to true, if you only want to get the local set product URL for this Orderdetail
     * and not a automatic generated one, based from the Supplier
     *
     * @return string           the link to the article
     */
    public function getSupplierProductUrl(bool $no_automatic_url = false) : string
    {
        if ($no_automatic_url || $this->supplierpartnr != '') {
            return $this->supplierpartnr;
        } else {
            return $this->getSupplier()->getAutoProductUrl($this->supplierpartnr);
        } // maybe an automatic url is available...
    }

    /**
     * Get all pricedetails
     *
     * @return Pricedetails[]    all pricedetails as a one-dimensional array of Pricedetails objects,
     *                  sorted by minimum discount quantity
     *
     * @throws Exception if there was an error
     */
    public function getPricedetails() : array
    {
        return $this->pricedetails;
    }

    /**
     * Get the price for a specific quantity
     *
     * @param boolean $as_money_string      @li if true, this method returns a money string incl. currency
     *                                      @li if false, this method returns the price as float
     * @param integer       $quantity       this is the quantity to choose the correct pricedetails
     * @param integer|NULL  $multiplier     @li This is the multiplier which will be applied to every single price
     *                                      @li If you pass NULL, the number from $quantity will be used
     *
     * @return float|null|string    float: the price as a float number (if "$as_money_string == false")
     * * null: if there are no prices and "$as_money_string == false"
     * * string:   the price as a string incl. currency (if "$as_money_string == true")
     *
     * @throws Exception if there are no pricedetails for the choosed quantity
     *          (for example, there are only one pricedetails with the minimum discount quantity '10',
     *          but the choosed quantity is '5' --> the price for 5 parts is not defined!)
     * @throws Exception if there was an error
     *
     * @see floatToMoneyString()
     */
    public function getPrice(bool $as_money_string = false, int $quantity = 1, $multiplier = null)
    {
        /**
        if (($quantity == 0) && ($multiplier === null)) {
            if ($as_money_string) {
                return floatToMoneyString(0);
            } else {
                return 0;
            }
        }

        $all_pricedetails = $this->getPricedetails();

        if (count($all_pricedetails) == 0) {
            if ($as_money_string) {
                return floatToMoneyString(null);
            } else {
                return null;
            }
        }

        foreach ($all_pricedetails as $pricedetails) {
            // choose the correct pricedetails for the choosed quantity ($quantity)
            if ($quantity < $pricedetails->getMinDiscountQuantity()) {
                break;
            }

            $correct_pricedetails = $pricedetails;
        }

        if (! isset($correct_pricedetails) || (! \is_object($correct_pricedetails))) {
            throw new Exception(_('Es sind keine Preisinformationen für die angegebene Bestellmenge vorhanden!'));
        }

        if ($multiplier === null) {
            $multiplier = $quantity;
        }

        return $correct_pricedetails->getPrice($as_money_string, $multiplier);
         * */
        //TODO
        throw new \Exception("Not implemented yet...");
    }

    /********************************************************************************
     *
     *   Setters
     *
     *********************************************************************************/

    /**
     * Set the supplier ID
     *
     * @param integer $new_supplier_id       the ID of the new supplier

     */
    public function setSupplierId(int $new_supplier_id) : self
    {
        throw new \Exception("Not implemented yet!");
        //TODO;

        return $this;
    }

    /**
     * Set the supplier part-nr.
     *
     * @param string $new_supplierpartnr       the new supplier-part-nr
     *
     */
    public function setSupplierpartnr(string $new_supplierpartnr) : self
    {
        $this->supplierpartnr = $new_supplierpartnr;
        return $this;
    }

    /**
     * Set if the part is obsolete at the supplier of that orderdetails
     *
     * @param boolean $new_obsolete       true means that this part is obsolete
     */
    public function setObsolete(bool $new_obsolete) : self
    {
        $this->obsolete = $new_obsolete;
        return $this;
    }

    /**
     * Sets the custom product supplier URL for this order detail.
     * Set this to "", if the function getSupplierProductURL should return the automatic generated URL.
     * @param $new_url string The new URL for the supplier URL.
     */
    public function setSupplierProductUrl(string $new_url)
    {
        $this->supplier_product_url = $new_url;

        return $this;
    }
}