General::get_pub_key() - Code Metrics - Inspection of "add Sign class and modify Provider31/Request/Gener..." - dshovchko/php_EasyPay - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 1dab8b...f743f0 )

by Dmitry

created 2017-11-28 11:26 UTC

General::get_pub_key() A

↳ Parent: Project

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

/**
 *      General class for all request types
 *
 *      @package php_EasyPay
 *      @version 1.1
 *      @author Dmitry Shovchko <[email protected]>
 *
 */

namespace EasyPay\Provider31\Request;

use EasyPay\Log as Log;
use EasyPay\Exception;
use EasyPay\Provider31\Request\RAW as RAW;

class General
{
    /**
     *      @var EasyPay\Provider31\Request\RAW raw request

     */
    protected $raw_request;

    /**
     *      @var string 'DateTime' node
     */
    protected $DateTime;

    /**
     *      @var string 'Sign' node
     */
    protected $Sign;

    /**
     *      @var string 'Operation' type
     */
    protected $Operation;

    /**
     *      @var string 'ServiceId' node
     */
    protected $ServiceId;

    /**
     *      @var array list of possible operations
     */
    protected $operations = array('Check','Payment','Confirm','Cancel');

    /**
     *      General constructor
     *
     *      @param EasyPay\Provider31\Request\RAW $raw Raw request data
     */
    public function __construct($raw)
    {
        $this->raw_request = $raw;

        $this->parse_request_data();
    }

    /**
     *      Get DateTime
     *
     *      @return string
     */
    public function DateTime()
    {
        return $this->DateTime;
    }

    /**
     *      Get Sign
     *
     *      @return string
     */
    public function Sign()
    {
        return $this->Sign;
    }

    /**
     *      Get Operation type
     *
     *      @return string
     */
    public function Operation()
    {
        return $this->Operation;
    }

    /**
     *      Get ServiceId
     *
     *      @return string
     */
    public function ServiceId()
    {
        return $this->ServiceId;
    }

    /**
     *      Parse xml-request, which was previously "extracted" from the body of the http request
     *
     *      @throws Exception\Structure
     */
    protected function parse_request_data()
    {
        // process <Request> group
        $r = $this->raw_request->get_nodes_from_request('Request');

        if (count($r) < 1)
        {
            throw new Exception\Structure('The xml-query does not contain any element Request!', -52);
        }

        foreach ($r[0]->childNodes as $child)
        {
            $this->check_and_parse_request_node($child, 'DateTime');
            $this->check_and_parse_request_node($child, 'Sign');

            if (in_array($child->nodeName, $this->operations))
            {
                if ( ! isset($this->Operation))
                {
                    $this->Operation = $child->nodeName;
                }
                else
                {
                    throw new Exception\Structure('There is more than one Operation type element in the xml-query!', -53);
                }
            }
        }

        if ( ! isset($this->Operation))
        {
            throw new Exception\Structure('There is no Operation type element in the xml request!', -55);
        }

        // process <Operation> group
        $r = $this->raw_request->get_nodes_from_request($this->Operation);

        foreach ($r[0]->childNodes as $child)
        {
            $this->check_and_parse_request_node($child, 'ServiceId');
        }
    }

    /**
     *      Check if present node of request and then parse it
     *
     *      @param \DOMNode $n
     *      @param string $name
     */
    protected function check_and_parse_request_node($n, $name)
    {
        if ($n->nodeName == $name)
        {
            $this->parse_request_node($n, $name);
        }
    }

    /**
     *      Parse node of request
     *
     *      @param \DOMNode $n
     *      @param string $name
     *
     *      @throws Exception\Structure
     */
    protected function parse_request_node($n, $name)
    {
        if ( ! isset($this->$name))
        {
            $this->$name = $n->nodeValue;
        }
        else
        {
            throw new Exception\Structure('There is more than one '.$name.' element in the xml-query!', -56);
        }
    }

    /**
     *      "Rough" validation of the received xml request
     *
     *      @param array $options
     *      @throws Exception\Data
     *      @throws Exception\Structure
     */
    public function validate_request($options)
    {
        $this->validate_element('DateTime');
        $this->validate_element('Sign');
        $this->validate_element('ServiceId');

        // compare received value ServiceId with option ServiceId
        if (intval($options['ServiceId']) != intval($this->ServiceId))
        {
            throw new Exception\Data('This request is not for our ServiceId!', -58);
        }
    }

    /**
     *      Validation of xml-element
     *
     *      @param string $name
     */
    public function validate_element($name)
    {
        if ( ! isset($this->$name))
        {
            throw new Exception\Structure('There is no '.$name.' element in the xml request!', -57);
        }
    }

    /**
     *      Verify signature of request
     *
     *      @param array $options
     */
    public function verify_sign($options)
    {
        $sign = new \EasyPay\Sign();
        $sign->verify(
            $this->raw_request->str(),
            $this->Sign,
            $options
        );
    }

}


