nusoap_client_mime Klassenreferenz

Klassendiagramm für nusoap_client_mime:

[Legende]

Zusammengehörigkeiten von nusoap_client_mime:

[Legende]

Aufstellung aller Elemente

Öffentliche Methoden
	addAttachment ($data, $filename= '', $contenttype= 'application/octet-stream', $cid=false)
	clearAttachments ()
	getAttachments ()
	getHTTPBody ($soapmsg)
	getHTTPContentType ()
	getHTTPContentTypeCharset ()
	parseResponse ($headers, $data)
Öffentliche Attribute
	$requestAttachments = array()
	$responseAttachments
	$mimeContentType

---

Ausführliche Beschreibung

nusoap_client_mime client supporting MIME attachments defined at http://www.w3.org/TR/SOAP-attachments. It depends on the PEAR Mail_MIME library.

Autor:

Scott Nichol <snichol@users.sourceforge.net>

Thanks to Guillaume and Henning Reich for posting great attachment code to the mail list

Version:

Id

nusoapmime.php,v 1.12 2007/04/17 16:34:03 snichol Exp

public

Definiert in Zeile 54 der Datei nusoapmime.php.

---

Dokumentation der Elementfunktionen

nusoap_client_mime::addAttachment	(	$	data,
		$	filename = '',
		$	contenttype = 'application/octet-stream',
		$	cid = false
	)

adds a MIME attachment to the current request.

If the $data parameter contains an empty string, this method will read the contents of the file named by the $filename parameter.

If the $cid parameter is false, this method will generate the cid.

Parameter:

	string	$data The data of the attachment
	string	$filename The filename of the attachment (default is empty string)
	string	$contenttype The MIME Content-Type of the attachment (default is application/octet-stream)
	string	$cid The content-id (cid) of the attachment (default is false)

Rückgabe:

string The content-id (cid) of the attachment public

Definiert in Zeile 88 der Datei nusoapmime.php.

                                                                                                               {
                if (! $cid) {
                        $cid = md5(uniqid(time()));
                }

                $info['data'] = $data;
                $info['filename'] = $filename;
                $info['contenttype'] = $contenttype;
                $info['cid'] = $cid;
                
                $this->requestAttachments[] = $info;

                return $cid;
        }

nusoap_client_mime::clearAttachments

(

)

clears the MIME attachments for the current request.

public

Definiert in Zeile 108 der Datei nusoapmime.php.

                                    {
                $this->requestAttachments = array();
        }

nusoap_client_mime::getAttachments

(

)

gets the MIME attachments from the current response.

Each array element in the return is an associative array with keys data, filename, contenttype, cid. These keys correspond to the parameters for addAttachment.

Rückgabe:

array The attachments. public

Definiert in Zeile 122 der Datei nusoapmime.php.

                                  {
                return $this->responseAttachments;
        }

nusoap_client_mime::getHTTPBody

(

$

soapmsg

)

gets the HTTP body for the current request.

Parameter:

string

$soapmsg The SOAP payload

Rückgabe:

string The HTTP body, which includes the SOAP payload private

Erneute Implementation von nusoap_client.

Definiert in Zeile 133 der Datei nusoapmime.php.

                                       {
                if (count($this->requestAttachments) > 0) {
                        $params['content_type'] = 'multipart/related; type="text/xml"';
                        $mimeMessage =& new Mail_mimePart('', $params);
                        unset($params);

                        $params['content_type'] = 'text/xml';
                        $params['encoding']     = '8bit';
                        $params['charset']      = $this->soap_defencoding;
                        $mimeMessage->addSubpart($soapmsg, $params);
                        
                        foreach ($this->requestAttachments as $att) {
                                unset($params);

                                $params['content_type'] = $att['contenttype'];
                                $params['encoding']     = 'base64';
                                $params['disposition']  = 'attachment';
                                $params['dfilename']    = $att['filename'];
                                $params['cid']          = $att['cid'];

                                if ($att['data'] == '' && $att['filename'] <> '') {
                                        if ($fd = fopen($att['filename'], 'rb')) {
                                                $data = fread($fd, filesize($att['filename']));
                                                fclose($fd);
                                        } else {
                                                $data = '';
                                        }
                                        $mimeMessage->addSubpart($data, $params);
                                } else {
                                        $mimeMessage->addSubpart($att['data'], $params);
                                }
                        }

                        $output = $mimeMessage->encode();
                        $mimeHeaders = $output['headers'];
        
                        foreach ($mimeHeaders as $k => $v) {
                                $this->debug("MIME header $k: $v");
                                if (strtolower($k) == 'content-type') {
                                        // PHP header() seems to strip leading whitespace starting
                                        // the second line, so force everything to one line
                                        $this->mimeContentType = str_replace("\r\n", " ", $v);
                                }
                        }
        
                        return $output['body'];
                }

                return parent::getHTTPBody($soapmsg);
        }

