RequestBuilder::addOutput() - Code Metrics - Inspection of "API break: rewrite PaymentProtocol classes" - Bit-Wasp/bitcoin-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#301)

by thomas

created 2016-05-25 00:15 UTC

RequestBuilder::addOutput() A

↳ Parent: RequestBuilder

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	3
nc	1
nop	1
dl	0
loc	5
rs	9.4285
c	1
b	0
f	0

<?php

namespace BitWasp\Bitcoin\PaymentProtocol;

use BitWasp\Bitcoin\Address\AddressInterface;
use BitWasp\Bitcoin\PaymentProtocol\Protobufs\Output;
use BitWasp\Bitcoin\PaymentProtocol\Protobufs\PaymentDetails;
use BitWasp\Bitcoin\PaymentProtocol\Protobufs\PaymentRequest;
use BitWasp\Bitcoin\Script\ScriptFactory;
use BitWasp\Bitcoin\Transaction\TransactionOutput;
use BitWasp\Bitcoin\Transaction\TransactionOutputInterface;

class RequestBuilder
{
    /**
     * Optional
     * @var string|null
     */
    private $network;

    /**
     * Repeated
     * @var TransactionOutputInterface[]
     */
    private $outputs = [];

    /**
     * Required
     * @var int
     */
    private $time;

    /**
     * Optional
     * @var int|null
     */
    private $expires;

    /**
     * Optional
     * @var string
     */
    private $memo;

    /**
     * Optional
     * @var string
     */
    private $payment_url;

    /**
     * Optional
     * @var string
     */
    private $merchant_data;

    /**
     * @var RequestSigner
     */
    private $signer;

    /**
     * @param string $memo
     * @return $this
     */
    public function setMemo($memo)
    {
        $this->memo = $memo;
        return $this;
    }

    /**
     * @param string $network
     * @return $this
     */
    public function setNetwork($network)
    {
        $this->network = $network;
        return $this;
    }

    /**
     * @param array $outputs
     * @return $this
     */
    public function setOutputs(array $outputs)
    {
        $this->outputs = [];
        foreach ($outputs as $output) {
            $this->addOutput($output);
        }

        return $this;
    }

    /**
     * @param TransactionOutputInterface $output
     * @return $this
     */
    public function addOutput(TransactionOutputInterface $output)
    {
        $this->outputs[] = $output;
        return $this;
    }

    /**
     * @param AddressInterface $address
     * @param $value
     * @return $this
     */
    public function addAddressPayment(AddressInterface $address, $value)
    {
        $script = ScriptFactory::scriptPubKey()->payToAddress($address);
        $output = new TransactionOutput($value, $script);
        return $this->addOutput($output);
    }

    /**
     * @param int $time
     * @return RequestBuilder
     */
    public function setTime($time)
    {
        $this->time = $time;
        return $this;
    }

    /**
     * @param int $expires
     * @return RequestBuilder
     */
    public function setExpires($expires)
    {
        $this->expires = $expires;
        return $this;
    }

    /**
     * @param string $payment_url
     * @return RequestBuilder
     */
    public function setPaymentUrl($payment_url)
    {
        $this->payment_url = $payment_url;
        return $this;
    }

    /**
     * @param string $merchant_data
     * @return RequestBuilder
     */
    public function setMerchantData($merchant_data)
    {
        $this->merchant_data = $merchant_data;
        return $this;
    }

    /**
     * @param RequestSigner $signer
     * @return $this
     */
    public function setSigner(RequestSigner $signer)
    {
        $this->signer = $signer;
        return $this;
    }

    /**
     * @return PaymentDetails
     */
    public function getPaymentDetails()
    {
        if (is_null($this->time)) {
            throw new \RuntimeException('Time not set on PaymentDetails');
        }

        $details = new PaymentDetails();
        if (!is_null($this->network)) {
            $details->setNetwork($this->network);
        }

        $c = 0;
        array_map(function (TransactionOutputInterface $output) use ($details, &$c) {
            $details->setOutputs(
                (new Output())
                    ->setAmount($output->getValue())
                    ->setScript($output->getScript()->getBinary()),
                $c++
            );
        }, $this->outputs);

        $details->setTime($this->time);
        if (!is_null($this->expires)) {
            $details->setExpires($this->expires);
        }

        if (!is_null($this->memo)) {
            $details->setMemo($this->memo);
        }

        if (!is_null($this->payment_url)) {
            $details->setPaymentUrl($this->payment_url);
        }

        if (!is_null($this->merchant_data)) {
            $details->setMerchantData($this->merchant_data);
        }

        return $details;
    }

    /**
     * @return PaymentRequest
     */
    public function getPaymentRequest()
    {
        // Serialize the payment details, and apply a signature based on instance of PaymentRequestSigner
        $request = new PaymentRequest();
        $request->setSerializedPaymentDetails($this->getPaymentDetails()->serialize());

        if ($this->signer instanceof RequestSigner) {
            $request = $this->signer->sign($request);
        }

        return $request;
    }
}


