Soap.php 6.06 KB
Newer Older
1
<?php
2
3
namespace T3o\TerFe2\Service;

4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
/*******************************************************************
 *  Copyright notice
 *
 *  (c) 2011 Kai Vogel <kai.vogel@speedprogs.de>, Speedprogs.de
 *
 *  All rights reserved
 *
 *  This script is part of the TYPO3 project. The TYPO3 project 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 2 of
 *  the License, or (at your option) any later version.
 *
 *  The GNU General Public License can be found at
 *  http://www.gnu.org/copyleft/gpl.html.
 *
 *  This script 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.
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ******************************************************************/

/**
 * Service to handle soap requests
 */
31
class Soap implements \TYPO3\CMS\Core\SingletonInterface
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
{

    /**
     * @var SoapClient
     */
    protected $soapConnection;

    /**
     * @var SoapHeader
     */
    protected $authenticationHeader;


    protected
        $wsdlUrl,
        $username,
        $password,
        $returnExceptions;

    /**
     * Setup connection
     *
     * @param string $wsdlUrl URL of the wsdl
     * @param string $username Login with this username
     * @param string $password Login with this password
     * @param boolean $returnExceptions Return exception in case of errors
     * @return SoapClient
     */
    public function connect($wsdlUrl, $username = '', $password = '', $returnExceptions = FALSE)
    {

        if (empty($wsdlUrl)) {
64
            throw new \Exception('No valid wsdl URL given');
65
66
67
        }

        if (!class_exists('SoapClient')) {
68
            throw new \Exception('PHP SOAP extension not available');
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
        }

        $this->wsdlUrl = $wsdlUrl;
        $this->username = $username;
        $this->password = $password;
        $this->returnExceptions = $returnExceptions;

        return $this->resetConnection();
    }

    /**
     * creates a new connection
     *
     * A new SoapClient has to be used to prevent unexpected behavior.
     * The bug occured when registering an extension key. The response to the second request to the server (createExtensionKey)
     * just returned pure jibberish and caused an exception.
     * This seems to be a bug in PHP (@see https://bugs.php.net/bug.php?id=42191) and the easiest way to fix it, is
     * to reset the connection.
     * Maybe this bug was fixed in a newer version of PHP (don't know), but it is a real issue on my local PHP
     * installation (5.2.10). So this *might* be reverted later on.
     *
     * @author Christian Zenker <christian.zenker@599media.de>
     */
    public function resetConnection()
    {
        // Create connection
        $this->soapConnection = new SoapClient($this->wsdlUrl, array(
            'trace' => 1,
            'exceptions' => (bool)$this->returnExceptions,
            'encoding' => 'UTF-8',
            'soap_version' => SOAP_1_2,
            'cache_wsdl' => WSDL_CACHE_NONE,
        ));

        // Get authentication header
        if (!empty($this->username) && !empty($this->password)) {
            $headerData = array('username' => $this->username, 'password' => $this->password);
            $this->authenticationHeader = new SoapHeader('', 'HeaderLogin', (object)$headerData, TRUE);
        }
    }


    /**
     * Set connection object
     *
     * @param SoapClient $soapConnection SOAP connection object
     * @deprecated Christian Zenker: Seems not to be used anywhere on typo3.org and the method is useless if the connection is reset for each call
     * @return void
     */
    public function setConnection(SoapClient $soapConnection)
    {
        $this->soapConnection = $soapConnection;
    }


    /**
     * Returns current connection object
     *
     * @return SoapClient
     */
    public function getConnection()
    {
        return $this->soapConnection;
    }


    /**
     * Set authentication header
     *
     * @param SoapHeader $soapHeader SOAP header
     * @return void
     */
    public function setAuthenticationHeader(SoapHeader $authenticationHeader)
    {
        $this->authenticationHeader;
    }


    /**
     * Returns current authentication header
     *
     * @return SoapHeader
     */
    public function getAuthenticationHeader()
    {
        return $this->authenticationHeader;
    }


    /**
     * Wrapper method for SOAP calls
     *
     * @param string $methodName Method name
     * @param array $params Parameters
     * @return array Result of the SOAP call
     * @throws Exception
     */
    public function __call($methodName, array $params = array())
    {

        $this->resetConnection();
tolleiv's avatar
tolleiv committed
170
171
172

//				// Check for existing connection
//			if (empty($this->soapConnection)) {
173
//				throw new \Exception('Create SOAP connection first');
tolleiv's avatar
tolleiv committed
174
//			}
175

176
177
178
179
180
181
182
183
184
185
        // Call given method
        $response = $this->soapConnection->__soapCall(
            $methodName,
            $params,
            NULL,
            $this->authenticationHeader
        );

        // Check for errors
        if (is_soap_fault($response)) {
186
            throw new \Exception('Could not call function "' . $methodName . '" on soap server');
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
        }

        return $this->convertObjectToArray($response);
    }


    /**
     * Convert an object to array
     *
     * @param object $object Object to convert
     * @return array Converted object
     */
    protected function convertObjectToArray($object)
    {
        if (is_object($object) || is_array($object)) {
            $object = (array)$object;
            foreach ($object as $key => $value) {
                $object[$key] = $this->convertObjectToArray($value);
            }
        }

        return $object;
    }


    /**
     * Close connection
     *
     * @return void
     */
    public function disconnect()
    {
        unset($this->soapConnection, $this->authenticationHeader);
    }

}