Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages | Examples | Search for 

AddressType Class Reference

Inheritance diagram for AddressType:

Inheritance graph
[legend]
Collaboration diagram for AddressType:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 AddressType ()
 getName ()
 setName ($Name, $charset= 'iso-8859-1')
 getStreet1 ()
 setStreet1 ($Street1, $charset= 'iso-8859-1')
 getStreet2 ()
 setStreet2 ($Street2, $charset= 'iso-8859-1')
 getCityName ()
 setCityName ($CityName, $charset= 'iso-8859-1')
 getStateOrProvince ()
 setStateOrProvince ($StateOrProvince, $charset= 'iso-8859-1')
 getCountry ()
 setCountry ($Country, $charset= 'iso-8859-1')
 getCountryName ()
 setCountryName ($CountryName, $charset= 'iso-8859-1')
 getPhone ()
 setPhone ($Phone, $charset= 'iso-8859-1')
 getPostalCode ()
 setPostalCode ($PostalCode, $charset= 'iso-8859-1')
 getAddressID ()
 setAddressID ($AddressID, $charset= 'iso-8859-1')
 getAddressOwner ()
 setAddressOwner ($AddressOwner, $charset= 'iso-8859-1')
 getExternalAddressID ()
 setExternalAddressID ($ExternalAddressID, $charset= 'iso-8859-1')
 getInternationalName ()
 setInternationalName ($InternationalName, $charset= 'iso-8859-1')
 getInternationalStateAndCity ()
 setInternationalStateAndCity ($InternationalStateAndCity, $charset= 'iso-8859-1')
 getInternationalStreet ()
 setInternationalStreet ($InternationalStreet, $charset= 'iso-8859-1')
 getAddressStatus ()
 setAddressStatus ($AddressStatus, $charset= 'iso-8859-1')
& getSoapValue ($name, $ns=null)
 setattr ($attribute, $value)
 getattr ($attribute)
 __set_attribute ($key, $value)

Public Attributes

 $Name
 $Street1
 $Street2
 $CityName
 $StateOrProvince
 $Country
 $CountryName
 $Phone
 $PostalCode
 $AddressID
 $AddressOwner
 $ExternalAddressID
 $InternationalName
 $InternationalStateAndCity
 $InternationalStreet
 $AddressStatus
 $_elements = array()
 $_attributes = array()
 $_attributeValues = array()
 $_namespace

Detailed Description

Definition at line 16 of file AddressType.php.

Constructor & Destructor Documentation

AddressType::AddressType (   ) 
 

Definition at line 67 of file AddressType.php.

