Diglin\Ricardo\Config
Class Config
Easy to understand :-)
Configuration class for the Ricardo API
Synopsis
- // Inherited members from Zend_Config
- protected $_allowModifications;
- protected $_index;
- protected $_count;
- protected $_data;
- protected $_skipNextIteration;
- protected $_loadedSection;
- protected $_extends;
- protected $_loadFileErrorStr;
- // methods
- public void __construct()
- public string getHost()
- public string getPartnershipKey()
- public string getPartnershipPasswd()
- public bool getAllowValidationUrl()
- public string getCustomerUsername()
- public string getCustomerPassword()
- public mixed getPartnerUrl()
- public void getLogFilePath()
- // Inherited methods from Zend_Config
- public void __construct()
- public mixed get()
- public mixed __get()
- public void __set()
- public void __clone()
- public array toArray()
- public boolean __isset()
- public void __unset()
- public int count()
- public mixed current()
- public mixed key()
- public void next()
- public void rewind()
- public boolean valid()
- public mixed getSectionName()
- public boolean areAllSectionsLoaded()
- public Zend_Config merge()
- public void setReadOnly()
- public boolean readOnly()
- public array getExtends()
- public void setExtend()
- protected void _assertValidExtend()
- protected void _loadFileErrorHandler()
- protected array _arrayMergeRecursive()
Hierarchy
Members
protected
- $_allowModifications
—
boolean
Whether in-memory modifications to configuration data are allowed - $_count
—
integer
Number of elements in configuration data - $_data
—
array
Contains array of configuration data - $_extends
—
array
This is used to track section inheritance. The keys are names of sections that extend other sections, and the values are the extended sections. - $_index
—
integer
Iteration index - $_loadFileErrorStr
—
string
Load file error string. - $_loadedSection
—
mixed
Contains which config file sections were loaded. This is null if all sections were loaded, a string name if one section is loaded and an array of string names if multiple sections were loaded. - $_skipNextIteration
—
boolean
Used when unsetting values during iteration to ensure we do not skip the next element
Methods
public
- __construct()
- getAllowValidationUrl() — Get if we must simulate an authorization or not to Ricardo
- getCustomerPassword() — Get the password configuration of the customer
- getCustomerUsername() — Get the username configuration of the customer
- getHost()
- getLogFilePath()
- getPartnerUrl() — Get the partner url
- getPartnershipKey() — Partnership Key and Username are the same but Ricardo provides the partnership Key and you have to use it as a username in HTTP header
- getPartnershipPasswd() — Clear password of the partnership.
Inherited from Zend_Config
protected
- _arrayMergeRecursive() — Merge two arrays recursively, overwriting keys of the same name in $firstArray with the value in $secondArray.
- _assertValidExtend() — Throws an exception if $extendingSection may not extend $extendedSection, and tracks the section extension if it is valid.
- _loadFileErrorHandler() — Handle any errors from simplexml_load_file or parse_ini_file
public
- __clone() — Deep clone of this instance to ensure that nested Zend_Configs are also cloned.
- __get() — Magic function so that $obj->value will work.
- __isset() — Support isset() overloading on PHP 5.1
- __set() — Only allow setting of a property if $allowModifications was set to true on construction. Otherwise, throw an exception.
- __unset() — Support unset() overloading on PHP 5.1
- areAllSectionsLoaded() — Returns true if all sections were loaded
- count() — Defined by Countable interface
- current() — Defined by Iterator interface
- get() — Retrieve a value and return $default if there is no element set.
- getExtends() — Get the current extends
- getSectionName() — Returns the section name(s) loaded.
- key() — Defined by Iterator interface
- merge() — Merge another Zend_Config with this one. The items in $merge will override the same named items in the current config.
- next() — Defined by Iterator interface
- readOnly() — Returns if this Zend_Config object is read only or not.
- rewind() — Defined by Iterator interface
- setExtend() — Set an extend for Zend_Config_Writer
- setReadOnly() — Prevent any more modifications being made to this instance. Useful after merge() has been used to merge multiple Zend_Config objects into one object which should then not be modified again.
- toArray() — Return an associative array of the stored data.
- valid() — Defined by Iterator interface
History
-
2014-10-20T13:39:26+02:00 (commit #177d730)
Author: Sylvain Rayé (sly@diglin.com) / Commiter: Sylvain Rayé (sly@diglin.com)
update
-
2014-10-06T14:17:38+02:00 (commit #bf96f34)
Author: Sylvain Rayé (sly@diglin.com) / Commiter: Sylvain Rayé (sly@diglin.com)
Change Partner ID to Partner Key to keep ricardo terminology
-
2014-09-28T11:22:59+02:00 (commit #3e11a2c)
Author: Sylvain Rayé (sly@diglin.com) / Commiter: Sylvain Rayé (sly@diglin.com)
Update the License to OSL v3.0, add license file, change code header and composer.json
-
2014-08-10T20:18:28+02:00 (commit #fc0e52a)
Author: Sylvain Rayé (sly@diglin.com) / Commiter: Sylvain Rayé (sly@diglin.com)
Standardize namespace use
-
2014-08-02T19:31:40+02:00 (commit #700e7a3)
Author: Sylvain Rayé (sly@diglin.com) / Commiter: Sylvain Rayé (sly@diglin.com)
[RIC-38] Add Get Partner Url method to the config class
-
2014-07-11T01:41:36+02:00 (commit #cf380ad)
Author: Sylvain Rayé (sly@diglin.com) / Commiter: Sylvain Rayé (sly@diglin.com)
[RIC-38] Improve exception message for config class
-
2014-06-22T17:08:27+02:00 (commit #61fc8b6)
Author: Sylvain Rayé (sly@diglin.com) / Commiter: Sylvain Rayé (sly@diglin.com)
Add PhpUnit Tests for Security, SellerAccount (in progress) and System (in progress) Services. Add a way to configure the unit test, documentation exist to configure it thanks to a readme file Implement the security protocol at the manager level
-
2014-06-15T22:30:44+02:00 (commit #6b76b24)
Author: Sylvain Rayé (sly@diglin.com) / Commiter: Sylvain Rayé (sly@diglin.com)
change folders structure, add script specific for Magento to allow to install the library into it
-
2014-06-15T13:58:22+02:00 (commit #e3161ff)
Author: Sylvain Rayé (sly@diglin.com) / Commiter: Sylvain Rayé (sly@diglin.com)
init commit