Hier ist ein Graph der zeigt, was diese Funktion aufruft:

nusoap_client_mime::getHTTPContentType

(

)

gets the HTTP content type for the current request.

Note: getHTTPBody must be called before this.

Rückgabe:

string the HTTP content type for the current request. private

Erneute Implementation von nusoap_client.

Definiert in Zeile 192 der Datei nusoapmime.php.

                                      {
                if (count($this->requestAttachments) > 0) {
                        return $this->mimeContentType;
                }
                return parent::getHTTPContentType();
        }

nusoap_client_mime::getHTTPContentTypeCharset

(

)

gets the HTTP content type charset for the current request. returns false for non-text content types.

Note: getHTTPBody must be called before this.

Rückgabe:

string the HTTP content type charset for the current request. private

Erneute Implementation von nusoap_client.

Definiert in Zeile 208 der Datei nusoapmime.php.

                                             {
                if (count($this->requestAttachments) > 0) {
                        return false;
                }
                return parent::getHTTPContentTypeCharset();
        }

nusoap_client_mime::parseResponse	(	$	headers,
		$	data
	)

processes SOAP message returned from server

Parameter:

	array	$headers The HTTP headers
	string	$data unprocessed response data from server

Rückgabe:

mixed value of the message, decoded into a PHP type private

Erneute Implementation von nusoap_client.

Definiert in Zeile 223 der Datei nusoapmime.php.

                                            {
                $this->debug('Entering parseResponse() for payload of length ' . strlen($data) . ' and type of ' . $headers['content-type']);
                $this->responseAttachments = array();
                if (strstr($headers['content-type'], 'multipart/related')) {
                        $this->debug('Decode multipart/related');
                        $input = '';
                        foreach ($headers as $k => $v) {
                                $input .= "$k: $v\r\n";
                        }
                        $params['input'] = $input . "\r\n" . $data;
                        $params['include_bodies'] = true;
                        $params['decode_bodies'] = true;
                        $params['decode_headers'] = true;
                        
                        $structure = Mail_mimeDecode::decode($params);

                        foreach ($structure->parts as $part) {
                                if (!isset($part->disposition) && (strstr($part->headers['content-type'], 'text/xml'))) {
                                        $this->debug('Have root part of type ' . $part->headers['content-type']);
                                        $root = $part->body;
                                        $return = parent::parseResponse($part->headers, $part->body);
                                } else {
                                        $this->debug('Have an attachment of type ' . $part->headers['content-type']);
                                        $info['data'] = $part->body;
                                        $info['filename'] = isset($part->d_parameters['filename']) ? $part->d_parameters['filename'] : '';
                                        $info['contenttype'] = $part->headers['content-type'];
                                        $info['cid'] = $part->headers['content-id'];
                                        $this->responseAttachments[] = $info;
                                }
                        }
                
                        if (isset($return)) {
                                $this->responseData = $root;
                                return $return;
                        }
                        
                        $this->setError('No root part found in multipart/related content');
                        return '';
                }
                $this->debug('Not multipart/related');
                return parent::parseResponse($headers, $data);
        }

Hier ist ein Graph der zeigt, was diese Funktion aufruft:

---

Dokumentation der Datenelemente

nusoap_client_mime::$mimeContentType

Definiert in Zeile 71 der Datei nusoapmime.php.

nusoap_client_mime::$requestAttachments = array()

Definiert in Zeile 60 der Datei nusoapmime.php.

nusoap_client_mime::$responseAttachments

Definiert in Zeile 66 der Datei nusoapmime.php.

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• /nusoap/lib/nusoapmime.php