00068     {
00069         parent::XSDType();
00070         $this->_namespace = 'urn:ebay:apis:eBLBaseComponents';
00071         $this->_elements = array_merge($this->_elements,
00072             array (
00073               'Name' => 
00074               array (
00075                 'required' => false,
00076                 'type' => 'string',
00077                 'namespace' => 'urn:ebay:apis:eBLBaseComponents',
00078               ),
00079               'Street1' => 
00080               array (
00081                 'required' => false,
00082                 'type' => 'string',
00083                 'namespace' => 'urn:ebay:apis:eBLBaseComponents',
00084               ),
00085               'Street2' => 
00086               array (
00087                 'required' => false,
00088                 'type' => 'string',
00089                 'namespace' => 'urn:ebay:apis:eBLBaseComponents',
00090               ),
00091               'CityName' => 
00092               array (
00093                 'required' => false,
00094                 'type' => 'string',
00095                 'namespace' => 'urn:ebay:apis:eBLBaseComponents',
00096               ),
00097               'StateOrProvince' => 
00098               array (
00099                 'required' => false,
00100                 'type' => 'string',
00101                 'namespace' => 'urn:ebay:apis:eBLBaseComponents',
00102               ),
00103               'Country' => 
00104               array (
00105                 'required' => false,
00106                 'type' => NULL,
00107                 'namespace' => 'urn:ebay:apis:eBLBaseComponents',
00108               ),
00109               'CountryName' => 
00110               array (
00111                 'required' => false,
00112                 'type' => NULL,
00113                 'namespace' => 'urn:ebay:apis:eBLBaseComponents',
00114               ),
00115               'Phone' => 
00116               array (
00117                 'required' => false,
00118                 'type' => 'string',
00119                 'namespace' => 'urn:ebay:apis:eBLBaseComponents',
00120               ),
00121               'PostalCode' => 
00122               array (
00123                 'required' => false,
00124                 'type' => 'string',
00125                 'namespace' => 'urn:ebay:apis:eBLBaseComponents',
00126               ),
00127               'AddressID' => 
00128               array (
00129                 'required' => false,
00130                 'type' => 'string',
00131                 'namespace' => 'urn:ebay:apis:eBLBaseComponents',
00132               ),
00133               'AddressOwner' => 
00134               array (
00135                 'required' => false,
00136                 'type' => 'AddressOwnerCodeType',
00137                 'namespace' => 'urn:ebay:apis:eBLBaseComponents',
00138               ),
00139               'ExternalAddressID' => 
00140               array (
00141                 'required' => false,
00142                 'type' => 'string',
00143                 'namespace' => 'urn:ebay:apis:eBLBaseComponents',
00144               ),
00145               'InternationalName' => 
00146               array (
00147                 'required' => false,
00148                 'type' => 'string',
00149                 'namespace' => 'urn:ebay:apis:eBLBaseComponents',
00150               ),
00151               'InternationalStateAndCity' => 
00152               array (
00153                 'required' => false,
00154                 'type' => 'string',
00155                 'namespace' => 'urn:ebay:apis:eBLBaseComponents',
00156               ),
00157               'InternationalStreet' => 
00158               array (
00159                 'required' => false,
00160                 'type' => 'string',
00161                 'namespace' => 'urn:ebay:apis:eBLBaseComponents',
00162               ),
00163               'AddressStatus' => 
00164               array (
00165                 'required' => false,
00166                 'type' => 'AddressStatusCodeType',
00167                 'namespace' => 'urn:ebay:apis:eBLBaseComponents',
00168               ),
00169             ));
00170     }

Member Function Documentation

XSDType::__set_attribute (  $  key,
$  value
)  [inherited]
 

Callback for SOAP_Base::_decode() to set attributes during response decoding.

Definition at line 150 of file XSDType.php.

References XSDType::setattr().

00151     {
00152         return $this->setattr($key, $value);
00153     }

AddressType::getAddressID (   ) 
 

Definition at line 253 of file AddressType.php.

00254     {
00255         return $this->AddressID;
00256     }

AddressType::getAddressOwner (   ) 
 

Definition at line 262 of file AddressType.php.

00263     {
00264         return $this->AddressOwner;
00265     }

AddressType::getAddressStatus (   ) 
 

Definition at line 307 of file AddressType.php.

00308     {
00309         return $this->AddressStatus;
00310     }

XSDType::getattr (  $  attribute  )  [inherited]
 

Get the value of an attribute on this object.

Definition at line 139 of file XSDType.php.

00140     {
00141         return isset($this->_attributeValues[$attribute]) ?
00142             $this->_attributeValues[$attribute] :
00143             null;
00144     }

AddressType::getCityName (   ) 
 

Definition at line 199 of file AddressType.php.

00200     {
00201         return $this->CityName;
00202     }

AddressType::getCountry (   ) 
 

Definition at line 217 of file AddressType.php.

00218     {
00219         return $this->Country;
00220     }

AddressType::getCountryName (   ) 
 

Definition at line 226 of file AddressType.php.

00227     {
00228         return $this->CountryName;
00229     }

AddressType::getExternalAddressID (   ) 
 

Definition at line 271 of file AddressType.php.

00272     {
00273         return $this->ExternalAddressID;
00274     }

AddressType::getInternationalName (   ) 
 

Definition at line 280 of file AddressType.php.

00281     {
00282         return $this->InternationalName;
00283     }

AddressType::getInternationalStateAndCity (   ) 
 

Definition at line 289 of file AddressType.php.

