CreateFlightBillCommandHandler::getCustomer() - Code Metrics - Inspection of "change type into the doc" - laudeco/bbc-dolibarr-flightlog - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/api ( 725c17...de88d6 )

by Laurent

created 2020-01-10 23:13 UTC

CreateFlightBillCommandHandler::getCustomer() A

↳ Parent: CreateFlightBillCommandHandler

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
nc	2
nop	0
dl	0
loc	10
rs	9.9332
c	0
b	0
f	0

<?php

require_once __DIR__ . '/../exceptions/ContactNotAddedException.php';
require_once __DIR__ . '/../exceptions/CustomerNotFoundException.php';
require_once __DIR__ . '/../exceptions/FlightNotFoundException.php';

/**
 * @author Laurent De Coninck <[email protected]>
 */
class CreateFlightBillCommandHandler
{
    /**
     * @var \DoliDB
     */
    protected $db;

    /**
     * @var stdClass
     */
    private $conf;

    /**
     * @var User
     */
    protected $user;

    /**
     * @var Translate
     */
    private $langs;

    /**
     * @param DoliDB    $db
     * @param stdClass  $conf
     * @param User      $user
     * @param Translate $langs
     */
    public function __construct($db, $conf, $user, $langs)

    {
        $this->db = $db;
        $this->conf = $conf;
        $this->user = $user;
        $this->langs = $langs;
    }

    /**
     * @param CreateFlightBillCommand $command
     */
    public function handle(CreateFlightBillCommand $command)
    {
        $flightProduct = $this->getProduct();
        $flight = $this->getFlight($command->getFlightId());

        $object = new Facture($this->db);
        $object->fetch_thirdparty();

        $object->socid = $command->getCustomerId();
        $object->type = $command->getBillType();
        $object->number = "provisoire";
        $object->date = (new DateTime())->getTimestamp();
        $object->date_pointoftax = "";
        $object->note_public = $command->getPublicNote();
        $object->note_private = $command->getPrivateNote();
        $object->ref_client = "";
        $object->ref_int = "";
        $object->modelpdf = $command->getModelDocument();
        $object->cond_reglement_id = $command->getBillingCondition();
        $object->mode_reglement_id = $command->getBillingType();
        $object->fk_account = $command->getBankAccount();

        $id = $object->create($this->user);

        if ($id <= 0) {
            throw new \InvalidArgumentException('Error during bill creation');
        }

        $this->addOrderLine($object, $flightProduct, $flight, $command->getNbrPax());

        $this->addLinks($object, $flight);
        $this->addContacts($object, $flight);

        $this->generateBillDocument($command, $object, $id);

        $this->validates($object, $id);

        $this->generateBillDocument($command, $object, $id);
        $this->flagFlightAsBilled($flight);
    }

    /**
     * @return Product
     */
    private function getProduct()

    {
        $flightProduct = new Product($this->db);

        if ($flightProduct->fetch($this->conf->BBC_FLIGHT_TYPE_CUSTOMER) <= 0) {
            throw new \InvalidArgumentException('Default product not configured');
        }

        return $flightProduct;
    }

    /**
     * @param int $flightId
     *
     * @return Bbcvols
     *
     * @throws FlightNotFoundException
     */
    private function getFlight($flightId)
    {
        $flight = new Bbcvols($this->db);

        if ($flight->fetch($flightId) <= 0) {
            throw new FlightNotFoundException();
        }

        return $flight;
    }

    /**
     * @param Facture $object
     * @param Bbcvols $flight
     *
     * @throws ContactNotAddedException
     */
    private function addContacts($object, $flight)
    {
        $this->addContactOnBill($object, $flight->fk_pilot, 'BBC_PILOT');
        $this->addContactOnBill($object, $flight->fk_receiver, 'BBC_RECEIVER');
        $this->addContactOnBill($object, $flight->fk_organisateur, 'BBC_ORGANISATOR');
    }