1			<?php
2
3			namespace BitWasp\Bitcoin\PaymentProtocol;
4
5			use BitWasp\Bitcoin\Address\AddressInterface;
6			use BitWasp\Bitcoin\PaymentProtocol\Protobufs\Output;
7			use BitWasp\Bitcoin\PaymentProtocol\Protobufs\PaymentDetails;
8			use BitWasp\Bitcoin\PaymentProtocol\Protobufs\PaymentRequest;
9			use BitWasp\Bitcoin\Script\ScriptFactory;
10			use BitWasp\Bitcoin\Transaction\TransactionOutput;
11			use BitWasp\Bitcoin\Transaction\TransactionOutputInterface;
12
13			class RequestBuilder
14			{
15			/**
16			* Optional
17			* @var string\|null
18			*/
19			private $network;
20
21			/**
22			* Repeated
23			* @var TransactionOutputInterface[]
24			*/
25			private $outputs = [];
26
27			/**
28			* Required
29			* @var int
30			*/
31			private $time;
32
33			/**
34			* Optional
35			* @var int\|null
36			*/
37			private $expires;
38
39			/**
40			* Optional
41			* @var string
42			*/
43			private $memo;
44
45			/**
46			* Optional
47			* @var string
48			*/
49			private $payment_url;
50
51			/**
52			* Optional
53			* @var string
54			*/
55			private $merchant_data;
56
57			/**
58			* @var RequestSigner
59			*/
60			private $signer;
61
62			/**
63			* @param string $memo
64			* @return $this
65			*/
66			public function setMemo($memo)
67			{
68			$this->memo = $memo;
69			return $this;
70			}
71
72			/**
73			* @param string $network
74			* @return $this
75			*/
76			public function setNetwork($network)
77			{
78			$this->network = $network;
79			return $this;
80			}
81
82			/**
83			* @param array $outputs
84			* @return $this
85			*/
86			public function setOutputs(array $outputs)
87			{
88			$this->outputs = [];
89			foreach ($outputs as $output) {
90			$this->addOutput($output);
91			}
92
93			return $this;
94			}
95
96			/**
97			* @param TransactionOutputInterface $output
98			* @return $this
99			*/
100			public function addOutput(TransactionOutputInterface $output)
101			{
102			$this->outputs[] = $output;
103			return $this;
104			}
105
106			/**
107			* @param AddressInterface $address
108			* @param $value
109			* @return $this
110			*/
111			public function addAddressPayment(AddressInterface $address, $value)
112			{
113			$script = ScriptFactory::scriptPubKey()->payToAddress($address);
114			$output = new TransactionOutput($value, $script);
115			return $this->addOutput($output);
116			}
117
118			/**
119			* @param int $time
120			* @return RequestBuilder
121			*/
122			public function setTime($time)
123			{
124			$this->time = $time;
125			return $this;
126			}
127
128			/**
129			* @param int $expires
130			* @return RequestBuilder
131			*/
132			public function setExpires($expires)
133			{
134			$this->expires = $expires;
135			return $this;
136			}
137
138			/**
139			* @param string $payment_url
140			* @return RequestBuilder
141			*/
142			public function setPaymentUrl($payment_url)
143			{
144			$this->payment_url = $payment_url;
145			return $this;
146			}
147
148			/**
149			* @param string $merchant_data
150			* @return RequestBuilder
151			*/
152			public function setMerchantData($merchant_data)
153			{
154			$this->merchant_data = $merchant_data;
155			return $this;
156			}
157
158			/**
159			* @param RequestSigner $signer
160			* @return $this
161			*/
162			public function setSigner(RequestSigner $signer)
163			{
164			$this->signer = $signer;
165			return $this;
166			}
167
168			/**
169			* @return PaymentDetails
170			*/
171			public function getPaymentDetails()
172			{
173			if (is_null($this->time)) {
174			throw new \RuntimeException('Time not set on PaymentDetails');
175			}
176
177			$details = new PaymentDetails();
178			if (!is_null($this->network)) {
179			$details->setNetwork($this->network);
180			}
181
182			$c = 0;
183			array_map(function (TransactionOutputInterface $output) use ($details, &$c) {
184			$details->setOutputs(
185			(new Output())
186			->setAmount($output->getValue())
187			->setScript($output->getScript()->getBinary()),
188			$c++
189			);
190			}, $this->outputs);
191
192			$details->setTime($this->time);
193			if (!is_null($this->expires)) {
194			$details->setExpires($this->expires);
195			}
196
197			if (!is_null($this->memo)) {
198			$details->setMemo($this->memo);
199			}
200
201			if (!is_null($this->payment_url)) {
202			$details->setPaymentUrl($this->payment_url);
203			}
204
205			if (!is_null($this->merchant_data)) {
206			$details->setMerchantData($this->merchant_data);
207			}
208
209			return $details;
210			}
211
212			/**
213			* @return PaymentRequest
214			*/
215			public function getPaymentRequest()
216			{
217			// Serialize the payment details, and apply a signature based on instance of PaymentRequestSigner
218			$request = new PaymentRequest();
219			$request->setSerializedPaymentDetails($this->getPaymentDetails()->serialize());
220
221			if ($this->signer instanceof RequestSigner) {
222			$request = $this->signer->sign($request);
223			}
224
225			return $request;
226			}
227			}
228

Bit-Wasp / bitcoin-php

Pull Request — master (#301)

RequestBuilder::addOutput() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like