00290     {
00291         return $this->InternationalStateAndCity;
00292     }

AddressType::getInternationalStreet (   ) 
 

Definition at line 298 of file AddressType.php.

00299     {
00300         return $this->InternationalStreet;
00301     }

AddressType::getName (   ) 
 

Definition at line 172 of file AddressType.php.

00173     {
00174         return $this->Name;
00175     }

AddressType::getPhone (   ) 
 

Definition at line 235 of file AddressType.php.

00236     {
00237         return $this->Phone;
00238     }

AddressType::getPostalCode (   ) 
 

Definition at line 244 of file AddressType.php.

00245     {
00246         return $this->PostalCode;
00247     }

& XSDType::getSoapValue (  $  name,
$  ns = null
)  [inherited]
 

Turn this type into a SOAP_Value object useable with SOAP_Client.

Parameters:
string $name The name to use for the value.
string $ns The namespace of the parent value.
Returns:
SOAP_Value A SOAP_Value object representing this type instance.

Definition at line 69 of file XSDType.php.

References $i, $value, name, and Value.

00070     {
00071         include_once 'Services/PayPal/SOAP/Value.php';
00072 
00073         $elements = array();
00074         foreach ($this->_elements as $ename => $element) {
00075             $value = $this->$ename;
00076 
00077             // Values that are null and not required can be omitted
00078             // from the serialized XML (and thus the SOAP_Value
00079             // object) entirely.
00080             if (is_null($value) && !$element['required']) {
00081                 continue;
00082             }
00083 
00084             // Append namespace prefixes if this element came from a
00085             // namespace different from the base type's namespace.
00086             if (!empty($element['namespace']) && $element['namespace'] != $this->_namespace) {
00087                 $ename = '{' . $element['namespace'] . '}' . $ename;
00088             }
00089 
00090             if (is_a($value, 'XSDType')) {
00091                 $elements[] =& $value->getSoapValue($ename, $this->_namespace);
00092             } elseif(is_array($value)) {
00093                 for($i = 0; $i < count($value); $i++) {
00094                                         if (is_a($value[$i], 'XSDType')) {
00095                                             $elements[] =& $value[$i]->getSoapValue($ename, $this->_namespace);
00096                                         } else {
00097                                             if (is_string($value[$i]) && $element['charset'] == 'iso-8859-1' &&
00098                                                 (utf8_encode(utf8_decode($value[$i])) != $value[$i])) {
00099                                                 $value[$i] = utf8_encode($value[$i]);
00100                                             }
00101                                             $elements[] =& new SOAP_Value($ename, $element['type'], $value[$i]);
00102                                         }
00103                 }
00104             } else {
00105                 if (is_string($value) && $element['charset'] == 'iso-8859-1' &&
00106                     (utf8_encode(utf8_decode($value)) != $value)) {
00107                     $value = utf8_encode($value);
00108                 }
00109                 $elements[] =& new SOAP_Value($ename, $element['type'], $value);
00110             }
00111         }
00112 
00113         if (count($elements) == 1) {
00114             $elements = array_shift($elements);
00115         }
00116 
00117         if (!is_null($ns) && $ns != $this->_namespace) {
00118             $this->_attributeValues['xmlns'] = $this->_namespace;
00119         }
00120 
00121         if (count($this->_attributeValues)) {
00122             return $v =& new SOAP_Value($name, '', $elements, $this->_attributeValues);
00123         } else {
00124             return $v =& new SOAP_Value($name, '', $elements);
00125         }
00126     }

AddressType::getStateOrProvince (   ) 
 

Definition at line 208 of file AddressType.php.

00209     {
00210         return $this->StateOrProvince;
00211     }

AddressType::getStreet1 (   ) 
 

Definition at line 181 of file AddressType.php.

00182     {
00183         return $this->Street1;
00184     }

AddressType::getStreet2 (   ) 
 

Definition at line 190 of file AddressType.php.

00191     {
00192         return $this->Street2;
00193     }

AddressType::setAddressID (  $  AddressID,
$  charset = 'iso-8859-1'
) 
 