    /**
     * @param Facture $bill
     * @param int     $contactId
     * @param string  $contactType
     *
     * @throws ContactNotAddedException
     */
    private function addContactOnBill(Facture $bill, $contactId, $contactType)
    {
        if ($bill->add_contact($contactId, $contactType, 'internal') < 0) {
            throw new ContactNotAddedException($contactType);
        }
    }

    /**
     * @param Facture $object
     * @param Bbcvols $flight
     */
    private function addLinks($object, $flight)
    {
        $object->add_object_linked('flightlog_bbcvols', $flight->getId());
    }

    /**
     * @param Facture $object
     * @param int     $id
     */
    private function validates($object, $id)
    {
        $object->fetch($id);
        $object->validate($this->user);
    }

    /**
     * @return int
     */
    private function isReferenceHidden()
    {
        return (!empty($this->conf->MAIN_GENERATE_DOCUMENTS_HIDE_DETAILS) ? 1 : 0);
    }

    /**
     * @return int
     */
    private function isDescriptionHidden()
    {
        return (!empty($this->conf->MAIN_GENERATE_DOCUMENTS_HIDE_DESC) ? 1 : 0);
    }

    /**
     * @return int
     */
    private function isDetailHidden()
    {
        return (!empty($this->conf->MAIN_GENERATE_DOCUMENTS_HIDE_REF) ? 1 : 0);
    }

    /**
     * @param CreateFlightBillCommand $command
     * @param Facture                 $object
     * @param int                     $id
     */
    private function generateBillDocument(CreateFlightBillCommand $command, $object, $id)
    {
        $object->fetch($id);
        $object->generateDocument(
            $command->getModelDocument(),
            $this->langs,
            $this->isDetailHidden(),
            $this->isDescriptionHidden(),
            $this->isReferenceHidden()
        );
    }

    /**
     * @param $flightProduct
     * @param $flight
     *
     * @return float|int
     */
    private function computeDiscounts($flightProduct, $flight)
    {
        return ($flightProduct->price_ttc - ($flight->cost / $flight->nbrPax)) * 100 / $flightProduct->price_ttc;
    }

    /**
     * @param Facture $object
     * @param Product $flightProduct
     * @param Bbcvols $flight
     */
    private function addOrderLine($object, $flightProduct, $flight, $nbrPax)
    {
        $localtax1_tx = get_localtax(0, 1, $object->thirdparty);
        $localtax2_tx = get_localtax(0, 2, $object->thirdparty);

        $pu_ht = price2num($flightProduct->price, 'MU');
        $pu_ttc = price2num($flightProduct->price_ttc, 'MU');
        $pu_ht_devise = price2num($flightProduct->price, 'MU');

        $discount = $this->computeDiscounts($flightProduct, $flight);

        $result = $object->addline(
            $flightProduct->description,
            $pu_ht,
            $nbrPax,
            $flightProduct->tva_tx,
            $localtax1_tx,
            $localtax2_tx,
            $flightProduct->id,
            $discount,
            $flight->date,
            $flight->date,
            0,
            0,
            '',
            'TTC',
            $pu_ttc,
            Facture::TYPE_STANDARD,
            -1,
            0,
            '',
            0,
            0,
            '',
            '',
            $flightProduct->label,
            [],
            100,
            '',
            0,
            $pu_ht_devise
        );

        if ($result <= 0) {
            throw new \InvalidArgumentException('Error during order line creation');
        }
    }

    /**
     * @param Bbcvols $flight
     */
    private function flagFlightAsBilled($flight)
    {
        $flight->is_facture = true;
        $flight->update($this->user);
    }
}

