• 홈
• Usps
• USPSBase

PHP 클래스 Usps\USPSBase

파일 보기 프로젝트 열기: vinceg/usps-php-api

공개 프로퍼티들

프로퍼티	타입	설명
$CURL_OPTS		Default options for curl.
$testMode		- set whether we are in a test mode or not

보호된 프로퍼티들

프로퍼티	타입	설명
$apiCodes		- different kind of supported api calls by this wrapper
$apiVersion	string	The api type we are about to call.
$arrayResponse	array	The response represented as an array.
$errorCode	integer	the error code if one exists.
$errorMessage	string	the error message if one exists.
$headers	array	the headers returned from the call made.
$postFields	array	All the post fields we will add to the call.
$response	string	the response message.
$username		- the usps username provided by the usps website

공개 메소드들

메소드	설명
__construct ( string $username = '' )	Constructor.
convertResponseToArray ( ) : array	Return the response represented as string.
getArrayResponse ( ) : array	Return the array representation of the last response.
getEndpoint ( )
getErrorCode ( ) : integer	Get the error code number.
getErrorMessage ( ) : string	Get the error code message.
getHeaders ( ) : array	Get the headers.
getPostData ( ) : array	Return the post data fields as an array.
getPostFields ( )
getResponse ( ) : mixed	Get the response data.
getResponseApiName ( ) : string	Response api name.
isError ( ) : boolean	Did we encounter an error?
isSuccess ( ) : boolean	Was the last call successful.
setApiVersion ( string $version ) : void	Set the api version we are going to use.
setArrayResponse ( array $value ) : void	Set the array response value.
setErrorCode ( integer $code ) : self	Set the error code number.
setErrorMessage ( string $message = '' ) : self	Set the error message.
setHeaders ( array $headers = [] ) : self	Set the headers.
setResponse ( mixed $response = '' ) : self	Set the response.
setTestMode ( boolean $value ) : void	Set whether we are in a test mode or not.
setUsername ( string $username )	set the usps api username we are going to user.

보호된 메소드들

메소드	설명
doRequest ( resource $ch = null ) : string	Makes an HTTP request. This method can be overriden by subclasses if developers want to do fancier things or use something other than curl to make the request.
getValueByKey ( array $array, string $key ) : mixed	Find a key inside a multi dim. array.
getXMLString ( ) : string	Return the xml string built that we are about to send over to the api.

메소드 상세

프로퍼티 상세