Definition at line 257 of file AddressType.php.

References $AddressID.

00258     {
00259         $this->AddressID = $AddressID;
00260         $this->_elements['AddressID']['charset'] = $charset;
00261     }

AddressType::setAddressOwner (  $  AddressOwner,
$  charset = 'iso-8859-1'
) 
 

Definition at line 266 of file AddressType.php.

References $AddressOwner.

00267     {
00268         $this->AddressOwner = $AddressOwner;
00269         $this->_elements['AddressOwner']['charset'] = $charset;
00270     }

AddressType::setAddressStatus (  $  AddressStatus,
$  charset = 'iso-8859-1'
) 
 

Definition at line 311 of file AddressType.php.

References $AddressStatus.

00312     {
00313         $this->AddressStatus = $AddressStatus;
00314         $this->_elements['AddressStatus']['charset'] = $charset;
00315     }

XSDType::setattr (  $  attribute,
$  value
)  [inherited]
 

Set the value of an attribute on this object.

Definition at line 131 of file XSDType.php.

References $value.

Referenced by XSDType::__set_attribute().

00132     {
00133         $this->_attributeValues[$attribute] = $value;
00134     }

AddressType::setCityName (  $  CityName,
$  charset = 'iso-8859-1'
) 
 

Definition at line 203 of file AddressType.php.

References $CityName.

00204     {
00205         $this->CityName = $CityName;
00206         $this->_elements['CityName']['charset'] = $charset;
00207     }

AddressType::setCountry (  $  Country,
$  charset = 'iso-8859-1'
) 
 

Definition at line 221 of file AddressType.php.

References $Country.

00222     {
00223         $this->Country = $Country;
00224         $this->_elements['Country']['charset'] = $charset;
00225     }

AddressType::setCountryName (  $  CountryName,
$  charset = 'iso-8859-1'
) 
 

Definition at line 230 of file AddressType.php.

References $CountryName.

00231     {
00232         $this->CountryName = $CountryName;
00233         $this->_elements['CountryName']['charset'] = $charset;
00234     }

AddressType::setExternalAddressID (  $  ExternalAddressID,
$  charset = 'iso-8859-1'
) 
 

Definition at line 275 of file AddressType.php.

References $ExternalAddressID.

00276     {
00277         $this->ExternalAddressID = $ExternalAddressID;
00278         $this->_elements['ExternalAddressID']['charset'] = $charset;
00279     }

AddressType::setInternationalName (  $  InternationalName,
$  charset = 'iso-8859-1'
) 
 

Definition at line 284 of file AddressType.php.

References $InternationalName.

00285     {
00286         $this->InternationalName = $InternationalName;
00287         $this->_elements['InternationalName']['charset'] = $charset;
00288     }

AddressType::setInternationalStateAndCity (  $  InternationalStateAndCity,
$  charset = 'iso-8859-1'
) 
 

Definition at line 293 of file AddressType.php.

References $InternationalStateAndCity.

00294     {
00295         $this->InternationalStateAndCity = $InternationalStateAndCity;
00296         $this->_elements['InternationalStateAndCity']['charset'] = $charset;
00297     }

AddressType::setInternationalStreet (  $  InternationalStreet,
$  charset = 'iso-8859-1'
) 
 

Definition at line 302 of file AddressType.php.

References $InternationalStreet.

00303     {
00304         $this->InternationalStreet = $InternationalStreet;
00305         $this->_elements['InternationalStreet']['charset'] = $charset;
00306     }

AddressType::setName (  $  Name,
$  charset = 'iso-8859-1'
) 
 

Definition at line 176 of file AddressType.php.

References $Name.

00177     {
00178         $this->Name = $Name;
00179         $this->_elements['Name']['charset'] = $charset;
00180     }

AddressType::setPhone (  $  Phone,
$  charset = 'iso-8859-1'
) 
 

Definition at line 239 of file AddressType.php.

References $Phone.

00240     {
00241         $this->Phone = $Phone;
00242         $this->_elements['Phone']['charset'] = $charset;
00243     }