1		<?php
2
3		require_once __DIR__ . '/../exceptions/ContactNotAddedException.php';
4		require_once __DIR__ . '/../exceptions/CustomerNotFoundException.php';
5		require_once __DIR__ . '/../exceptions/FlightNotFoundException.php';
6
7		/**
8		* @author Laurent De Coninck <[email protected]>
9		*/
10		class CreateFlightBillCommandHandler
11		{
12		/**
13		* @var \DoliDB
14		*/
15		protected $db;
16
17		/**
18		* @var stdClass
19		*/
20		private $conf;
21
22		/**
23		* @var User
24		*/
25		protected $user;
26
27		/**
28		* @var Translate
29		*/
30		private $langs;
31
32		/**
33		* @param DoliDB $db
34		* @param stdClass $conf
35		* @param User $user
36		* @param Translate $langs
37		*/
38	View Code Duplication	public function __construct($db, $conf, $user, $langs)
		0 ignored issues – show Duplication introduced 2017-12-13 13:39 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
39		{
40		$this->db = $db;
41		$this->conf = $conf;
42		$this->user = $user;
43		$this->langs = $langs;
44		}
45
46		/**
47		* @param CreateFlightBillCommand $command
48		*/
49		public function handle(CreateFlightBillCommand $command)
50		{
51		$flightProduct = $this->getProduct();
52		$flight = $this->getFlight($command->getFlightId());
53
54		$object = new Facture($this->db);
55		$object->fetch_thirdparty();
56
57		$object->socid = $command->getCustomerId();
58		$object->type = $command->getBillType();
59		$object->number = "provisoire";
60		$object->date = (new DateTime())->getTimestamp();
61		$object->date_pointoftax = "";
62		$object->note_public = $command->getPublicNote();
63		$object->note_private = $command->getPrivateNote();
64		$object->ref_client = "";
65		$object->ref_int = "";
66		$object->modelpdf = $command->getModelDocument();
67		$object->cond_reglement_id = $command->getBillingCondition();
68		$object->mode_reglement_id = $command->getBillingType();
69		$object->fk_account = $command->getBankAccount();
70
71		$id = $object->create($this->user);
72
73		if ($id <= 0) {
74		throw new \InvalidArgumentException('Error during bill creation');
75		}
76
77		$this->addOrderLine($object, $flightProduct, $flight, $command->getNbrPax());
78
79		$this->addLinks($object, $flight);
80		$this->addContacts($object, $flight);
81
82		$this->generateBillDocument($command, $object, $id);
83
84		$this->validates($object, $id);
85
86		$this->generateBillDocument($command, $object, $id);
87		$this->flagFlightAsBilled($flight);
88		}
89
90		/**
91		* @return Product
92		*/
93	View Code Duplication	private function getProduct()
		0 ignored issues – show Duplication introduced 2017-12-13 13:39 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
94		{
95		$flightProduct = new Product($this->db);
96
97		if ($flightProduct->fetch($this->conf->BBC_FLIGHT_TYPE_CUSTOMER) <= 0) {
98		throw new \InvalidArgumentException('Default product not configured');
99		}
100
101		return $flightProduct;
102		}
103
104		/**
105		* @param int $flightId
106		*
107		* @return Bbcvols
108		*
109		* @throws FlightNotFoundException
110		*/
111		private function getFlight($flightId)
112		{
113		$flight = new Bbcvols($this->db);
114
115		if ($flight->fetch($flightId) <= 0) {
116		throw new FlightNotFoundException();
117		}
118
119		return $flight;
120		}
121
122		/**
123		* @param Facture $object
124		* @param Bbcvols $flight
125		*
126		* @throws ContactNotAddedException
127		*/
128		private function addContacts($object, $flight)
129		{
130		$this->addContactOnBill($object, $flight->fk_pilot, 'BBC_PILOT');
131		$this->addContactOnBill($object, $flight->fk_receiver, 'BBC_RECEIVER');
132		$this->addContactOnBill($object, $flight->fk_organisateur, 'BBC_ORGANISATOR');
133		}
134
135		/**
136		* @param Facture $bill
137		* @param int $contactId
138		* @param string $contactType
139		*
140		* @throws ContactNotAddedException
141		*/
142		private function addContactOnBill(Facture $bill, $contactId, $contactType)
143		{
144		if ($bill->add_contact($contactId, $contactType, 'internal') < 0) {
145		throw new ContactNotAddedException($contactType);
146		}
147		}
148
149		/**
150		* @param Facture $object
151		* @param Bbcvols $flight
152		*/
153		private function addLinks($object, $flight)
154		{
155		$object->add_object_linked('flightlog_bbcvols', $flight->getId());
156		}
157
158		/**
159		* @param Facture $object
160		* @param int $id
161		*/
162		private function validates($object, $id)
163		{
164		$object->fetch($id);
165		$object->validate($this->user);
166		}
167
168		/**
169		* @return int
170		*/
171		private function isReferenceHidden()
172		{
173		return (!empty($this->conf->MAIN_GENERATE_DOCUMENTS_HIDE_DETAILS) ? 1 : 0);
174		}
175
176		/**
177		* @return int
178		*/
179		private function isDescriptionHidden()
180		{
181		return (!empty($this->conf->MAIN_GENERATE_DOCUMENTS_HIDE_DESC) ? 1 : 0);
182		}
183
184		/**
185		* @return int
186		*/
187		private function isDetailHidden()
188		{
189		return (!empty($this->conf->MAIN_GENERATE_DOCUMENTS_HIDE_REF) ? 1 : 0);
190		}
191
192		/**
193		* @param CreateFlightBillCommand $command
194		* @param Facture $object
195		* @param int $id
196		*/
197		private function generateBillDocument(CreateFlightBillCommand $command, $object, $id)
198		{
199		$object->fetch($id);
200		$object->generateDocument(
201		$command->getModelDocument(),
202		$this->langs,
203		$this->isDetailHidden(),
204		$this->isDescriptionHidden(),
205		$this->isReferenceHidden()
206		);
207		}
208
209		/**
210		* @param $flightProduct
211		* @param $flight
212		*
213		* @return float\|int
214		*/
215		private function computeDiscounts($flightProduct, $flight)
216		{
217		return ($flightProduct->price_ttc - ($flight->cost / $flight->nbrPax)) * 100 / $flightProduct->price_ttc;
218		}
219
220		/**
221		* @param Facture $object
222		* @param Product $flightProduct
223		* @param Bbcvols $flight
224		*/
225		private function addOrderLine($object, $flightProduct, $flight, $nbrPax)
226		{
227		$localtax1_tx = get_localtax(0, 1, $object->thirdparty);
228		$localtax2_tx = get_localtax(0, 2, $object->thirdparty);
229
230		$pu_ht = price2num($flightProduct->price, 'MU');
231		$pu_ttc = price2num($flightProduct->price_ttc, 'MU');
232		$pu_ht_devise = price2num($flightProduct->price, 'MU');
233
234		$discount = $this->computeDiscounts($flightProduct, $flight);
235
236		$result = $object->addline(
237		$flightProduct->description,
238		$pu_ht,
239		$nbrPax,
240		$flightProduct->tva_tx,
241		$localtax1_tx,
242		$localtax2_tx,
243		$flightProduct->id,
244		$discount,
245		$flight->date,
246		$flight->date,
247		0,
248		0,
249		'',
250		'TTC',
251		$pu_ttc,
252		Facture::TYPE_STANDARD,
253		-1,
254		0,
255		'',
256		0,
257		0,
258		'',
259		'',
260		$flightProduct->label,
261		[],
262		100,
263		'',
264		0,
265		$pu_ht_devise
266		);
267
268		if ($result <= 0) {
269		throw new \InvalidArgumentException('Error during order line creation');
270		}
271		}
272
273		/**
274		* @param Bbcvols $flight
275		*/
276		private function flagFlightAsBilled($flight)
277		{
278		$flight->is_facture = true;
279		$flight->update($this->user);
280		}
281		}

laudeco / bbc-dolibarr-flightlog

Push — feature/api ( 725c17...de88d6 )

CreateFlightBillCommandHandler::getCustomer() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like