1			<?php
2
3			/**
4			* General class for all request types
5			*
6			* @package php_EasyPay
7			* @version 1.1
8			* @author Dmitry Shovchko <[email protected]>
9			*
10			*/
11
12			namespace EasyPay\Provider31\Request;
13
14			use EasyPay\Log as Log;
15			use EasyPay\Exception;
16			use EasyPay\Provider31\Request\RAW as RAW;
17
18			class General
19			{
20			/**
21			* @var EasyPay\Provider31\Request\RAW raw request
			0 ignored issues – show Bug introduced 2017-11-28 10:38 UTC by Report Bug Copy Issue Report The type `EasyPay\Provider31\Reque...\Provider31\Request\RAW` was not found. Did you mean `EasyPay\Provider31\Request\RAW`? If so, make sure to prefix the type with `\`. Loading history...
22			*/
23			protected $raw_request;
24
25			/**
26			* @var string 'DateTime' node
27			*/
28			protected $DateTime;
29
30			/**
31			* @var string 'Sign' node
32			*/
33			protected $Sign;
34
35			/**
36			* @var string 'Operation' type
37			*/
38			protected $Operation;
39
40			/**
41			* @var string 'ServiceId' node
42			*/
43			protected $ServiceId;
44
45			/**
46			* @var array list of possible operations
47			*/
48			protected $operations = array('Check','Payment','Confirm','Cancel');
49
50			/**
51			* General constructor
52			*
53			* @param EasyPay\Provider31\Request\RAW $raw Raw request data
54			*/
55			public function __construct($raw)
56			{
57			$this->raw_request = $raw;
58
59			$this->parse_request_data();
60			}
61
62			/**
63			* Get DateTime
64			*
65			* @return string
66			*/
67			public function DateTime()
68			{
69			return $this->DateTime;
70			}
71
72			/**
73			* Get Sign
74			*
75			* @return string
76			*/
77			public function Sign()
78			{
79			return $this->Sign;
80			}
81
82			/**
83			* Get Operation type
84			*
85			* @return string
86			*/
87			public function Operation()
88			{
89			return $this->Operation;
90			}
91
92			/**
93			* Get ServiceId
94			*
95			* @return string
96			*/
97			public function ServiceId()
98			{
99			return $this->ServiceId;
100			}
101
102			/**
103			* Parse xml-request, which was previously "extracted" from the body of the http request
104			*
105			* @throws Exception\Structure
106			*/
107			protected function parse_request_data()
108			{
109			// process <Request> group
110			$r = $this->raw_request->get_nodes_from_request('Request');
111
112			if (count($r) < 1)
113			{
114			throw new Exception\Structure('The xml-query does not contain any element Request!', -52);
115			}
116
117			foreach ($r[0]->childNodes as $child)
118			{
119			$this->check_and_parse_request_node($child, 'DateTime');
120			$this->check_and_parse_request_node($child, 'Sign');
121
122			if (in_array($child->nodeName, $this->operations))
123			{
124			if ( ! isset($this->Operation))
125			{
126			$this->Operation = $child->nodeName;
127			}
128			else
129			{
130			throw new Exception\Structure('There is more than one Operation type element in the xml-query!', -53);
131			}
132			}
133			}
134
135			if ( ! isset($this->Operation))
136			{
137			throw new Exception\Structure('There is no Operation type element in the xml request!', -55);
138			}
139
140			// process <Operation> group
141			$r = $this->raw_request->get_nodes_from_request($this->Operation);
142
143			foreach ($r[0]->childNodes as $child)
144			{
145			$this->check_and_parse_request_node($child, 'ServiceId');
146			}
147			}
148
149			/**
150			* Check if present node of request and then parse it
151			*
152			* @param \DOMNode $n
153			* @param string $name
154			*/
155			protected function check_and_parse_request_node($n, $name)
156			{
157			if ($n->nodeName == $name)
158			{
159			$this->parse_request_node($n, $name);
160			}
161			}
162
163			/**
164			* Parse node of request
165			*
166			* @param \DOMNode $n
167			* @param string $name
168			*
169			* @throws Exception\Structure
170			*/
171			protected function parse_request_node($n, $name)
172			{
173			if ( ! isset($this->$name))
174			{
175			$this->$name = $n->nodeValue;
176			}
177			else
178			{
179			throw new Exception\Structure('There is more than one '.$name.' element in the xml-query!', -56);
180			}
181			}
182
183			/**
184			* "Rough" validation of the received xml request
185			*
186			* @param array $options
187			* @throws Exception\Data
188			* @throws Exception\Structure
189			*/
190			public function validate_request($options)
191			{
192			$this->validate_element('DateTime');
193			$this->validate_element('Sign');
194			$this->validate_element('ServiceId');
195
196			// compare received value ServiceId with option ServiceId
197			if (intval($options['ServiceId']) != intval($this->ServiceId))
198			{
199			throw new Exception\Data('This request is not for our ServiceId!', -58);
200			}
201			}
202
203			/**
204			* Validation of xml-element
205			*
206			* @param string $name
207			*/
208			public function validate_element($name)
209			{
210			if ( ! isset($this->$name))
211			{
212			throw new Exception\Structure('There is no '.$name.' element in the xml request!', -57);
213			}
214			}
215
216			/**
217			* Verify signature of request
218			*
219			* @param array $options
220			*/
221			public function verify_sign($options)
222			{
223			$sign = new \EasyPay\Sign();
224			$sign->verify(
225			$this->raw_request->str(),
226			$this->Sign,
227			$options
228			);
229			}
230
231			}
232

dshovchko / php_EasyPay

Push — master ( 1dab8b...f743f0 )

General::get_pub_key() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like