AddressType::setPostalCode (  $  PostalCode,
$  charset = 'iso-8859-1'
) 
 

Definition at line 248 of file AddressType.php.

References $PostalCode.

00249     {
00250         $this->PostalCode = $PostalCode;
00251         $this->_elements['PostalCode']['charset'] = $charset;
00252     }

AddressType::setStateOrProvince (  $  StateOrProvince,
$  charset = 'iso-8859-1'
) 
 

Definition at line 212 of file AddressType.php.

References $StateOrProvince.

00213     {
00214         $this->StateOrProvince = $StateOrProvince;
00215         $this->_elements['StateOrProvince']['charset'] = $charset;
00216     }

AddressType::setStreet1 (  $  Street1,
$  charset = 'iso-8859-1'
) 
 

Definition at line 185 of file AddressType.php.

References $Street1.

00186     {
00187         $this->Street1 = $Street1;
00188         $this->_elements['Street1']['charset'] = $charset;
00189     }

AddressType::setStreet2 (  $  Street2,
$  charset = 'iso-8859-1'
) 
 

Definition at line 194 of file AddressType.php.

References $Street2.

00195     {
00196         $this->Street2 = $Street2;
00197         $this->_elements['Street2']['charset'] = $charset;
00198     }

Member Data Documentation

XSDType::$_attributes = array() [inherited]
 

Definition at line 33 of file XSDType.php.

XSDType::$_attributeValues = array() [inherited]
 

Definition at line 42 of file XSDType.php.

XSDType::$_elements = array() [inherited]
 

Definition at line 24 of file XSDType.php.

XSDType::$_namespace [inherited]
 

Definition at line 51 of file XSDType.php.

AddressType::$AddressID
 

Definition at line 41 of file AddressType.php.

Referenced by setAddressID().

AddressType::$AddressOwner
 

Definition at line 43 of file AddressType.php.

Referenced by setAddressOwner().

AddressType::$AddressStatus
 

Definition at line 65 of file AddressType.php.

Referenced by setAddressStatus().

AddressType::$CityName
 

Definition at line 24 of file AddressType.php.

Referenced by setCityName().

AddressType::$Country
 

Definition at line 28 of file AddressType.php.

Referenced by setCountry().

AddressType::$CountryName
 

This element should only be used in response elements and typically should not be used in creating request messages which specify the name of a country using the Country element (which refers to a 2-letter country code).

Definition at line 35 of file AddressType.php.

Referenced by setCountryName().

AddressType::$ExternalAddressID
 

Definition at line 45 of file AddressType.php.

Referenced by setExternalAddressID().

AddressType::$InternationalName
 

Only applicable to SellerPaymentAddress today. Seller's international name that is associated with the payment address.

Definition at line 51 of file AddressType.php.

Referenced by setInternationalName().

AddressType::$InternationalStateAndCity
 

Only applicable to SellerPaymentAddress today. International state and city for the seller's payment address.

Definition at line 57 of file AddressType.php.

Referenced by setInternationalStateAndCity().

AddressType::$InternationalStreet
 

Only applicable to SellerPaymentAddress today. Seller's international street address that is associated with the payment address.

Definition at line 63 of file AddressType.php.

Referenced by setInternationalStreet().

AddressType::$Name
 

Definition at line 18 of file AddressType.php.

Referenced by setName().

AddressType::$Phone
 

Definition at line 37 of file AddressType.php.

Referenced by setPhone().

AddressType::$PostalCode
 

Definition at line 39 of file AddressType.php.

Referenced by setPostalCode().

AddressType::$StateOrProvince
 

Definition at line 26 of file AddressType.php.

Referenced by setStateOrProvince().

AddressType::$Street1
 

Definition at line 20 of file AddressType.php.

Referenced by setStreet1().

AddressType::$Street2
 

Definition at line 22 of file AddressType.php.

Referenced by setStreet2().

The documentation for this class was generated from the following file:
Generated on Fri Mar 17 14:50:03 2006 for CRE Loaded 6.2 Pro by  doxygen 1.4.4