Service/DeveloperGarden/Response/LocalSearch/LocalSearchResponse.php

Show:

inherited

Classes
- \Zend_Service_DeveloperGarden_Response_LocalSearch_LocalSearchResponse

Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Service
Subpackage: DeveloperGarden
Version: $Id: LocalSearchResponse.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Service_DeveloperGarden_Response_LocalSearch_LocalSearchResponse
jump to top

Package: Zend\Service\DeveloperGarden

Parent(s): \Zend_Service_DeveloperGarden_Response_BaseType < \Zend_Service_DeveloperGarden_Response_ResponseAbstract
Author: Marco Kaiser
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

string $errorCode = null

inherited

errorCode

Inherited from: \Zend_Service_DeveloperGarden_Response_ResponseAbstract::$$errorCode \Zend_Service_DeveloperGarden_Response_BaseType::$$errorCode

Default valuenullDetails

Type: string
Inherited_from: \Zend_Service_DeveloperGarden_Response_ResponseAbstract::$$errorCode
Inherited_from: \Zend_Service_DeveloperGarden_Response_BaseType::$$errorCode

string $errorMessage = null

inherited

errorMessage

Inherited from: \Zend_Service_DeveloperGarden_Response_ResponseAbstract::$$errorMessage \Zend_Service_DeveloperGarden_Response_BaseType::$$errorMessage

Default valuenullDetails

Type: string
Inherited_from: \Zend_Service_DeveloperGarden_Response_ResponseAbstract::$$errorMessage
Inherited_from: \Zend_Service_DeveloperGarden_Response_BaseType::$$errorMessage

\Zend_Service_DeveloperGarden_Response_LocalSearch_LocalSearchResponseType $searchResult = null

Default valuenullDetails

Type: \Zend_Service_DeveloperGarden_Response_LocalSearch_LocalSearchResponseType

string $statusCode = null

inherited

the status code

Inherited from: \Zend_Service_DeveloperGarden_Response_BaseType::$$statusCode

Default valuenullDetails

Type: string
Inherited_from: \Zend_Service_DeveloperGarden_Response_BaseType::$$statusCode

string $statusMessage = null

inherited

the status message

Inherited from: \Zend_Service_DeveloperGarden_Response_BaseType::$$statusMessage

Default valuenullDetails

Type: string
Inherited_from: \Zend_Service_DeveloperGarden_Response_BaseType::$$statusMessage

Methods

__construct(\Zend_Service_DeveloperGarden_Response_LocalSearch_LocalSearchResponseType $response) : void

constructor

Parameters

Name	Type	Description
$response	\Zend_Service_DeveloperGarden_Response_LocalSearch_LocalSearchResponseType

Details

Todo: implement special result methods

getErrorCode() : string | null

inherited

returns the error code (statusCode)

Inherited from: \Zend_Service_DeveloperGarden_Response_BaseType::getErrorCode()

Returns

Type	Description
string \| null

getErrorMessage() : string

inherited

returns the error message

Inherited from: \Zend_Service_DeveloperGarden_Response_BaseType::getErrorMessage()

Returns

Type	Description
string

getSearchResult() : \Zend_Service_DeveloperGarden_Response_LocalSearch_LocalSearchResponseType

returns the raw search result

Returns

Type	Description
\Zend_Service_DeveloperGarden_Response_LocalSearch_LocalSearchResponseType

getStatusCode() : string | null

inherited

returns the error code

Inherited from: \Zend_Service_DeveloperGarden_Response_BaseType::getStatusCode()

Returns

Type	Description
string \| null

getStatusMessage() : string

inherited

returns the error message

Inherited from: \Zend_Service_DeveloperGarden_Response_BaseType::getStatusMessage()

Returns

Type	Description
string

hasError() : boolean

overwrite hasError to not handle 0103 error (empty result)

Returns

Type	Description
boolean

isValid() : boolean

inherited

returns true if the errorCode is not null and not 0000

Inherited from: \Zend_Service_DeveloperGarden_Response_BaseType::isValid()

Returns

Type	Description
boolean

parse() : \Zend_Service_DeveloperGarden_Response_ResponseAbstract

inherited

parse the result

Inherited from: \Zend_Service_DeveloperGarden_Response_BaseType::parse()

Returns

Type	Description
\Zend_Service_DeveloperGarden_Response_ResponseAbstract

Throws

Exception	Description
\Zend_Service_DeveloperGarden_Response_Exception