Permalink
Browse files

Updated docs

  • Loading branch information...
1 parent c9269f6 commit 6a79a56deef9a3e9d61d4feb16fbb00324d43f2a @marcguyer committed May 22, 2013
Showing with 24,896 additions and 6,020 deletions.
  1. +1 −2 Client.php
  2. +1 −1 Client/AdapterInterface.php
  3. +8 −1 Client/CurlAdapter.php
  4. +5 −4 Client/Exception.php
  5. +7 −0 Client/ZendAdapter.php
  6. +5 −0 Http/AdapterInterface.php
  7. +6 −0 Http/NativeAdapter.php
  8. +19 −0 Http/ZendAdapter.php
  9. +32 −1 Response.php
  10. +50 −10 Response/Exception.php
  11. +0 −1,413 docs/CheddarGetter/CheddarGetter_Client.html
  12. +0 −310 docs/CheddarGetter/CheddarGetter_Client_Exception.html
  13. +0 −1,167 docs/CheddarGetter/CheddarGetter_Response.html
  14. +0 −598 docs/CheddarGetter/CheddarGetter_Response_Exception.html
  15. +0 −66 docs/CheddarGetter/_Client---Exception.php.html
  16. +0 −66 docs/CheddarGetter/_Client.php.html
  17. +0 −66 docs/CheddarGetter/_Response---Exception.php.html
  18. +0 −66 docs/CheddarGetter/_Response.php.html
  19. +0 −151 ...exsource_argetter_library_CheddarGetter_example_example.php_b47f986942834425d506870489306804.html
  20. +0 −13 docs/blank.html
  21. +1,296 −0 docs/classes/CheddarGetter_Client.html
  22. +135 −0 docs/classes/CheddarGetter_Client_AdapterInterface.html
  23. +190 −0 docs/classes/CheddarGetter_Client_CurlAdapter.html
  24. +145 −0 docs/classes/CheddarGetter_Client_Exception.html
  25. +190 −0 docs/classes/CheddarGetter_Client_ZendAdapter.html
  26. +233 −0 docs/classes/CheddarGetter_Http_AdapterInterface.html
  27. +233 −0 docs/classes/CheddarGetter_Http_NativeAdapter.html
  28. +285 −0 docs/classes/CheddarGetter_Http_ZendAdapter.html
  29. +711 −0 docs/classes/CheddarGetter_Response.html
  30. +278 −0 docs/classes/CheddarGetter_Response_Exception.html
  31. +0 −32 docs/classtrees_CheddarGetter.html
  32. +567 −0 docs/css/bootstrap-responsive.css
  33. +3 −0 docs/css/bootstrap-responsive.min.css
  34. +3,370 −0 docs/css/bootstrap.css
  35. +611 −0 docs/css/bootstrap.min.css
  36. +91 −0 docs/css/jquery.iviewer.css
  37. +1 −0 docs/css/prettify.css
  38. +516 −0 docs/css/template.css
  39. +73 −0 docs/deprecated.html
  40. +0 −850 docs/elementindex.html
  41. +0 −847 docs/elementindex_CheddarGetter.html
  42. +87 −25 docs/errors.html
  43. +70 −0 docs/graph_class.html
  44. BIN docs/img/apple-touch-icon-114x114.png
  45. BIN docs/img/apple-touch-icon-72x72.png
  46. BIN docs/img/apple-touch-icon.png
  47. BIN docs/img/favicon.ico
  48. BIN docs/img/glyphicons-halflings-white.png
  49. BIN docs/img/glyphicons-halflings.png
  50. BIN docs/img/icons/arrow_down.png
  51. BIN docs/img/icons/arrow_right.png
  52. BIN docs/img/icons/class.png
  53. BIN docs/img/icons/constant.png
  54. BIN docs/img/icons/favicon.ico
  55. BIN docs/img/icons/file-php.png
  56. BIN docs/img/icons/file.gif
  57. BIN docs/img/icons/folder.gif
  58. BIN docs/img/icons/function.png
  59. BIN docs/img/icons/icon-folder-open-big.png
  60. BIN docs/img/icons/icon-th-big.png
  61. +93 −0 docs/img/icons/icon_template.svg
  62. BIN docs/img/icons/interface.png
  63. BIN docs/img/icons/method.png
  64. BIN docs/img/icons/ok.png
  65. BIN docs/img/icons/property.png
  66. BIN docs/img/icons/search.gif
  67. BIN docs/img/icons/variable.png
  68. BIN docs/img/icons/view_source.png
  69. BIN docs/img/icons/visibility_private.png
  70. BIN docs/img/icons/visibility_protected.png
  71. BIN docs/img/icons/visibility_public.png
  72. BIN docs/img/iviewer/grab.cur
  73. BIN docs/img/iviewer/hand.cur
  74. BIN docs/img/iviewer/iviewer.rotate_left.png
  75. BIN docs/img/iviewer/iviewer.rotate_right.png
  76. BIN docs/img/iviewer/iviewer.zoom_fit.png
  77. BIN docs/img/iviewer/iviewer.zoom_fit2.gif
  78. BIN docs/img/iviewer/iviewer.zoom_in.png
  79. BIN docs/img/iviewer/iviewer.zoom_in2.gif
  80. BIN docs/img/iviewer/iviewer.zoom_out.png
  81. BIN docs/img/iviewer/iviewer.zoom_out2.gif
  82. BIN docs/img/iviewer/iviewer.zoom_zero.png
  83. BIN docs/img/iviewer/iviewer.zoom_zero2.gif
  84. BIN docs/img/loader.gif
  85. +90 −22 docs/index.html
  86. +232 −0 docs/js/SVGPan.js
  87. +1,722 −0 docs/js/bootstrap.js
  88. +1 −0 docs/js/bootstrap.min.js
  89. +154 −0 docs/js/jquery-1.4.2.min.js
  90. +9,270 −0 docs/js/jquery-1.7.1.min.js
  91. +1,012 −0 docs/js/jquery-ui-1.8.2.custom.min.js
  92. +104 −0 docs/js/jquery.cookie.js
  93. +1,045 −0 docs/js/jquery.iviewer.js
  94. +42 −0 docs/js/jquery.iviewer.min.js
  95. +13 −0 docs/js/jquery.mousewheel.min.js
  96. +467 −0 docs/js/jquery.panzoom.js
  97. +228 −0 docs/js/jquery.splitter.js
  98. +115 −0 docs/js/jquery.tools.min.js
  99. +256 −0 docs/js/jquery.treeview.js
  100. +31 −0 docs/js/menu.js
  101. +2 −0 docs/js/prettify/lang-apollo.js
  102. +18 −0 docs/js/prettify/lang-clj.js
  103. +2 −0 docs/js/prettify/lang-css.js
  104. +1 −0 docs/js/prettify/lang-go.js
  105. +2 −0 docs/js/prettify/lang-hs.js
  106. +3 −0 docs/js/prettify/lang-lisp.js
  107. +2 −0 docs/js/prettify/lang-lua.js
  108. +2 −0 docs/js/prettify/lang-ml.js
  109. +4 −0 docs/js/prettify/lang-n.js
  110. +1 −0 docs/js/prettify/lang-proto.js
  111. +2 −0 docs/js/prettify/lang-scala.js
  112. +2 −0 docs/js/prettify/lang-sql.js
  113. +1 −0 docs/js/prettify/lang-tex.js
  114. +2 −0 docs/js/prettify/lang-vb.js
  115. +3 −0 docs/js/prettify/lang-vhdl.js
  116. +2 −0 docs/js/prettify/lang-wiki.js
  117. +3 −0 docs/js/prettify/lang-xq.js
  118. +2 −0 docs/js/prettify/lang-yaml.js
  119. +28 −0 docs/js/prettify/prettify.min.js
  120. +45 −0 docs/js/sidebar.js
  121. +188 −0 docs/js/template.js
  122. +0 −40 docs/li_CheddarGetter.html
  123. +95 −0 docs/markers.html
  124. +0 −33 docs/media/banner.css
  125. BIN docs/media/images/AbstractClass.png
  126. BIN docs/media/images/AbstractClass_logo.png
  127. BIN docs/media/images/AbstractMethod.png
  128. BIN docs/media/images/AbstractPrivateClass.png
  129. BIN docs/media/images/AbstractPrivateClass_logo.png
  130. BIN docs/media/images/AbstractPrivateMethod.png
  131. BIN docs/media/images/Class.png
  132. BIN docs/media/images/Class_logo.png
  133. BIN docs/media/images/Constant.png
  134. BIN docs/media/images/Constructor.png
  135. BIN docs/media/images/Destructor.png
  136. BIN docs/media/images/Function.png
  137. BIN docs/media/images/Global.png
  138. BIN docs/media/images/I.png
  139. BIN docs/media/images/Index.png
  140. BIN docs/media/images/Interface.png
  141. BIN docs/media/images/Interface_logo.png
  142. BIN docs/media/images/L.png
  143. BIN docs/media/images/Lminus.png
  144. BIN docs/media/images/Lplus.png
  145. BIN docs/media/images/Method.png
  146. BIN docs/media/images/Page.png
  147. BIN docs/media/images/Page_logo.png
  148. BIN docs/media/images/PrivateClass.png
  149. BIN docs/media/images/PrivateClass_logo.png
  150. BIN docs/media/images/PrivateMethod.png
  151. BIN docs/media/images/PrivateVariable.png
  152. BIN docs/media/images/StaticMethod.png
  153. BIN docs/media/images/StaticVariable.png
  154. BIN docs/media/images/T.png
  155. BIN docs/media/images/Tminus.png
  156. BIN docs/media/images/Tplus.png
  157. BIN docs/media/images/Variable.png
  158. BIN docs/media/images/blank.png
  159. BIN docs/media/images/class_folder.png
  160. BIN docs/media/images/empty.png
  161. BIN docs/media/images/file.png
  162. BIN docs/media/images/folder.png
  163. BIN docs/media/images/function_folder.png
  164. BIN docs/media/images/next_button.png
  165. BIN docs/media/images/next_button_disabled.png
  166. BIN docs/media/images/package.png
  167. BIN docs/media/images/package_folder.png
  168. BIN docs/media/images/previous_button.png
  169. BIN docs/media/images/previous_button_disabled.png
  170. BIN docs/media/images/private_class_logo.png
  171. BIN docs/media/images/tutorial.png
  172. BIN docs/media/images/tutorial_folder.png
  173. BIN docs/media/images/up_button.png
  174. +0 −146 docs/media/stylesheet.css
  175. +154 −0 docs/namespaces/global.html
  176. +0 −32 docs/packages.html
  177. +165 −0 docs/packages/CheddarGetter.html
  178. +73 −0 docs/packages/Default.html
  179. +0 −58 docs/ric_README.html
Sorry, we could not display the entire diff because it was too big.
View
3 Client.php
@@ -1,6 +1,7 @@
<?php
/**
+ * CheddarGetter
* @category CheddarGetter
* @package CheddarGetter
* @author Marc Guyer <marc@cheddargetter.com>
@@ -489,8 +490,6 @@ public function deleteCustomer($code, $id = null) {
* if a gateway is configured.
*
* @link https://cheddargetter.com/developers#delete-all-customers
- * @param string $code Your code for the customer
- * @param string|null $id CG id for the customer
* @return CheddarGetter_Response
* @throws CheddarGetter_Response_Exception
*/
View
2 Client/AdapterInterface.php
@@ -1,6 +1,6 @@
<?php
-
/**
+ * CheddarGetter
* @category CheddarGetter
* @package CheddarGetter
* @author Marc Guyer <marc@cheddargetter.com>
View
9 Client/CurlAdapter.php
@@ -1,6 +1,6 @@
<?php
-
/**
+ * CheddarGetter
* @category CheddarGetter
* @package CheddarGetter
* @author Marc Guyer <marc@cheddargetter.com>
@@ -16,9 +16,15 @@
class CheddarGetter_Client_CurlAdapter implements CheddarGetter_Client_AdapterInterface {
+ /**
+ * The curl resource
+ *
+ * @var resource|null
+ */
protected $_resource;
/**
+ * Constructor
* @param resource $resource
* @throws CheddarGetter_Client_Exception Throws an exception if php-curl is not available.
*/
@@ -85,6 +91,7 @@ public function request($url, $username, $password, array $args = null) {
}
/**
+ * Get the curl resource if set
* @return null|resource
*/
public function getCurlResource() {
View
9 Client/Exception.php
@@ -1,23 +1,24 @@
<?php
/**
+ * CheddarGetter
* @category CheddarGetter
* @package CheddarGetter
* @author Marc Guyer <marc@cheddargetter.com>
*/
/**
- * Client exception object
+ * Client exception object
* @category CheddarGetter
* @package CheddarGetter
* @author Marc Guyer <marc@cheddargetter.com>
*/
-
+
class CheddarGetter_Client_Exception extends Exception {
-
+
const REQUEST_INVALID = 400;
const PRECONDITION_FAILED = 412;
const NOT_FOUND = 404;
const DATA_INVALID = 500;
const USAGE_INVALID = 500;
const UNKNOWN = 500;
-
+
}
View
7 Client/ZendAdapter.php
@@ -1,6 +1,7 @@
<?php
/**
+ * CheddarGetter
* @category CheddarGetter
* @package CheddarGetter
* @author Marc Guyer <marc@cheddargetter.com>
@@ -16,9 +17,14 @@
class CheddarGetter_Client_ZendAdapter implements CheddarGetter_Client_AdapterInterface {
+ /**
+ * Http client object
+ * @var Zend_Http_Client|null
+ */
protected $_client;
/**
+ * Constructor
* @param Zend_Http_Client $client
* @throws CheddarGetter_Client_Exception Throws an exception if Zend_Http_Client is not available.
*/
@@ -73,6 +79,7 @@ public function request($url, $username, $password, array $args = null) {
}
/**
+ * Get the http client object
* @return null|Zend_Http_Client
*/
public function getClient() {
View
5 Http/AdapterInterface.php
@@ -1,6 +1,7 @@
<?php
/**
+ * CheddarGetter
* @category CheddarGetter
* @package CheddarGetter
* @author Marc Guyer <marc@cheddargetter.com>
@@ -55,21 +56,25 @@ function setCookie($name, $data, $expire, $path, $domain, $secure = false, $http
function getRequestValue($key);
/**
+ * Checks whether the referrer exists
* @return boolean
*/
function hasReferrer();
/**
+ * Gets the referrer
* @return string
*/
function getReferrer();
/**
+ * Checks if the IP is set
* @return boolean
*/
function hasIp();
/**
+ * Gets the IP
* @return string
*/
function getIp();
View
6 Http/NativeAdapter.php
@@ -1,6 +1,7 @@
<?php
/**
+ * CheddarGetter
* @category CheddarGetter
* @package CheddarGetter
* @author Marc Guyer <marc@cheddargetter.com>
@@ -54,6 +55,7 @@ public function setCookie($name, $data, $expire, $path, $domain, $secure = false
}
/**
+ * Get a value from the request (get/post/cookie)
* @param string $key
* @return mixed
*/
@@ -62,27 +64,31 @@ public function getRequestValue($key) {
}
/**
+ * Check if the http referrer is set
* @return boolean
*/
public function hasReferrer() {
return !empty($_SERVER['HTTP_REFERER']);
}
/**
+ * Get the http referrer
* @return string
*/
public function getReferrer() {
return $this->hasReferrer() ? $_SERVER['HTTP_REFERER'] : '';
}
/**
+ * Check if the remote IP is known
* @return boolean
*/
public function hasIp() {
return !empty($_SERVER['REMOTE_ADDR']);
}
/**
+ * Get the remote ip
* @return string
*/
public function getIp() {
View
19 Http/ZendAdapter.php
@@ -1,6 +1,7 @@
<?php
/**
+ * CheddarGetter
* @category CheddarGetter
* @package CheddarGetter
* @author Marc Guyer <marc@cheddargetter.com>
@@ -16,14 +17,27 @@
class CheddarGetter_Http_ZendAdapter extends CheddarGetter_Http_NativeAdapter {
+ /**
+ * The request object
+ *
+ * @var Zend_Controller_Request_Abstract|null
+ */
private $_request;
+ /**
+ * Constructor
+ * @throws CheddarGetter_Client_Exception Throws an exception if Zend_Controller_Front is not available.
+ */
public function __construct() {
if (!class_exists('Zend_Controller_Front')) {
throw new CheddarGetter_Client_Exception('The Zend front controller is not available.', CheddarGetter_Client_Exception::USAGE_INVALID);
}
}
+ /**
+ * Get the reqeust object
+ * @return Zend_Controller_Request_Abstract
+ */
private function _request() {
if ($this->_request) {
return $this->_request;
@@ -33,6 +47,7 @@ private function _request() {
}
/**
+ * Get a request param
* @param string $key
* @return mixed
*/
@@ -61,27 +76,31 @@ function getCookie($name) {
}
/**
+ * Check if the http referrer is set
* @return boolean
*/
function hasReferrer() {
return $this->_request() ? (bool) $this->_request()->getServer('HTTP_REFERER') : false;
}
/**
+ * Get the http referrer
* @return string
*/
function getReferrer() {
return $this->_request() ? $this->_request()->getServer('HTTP_REFERER') : null;
}
/**
+ * Check if the remote ip is known
* @return boolean
*/
public function hasIp() {
return $this->_request() ? (bool) $this->_request()->getServer('REMOTE_ADDR') : false;
}
/**
+ * Get the remote ip
* @return string
*/
public function getIp() {
View
33 Response.php
@@ -1,6 +1,7 @@
<?php
/**
+ * CheddarGetter
* @category CheddarGetter
* @package CheddarGetter
* @author Marc Guyer <marc@cheddargetter.com>
@@ -14,7 +15,16 @@
class CheddarGetter_Response extends DOMDocument {
+ /**
+ * The type of response (customers or plans or promotions or error)
+ * @var string
+ */
private $_responseType;
+
+ /**
+ * An array representation of the response obj
+ * @var array
+ */
private $_array;
/**
@@ -36,11 +46,22 @@ public function __construct($response) {
$this->handleError();
}
+ /**
+ * Sleep
+ *
+ * This is run when the object is serialized, for example. See PHP magic __sleep method docs.
+ * @return array
+ */
public function __sleep() {
$this->_xml = $this->saveXML();
return array('_xml', '_responseType');
}
+ /**
+ * Wakeup
+ *
+ * This is run when the object is unserialized, for example. See PHP magic __wakeup method docs.
+ */
public function __wakeup() {
$this->loadXML( $this->_xml );
}
@@ -114,7 +135,7 @@ public function toJson() {
/**
* Recursive method to traverse the dom and produce an array
*
- * @param $nodes DOMNodeList
+ * @param DOMNodeList $nodes
* @return array
*/
protected function _toArray(DOMNodeList $nodes) {
@@ -533,6 +554,12 @@ public function getCustomerItemQuantityOverageCost($code = null, $itemCode = nul
return 0;
}
+ /**
+ * Handle an error if there is one
+ *
+ * @throws CheddarGetter_Response_Exception Throws CheddarGetter_Response_Exception if an error is found in the response
+ * @return bool
+ */
public function handleError() {
if ($this->_responseType == 'error') {
throw new CheddarGetter_Response_Exception($this->documentElement->firstChild->nodeValue, $this->documentElement->getAttribute('code'), $this->documentElement->getAttribute('id'), $this->documentElement->getAttribute('auxCode'));
@@ -562,6 +589,10 @@ public function handleEmbeddedErrors() {
return false;
}
+ /**
+ * Implementation of the magic __toString method
+ * @return string The XML string
+ */
public function __toString() {
return $this->saveXML();
}
View
60 Response/Exception.php
@@ -1,51 +1,91 @@
<?php
/**
+ * CheddarGetter
* @category CheddarGetter
* @package CheddarGetter
* @author Marc Guyer <marc@cheddargetter.com>
*/
/**
- * Response exception object
+ * Response exception object
* @category CheddarGetter
* @package CheddarGetter
* @author Marc Guyer <marc@cheddargetter.com>
+ * @link http://support.cheddargetter.com/kb/api-8/error-handling
*/
-
+
class CheddarGetter_Response_Exception extends Exception {
-
+
const REQUEST_INVALID = 400;
const NOT_FOUND = 404;
const PRECONDITION_FAILED = 412;
const UNPROCESSABLE_ENTITY = 422;
const DATA_INVALID = 500;
const USAGE_INVALID = 500;
const UNKNOWN = 500;
-
+
+ /**
+ * The log id of the error
+ * @var int|null
+ */
protected $id;
+ /**
+ * The auxCode of the error
+ *
+ * The auxCode is set if the error response contains one.
+ * It references additional information about the error.
+ * For more information, see the error handling KB article
+ * @var string|null
+ * @link http://support.cheddargetter.com/kb/api-8/error-handling
+ */
protected $auxCode;
-
+
+ /**
+ * Constructor
+ * @param string|null $message The message from the error response
+ * @param int $code The error code from the response (http status code)
+ * @param string|null $id The log id of the error record
+ * @param string|null $auxCode The auxCode from the error response
+ */
public function __construct($message = null, $code = 0, $id = null, $auxCode = null) {
parent::__construct($message, $code);
$this->setId($id);
$this->setAuxCode($auxCode);
}
-
+
+ /**
+ * Set the error log id
+ * @param int
+ * @return CheddarGetter_Response_Exception
+ */
public function setId($id) {
$this->id = $id;
return $this;
}
-
+
+ /**
+ * Set the auxCode
+ * @param string
+ * @return CheddarGetter_Response_Exception
+ */
public function setAuxCode($auxCode) {
$this->auxCode = $auxCode;
return $this;
}
-
+
+ /**
+ * Get the error log id
+ * @return int|null
+ */
public function getId() {
return $this->id;
}
-
+
+ /**
+ * Get the error auxCode
+ * @return string|null
+ */
public function getAuxCode() {
return $this->auxCode;
}
-
+
}
View
1,413 docs/CheddarGetter/CheddarGetter_Client.html
@@ -1,1413 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <!-- template designed by Marco Von Ballmoos -->
- <title>Docs For Class CheddarGetter_Client</title>
- <link rel="stylesheet" href="../media/stylesheet.css" />
- <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
- </head>
- <body>
- <div class="page-body">
-<h2 class="class-name"><img src="../media/images/Class_logo.png"
- alt=" Class"
- title=" Class"
- style="vertical-align: middle"> CheddarGetter_Client</h2>
-
-<a name="sec-description"></a>
-<div class="info-box">
- <div class="info-box-title">Description</div>
- <div class="nav-bar">
- <span class="disabled">Description</span> |
- <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
-
- </div>
- <div class="info-box-body">
- <!-- ========== Info from phpDoc block ========= -->
-<p class="short-description">Client object for interacting with the CheddarGetter service</p>
- <ul class="tags">
- <li><span class="field">author:</span> Marc Guyer &lt;<a href="mailto:marc@cheddargetter.com">marc@cheddargetter.com</a>&gt;</li>
- <li><span class="field">example:</span> <a href="../__examplesource/exsource_argetter_library_CheddarGetter_example_example.php_b47f986942834425d506870489306804.html">example</a></li>
- </ul>
- <p class="notes">
- Located in <a class="field" href="_Client.php.html">/Client.php</a> (line <span class="field">16</span>)
- </p>
-
-
- <pre></pre>
-
- </div>
-</div>
-
-
-
-
- <a name="sec-method-summary"></a>
- <div class="info-box">
- <div class="info-box-title">Method Summary</span></div>
- <div class="nav-bar">
- <a href="#sec-description">Description</a> |
- <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
- </div>
- <div class="info-box-body">
- <div class="method-summary">
- <div class="method-definition">
- <img src="../media/images/StaticMethod.png" alt=" "/>
- static <span class="method-result">void</span>
- <a href="#setMarketingCookie" title="details" class="method-name">setMarketingCookie</a>
- ([<span class="var-type">string</span>&nbsp;<span class="var-name">$cookieName</span> = <span class="var-default">'CGMK'</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$expire</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span> = <span class="var-default">'/'</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$domain</span> = <span class="var-default">null</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$secure</span> = <span class="var-default">false</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$httpOnly</span> = <span class="var-default">false</span>])
- </div>
- <div class="method-definition">
- <img src="../media/images/Constructor.png" alt=" "/>
- <span class="method-result">CheddarGetter_Client</span>
- <a href="#__construct" title="details" class="method-name">__construct</a>
- (<span class="var-type">$url</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">$username</span>&nbsp;<span class="var-name">$username</span>, <span class="var-type">$password</span>&nbsp;<span class="var-name">$password</span>, [<span class="var-type">$productCode</span>&nbsp;<span class="var-name">$productCode</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$productId</span> = <span class="var-default">null</span>])
- </div>
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Response.html">CheddarGetter_Response</a></span>
- <a href="#addCharge" title="details" class="method-name">addCharge</a>
- (<span class="var-type">string</span>&nbsp;<span class="var-name">$code</span>, [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">null</span>], <span class="var-type"></span>&nbsp;<span class="var-name">$data</span>)
- </div>
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Response.html">CheddarGetter_Response</a></span>
- <a href="#addItemQuantity" title="details" class="method-name">addItemQuantity</a>
- (<span class="var-type">string</span>&nbsp;<span class="var-name">$code</span>, [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">null</span>], <span class="var-type"></span>&nbsp;<span class="var-name">$data</span>)
- </div>
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Response.html">CheddarGetter_Response</a></span>
- <a href="#cancelSubscription" title="details" class="method-name">cancelSubscription</a>
- (<span class="var-type">string</span>&nbsp;<span class="var-name">$code</span>, [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">null</span>])
- </div>
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Response.html">CheddarGetter_Response</a></span>
- <a href="#deleteCustomer" title="details" class="method-name">deleteCustomer</a>
- (<span class="var-type">string</span>&nbsp;<span class="var-name">$code</span>, [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">null</span>])
- </div>
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Response.html">CheddarGetter_Response</a></span>
- <a href="#deleteCustomers" title="details" class="method-name">deleteCustomers</a>
- (<span class="var-type">string</span>&nbsp;<span class="var-name">$code</span>, <span class="var-type">string|null</span>&nbsp;<span class="var-name">$id</span>)
- </div>
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Response.html">CheddarGetter_Response</a></span>
- <a href="#deletePlan" title="details" class="method-name">deletePlan</a>
- (<span class="var-type">string</span>&nbsp;<span class="var-name">$code</span>, [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">null</span>])
- </div>
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Response.html">CheddarGetter_Response</a></span>
- <a href="#editCustomer" title="details" class="method-name">editCustomer</a>
- (<span class="var-type">string</span>&nbsp;<span class="var-name">$code</span>, [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">null</span>], <span class="var-type"></span>&nbsp;<span class="var-name">$data</span>)
- </div>
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Response.html">CheddarGetter_Response</a></span>
- <a href="#editCustomerOnly" title="details" class="method-name">editCustomerOnly</a>
- (<span class="var-type">string</span>&nbsp;<span class="var-name">$code</span>, [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">null</span>], <span class="var-type"></span>&nbsp;<span class="var-name">$data</span>)
- </div>
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Response.html">CheddarGetter_Response</a></span>
- <a href="#editSubscription" title="details" class="method-name">editSubscription</a>
- (<span class="var-type">string</span>&nbsp;<span class="var-name">$code</span>, [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">null</span>], <span class="var-type"></span>&nbsp;<span class="var-name">$data</span>)
- </div>
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Response.html">CheddarGetter_Response</a></span>
- <a href="#getAllCustomers" title="details" class="method-name">getAllCustomers</a>
- ([<span class="var-type"></span>&nbsp;<span class="var-name">$filters</span> = <span class="var-default">null</span>])
- </div>
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Response.html">CheddarGetter_Response</a></span>
- <a href="#getCustomer" title="details" class="method-name">getCustomer</a>
- (<span class="var-type">string</span>&nbsp;<span class="var-name">$code</span>, [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">null</span>])
- </div>
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Response.html">CheddarGetter_Response</a></span>
- <a href="#getCustomers" title="details" class="method-name">getCustomers</a>
- ([<span class="var-type"></span>&nbsp;<span class="var-name">$filters</span> = <span class="var-default">null</span>])
- </div>
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result">Zend_Http_Client|resource</span>
- <a href="#getHttpClient" title="details" class="method-name">getHttpClient</a>
- ()
- </div>
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result">string</span>
- <a href="#getMarketingCookieName" title="details" class="method-name">getMarketingCookieName</a>
- ()
- </div>
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Response.html">CheddarGetter_Response</a></span>
- <a href="#getPlan" title="details" class="method-name">getPlan</a>
- (<span class="var-type">string</span>&nbsp;<span class="var-name">$code</span>, [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">null</span>])
- </div>
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Response.html">CheddarGetter_Response</a></span>
- <a href="#getPlans" title="details" class="method-name">getPlans</a>
- ([<span class="var-type"></span>&nbsp;<span class="var-name">$filters</span> = <span class="var-default">null</span>])
- </div>
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result">string</span>
- <a href="#getProductCode" title="details" class="method-name">getProductCode</a>
- ()
- </div>
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result">string</span>
- <a href="#getProductId" title="details" class="method-name">getProductId</a>
- ()
- </div>
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result">string</span>
- <a href="#getUrl" title="details" class="method-name">getUrl</a>
- ()
- </div>
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result">string</span>
- <a href="#getUsername" title="details" class="method-name">getUsername</a>
- ()
- </div>
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Response.html">CheddarGetter_Response</a></span>
- <a href="#newCustomer" title="details" class="method-name">newCustomer</a>
- (<span class="var-type"></span>&nbsp;<span class="var-name">$data</span>)
- </div>
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Response.html">CheddarGetter_Response</a></span>
- <a href="#removeItemQuantity" title="details" class="method-name">removeItemQuantity</a>
- (<span class="var-type">string</span>&nbsp;<span class="var-name">$code</span>, [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">null</span>], <span class="var-type"></span>&nbsp;<span class="var-name">$data</span>)
- </div>
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result">string</span>
- <a href="#request" title="details" class="method-name">request</a>
- (<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$args</span> = <span class="var-default">null</span>])
- </div>
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Client.html">CheddarGetter_Client</a></span>
- <a href="#setHttpClient" title="details" class="method-name">setHttpClient</a>
- (<span class="var-type">$client</span>&nbsp;<span class="var-name">$client</span>)
- </div>
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Response.html">CheddarGetter_Response</a></span>
- <a href="#setItemQuantity" title="details" class="method-name">setItemQuantity</a>
- (<span class="var-type">string</span>&nbsp;<span class="var-name">$code</span>, [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">null</span>], <span class="var-type"></span>&nbsp;<span class="var-name">$data</span>)
- </div>
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Client.html">CheddarGetter_Client</a></span>
- <a href="#setMarketingCookieName" title="details" class="method-name">setMarketingCookieName</a>
- (<span class="var-type">$name</span>&nbsp;<span class="var-name">$name</span>)
- </div>
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Client.html">CheddarGetter_Client</a></span>
- <a href="#setPassword" title="details" class="method-name">setPassword</a>
- (<span class="var-type">$password</span>&nbsp;<span class="var-name">$password</span>)
- </div>
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Client.html">CheddarGetter_Client</a></span>
- <a href="#setProductCode" title="details" class="method-name">setProductCode</a>
- (<span class="var-type">$productCode</span>&nbsp;<span class="var-name">$productCode</span>)
- </div>
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Client.html">CheddarGetter_Client</a></span>
- <a href="#setProductId" title="details" class="method-name">setProductId</a>
- (<span class="var-type">$productId</span>&nbsp;<span class="var-name">$productId</span>)
- </div>
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Client.html">CheddarGetter_Client</a></span>
- <a href="#setUrl" title="details" class="method-name">setUrl</a>
- (<span class="var-type">$url</span>&nbsp;<span class="var-name">$url</span>)
- </div>
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Client.html">CheddarGetter_Client</a></span>
- <a href="#setUsername" title="details" class="method-name">setUsername</a>
- (<span class="var-type">$username</span>&nbsp;<span class="var-name">$username</span>)
- </div>
- <div class="method-definition">
- <img src="../media/images/Method.png" alt=" "/>
- <span class="method-result">void</span>
- <a href="#__call" title="details" class="method-name">__call</a>
- (<span class="var-type">string</span>&nbsp;<span class="var-name">$method</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$args</span>)
- </div>
- </div>
- </div>
- </div>
-
-
- <a name="sec-methods"></a>
- <div class="info-box">
- <div class="info-box-title">Methods</div>
- <div class="nav-bar">
- <a href="#sec-description">Description</a> |
- <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
-
- </div>
- <div class="info-box-body">
- <A NAME='method_detail'></A>
-<a name="methodsetMarketingCookie" id="setMarketingCookie"><!-- --></a>
-<div class="evenrow">
-
- <div class="method-header">
- <img src="../media/images/StaticMethod.png" />
- <span class="method-title">static setMarketingCookie</span> (line <span class="line-number">739</span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-<p class="short-description">Convenience wrapper of setcookie() for setting a persistent cookie containing marketing metrics compatible with CheddarGetter's marketing metrics tracking.</p>
-<p class="description"><p>Running this method on every request to your marketing site sets or refines the marketing cookie data over time. There is no performance disadvantage to running this method on every request.</p><p>If a lead has this cookie set at the time of signup, CheddarGetter_Client::newCustomer() will automatically add the data to the customer record. In other words, simply run this method on every request and there's nothing else to do to take advantage of the metrics tracking in CheddarGetter.</p><p><a href="http://support.cheddargetter.com/faqs/marketing-metrics/marketing-metrics">More about CheddarGetter's marketing metrics tracking</a></p></p>
- <ul class="tags">
- <li><span class="field">see:</span> <a href="../CheddarGetter/CheddarGetter_Client.html#methodnewCustomer">CheddarGetter_Client::newCustomer()</a></li>
- <li><span class="field">throws:</span> CheddarGetter_Client_Exception if headers are already sent</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">void</span>
- <span class="method-name">
- setMarketingCookie
- </span>
- ([<span class="var-type">string</span>&nbsp;<span class="var-name">$cookieName</span> = <span class="var-default">'CGMK'</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$expire</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span> = <span class="var-default">'/'</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$domain</span> = <span class="var-default">null</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$secure</span> = <span class="var-default">false</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$httpOnly</span> = <span class="var-default">false</span>])
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$cookieName</span> </li>
- <li>
- <span class="var-type">int</span>
- <span class="var-name">$expire</span> </li>
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$path</span> </li>
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$domain</span> </li>
- <li>
- <span class="var-type">bool</span>
- <span class="var-name">$secure</span> </li>
- <li>
- <span class="var-type">bool</span>
- <span class="var-name">$httpOnly</span> </li>
- </ul>
-
-
- </div>
-<a name="method__construct" id="__construct"><!-- --></a>
-<div class="oddrow">
-
- <div class="method-header">
- <img src="../media/images/Constructor.png" />
- <span class="method-title">Constructor __construct</span> (line <span class="line-number">64</span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-<p class="short-description">Constructor</p>
- <ul class="tags">
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">CheddarGetter_Client</span>
- <span class="method-name">
- __construct
- </span>
- (<span class="var-type">$url</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">$username</span>&nbsp;<span class="var-name">$username</span>, <span class="var-type">$password</span>&nbsp;<span class="var-name">$password</span>, [<span class="var-type">$productCode</span>&nbsp;<span class="var-name">$productCode</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$productId</span> = <span class="var-default">null</span>])
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">$url</span>
- <span class="var-name">$url</span><span class="var-description">: string</span> </li>
- <li>
- <span class="var-type">$username</span>
- <span class="var-name">$username</span><span class="var-description">: string</span> </li>
- <li>
- <span class="var-type">$password</span>
- <span class="var-name">$password</span><span class="var-description">: string</span> </li>
- <li>
- <span class="var-type">$productCode</span>
- <span class="var-name">$productCode</span><span class="var-description">: string</span> </li>
- <li>
- <span class="var-type"></span>
- <span class="var-name">$productId</span> </li>
- </ul>
-
-
- </div>
-<a name="methodaddCharge" id="addCharge"><!-- --></a>
-<div class="evenrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">addCharge</span> (line <span class="line-number">581</span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-<p class="short-description">Add a custom charge (debit) or credit to the current invoice</p>
-<p class="description"><p>A positive 'eachAmount' will result in a debit. If negative, a credit.</p></p>
- <ul class="tags">
- <li><span class="field">link:</span> <a href="https://cheddargetter.com/developers#add-charge">https://cheddargetter.com/developers#add-charge</a></li>
- <li><span class="field">throws:</span> CheddarGetter_Response_Exception</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Response.html">CheddarGetter_Response</a></span>
- <span class="method-name">
- addCharge
- </span>
- (<span class="var-type">string</span>&nbsp;<span class="var-name">$code</span>, [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">null</span>], <span class="var-type"></span>&nbsp;<span class="var-name">$data</span>)
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$code</span><span class="var-description">: Your code for the customer</span> </li>
- <li>
- <span class="var-type">string|null</span>
- <span class="var-name">$id</span><span class="var-description">: CG id for the customer</span> </li>
- <li>
- <span class="var-type">array</span>
- <span class="var-name">$data</span><span class="var-description">: chargeCode, quantity, eachAmount[, description] <a href="https://cheddargetter.com/developers#add-charge">https://cheddargetter.com/developers#add-charge</a></span> </li>
- </ul>
-
-
- </div>
-<a name="methodaddItemQuantity" id="addItemQuantity"><!-- --></a>
-<div class="oddrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">addItemQuantity</span> (line <span class="line-number">519</span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-<p class="short-description">Increment a usage item quantity</p>
- <ul class="tags">
- <li><span class="field">link:</span> <a href="https://cheddargetter.com/developers#add-item-quantity">https://cheddargetter.com/developers#add-item-quantity</a></li>
- <li><span class="field">throws:</span> CheddarGetter_Response_Exception</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Response.html">CheddarGetter_Response</a></span>
- <span class="method-name">
- addItemQuantity
- </span>
- (<span class="var-type">string</span>&nbsp;<span class="var-name">$code</span>, [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">null</span>], <span class="var-type"></span>&nbsp;<span class="var-name">$data</span>)
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$code</span><span class="var-description">: Your code for the customer</span> </li>
- <li>
- <span class="var-type">string|null</span>
- <span class="var-name">$id</span><span class="var-description">: CG id for the customer</span> </li>
- <li>
- <span class="var-type">array</span>
- <span class="var-name">$data</span><span class="var-description">: Your (itemCode or CG itemId) and [quantity] <a href="https://cheddargetter.com/developers#add-item-quantity">https://cheddargetter.com/developers#add-item-quantity</a></span> </li>
- </ul>
-
-
- </div>
-<a name="methodcancelSubscription" id="cancelSubscription"><!-- --></a>
-<div class="evenrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">cancelSubscription</span> (line <span class="line-number">500</span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-<p class="short-description">Cancel subscription</p>
- <ul class="tags">
- <li><span class="field">link:</span> <a href="https://cheddargetter.com/developers#cancel-subscription">https://cheddargetter.com/developers#cancel-subscription</a></li>
- <li><span class="field">throws:</span> CheddarGetter_Response_Exception</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Response.html">CheddarGetter_Response</a></span>
- <span class="method-name">
- cancelSubscription
- </span>
- (<span class="var-type">string</span>&nbsp;<span class="var-name">$code</span>, [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">null</span>])
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$code</span><span class="var-description">: Your code for the customer</span> </li>
- <li>
- <span class="var-type">string|null</span>
- <span class="var-name">$id</span><span class="var-description">: CG id for the customer</span> </li>
- </ul>
-
-
- </div>
-<a name="methoddeleteCustomer" id="deleteCustomer"><!-- --></a>
-<div class="oddrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">deleteCustomer</span> (line <span class="line-number">441</span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-<p class="short-description">Delete a customer</p>
- <ul class="tags">
- <li><span class="field">link:</span> <a href="https://cheddargetter.com/developers#delete-customer">https://cheddargetter.com/developers#delete-customer</a></li>
- <li><span class="field">throws:</span> CheddarGetter_Response_Exception</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Response.html">CheddarGetter_Response</a></span>
- <span class="method-name">
- deleteCustomer
- </span>
- (<span class="var-type">string</span>&nbsp;<span class="var-name">$code</span>, [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">null</span>])
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$code</span><span class="var-description">: Your code for the customer</span> </li>
- <li>
- <span class="var-type">string|null</span>
- <span class="var-name">$id</span><span class="var-description">: CG id for the customer</span> </li>
- </ul>
-
-
- </div>
-<a name="methoddeleteCustomers" id="deleteCustomers"><!-- --></a>
-<div class="evenrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">deleteCustomers</span> (line <span class="line-number">463</span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-<p class="short-description">Delete all customers</p>
-<p class="description"><p>WARNING: This will delete all customers and all related data in CheddarGetter and will delete all customer data at the gateway if a gateway is configured.</p></p>
- <ul class="tags">
- <li><span class="field">link:</span> <a href="https://cheddargetter.com/developers#delete-all-customers">https://cheddargetter.com/developers#delete-all-customers</a></li>
- <li><span class="field">throws:</span> CheddarGetter_Response_Exception</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Response.html">CheddarGetter_Response</a></span>
- <span class="method-name">
- deleteCustomers
- </span>
- (<span class="var-type">string</span>&nbsp;<span class="var-name">$code</span>, <span class="var-type">string|null</span>&nbsp;<span class="var-name">$id</span>)
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$code</span><span class="var-description">: Your code for the customer</span> </li>
- <li>
- <span class="var-type">string|null</span>
- <span class="var-name">$id</span><span class="var-description">: CG id for the customer</span> </li>
- </ul>
-
-
- </div>
-<a name="methoddeletePlan" id="deletePlan"><!-- --></a>
-<div class="oddrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">deletePlan</span> (line <span class="line-number">298</span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-<p class="short-description">Delete a plan</p>
- <ul class="tags">
- <li><span class="field">throws:</span> CheddarGetter_Response_Exception</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Response.html">CheddarGetter_Response</a></span>
- <span class="method-name">
- deletePlan
- </span>
- (<span class="var-type">string</span>&nbsp;<span class="var-name">$code</span>, [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">null</span>])
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$code</span><span class="var-description">: Your code for the plan</span> </li>
- <li>
- <span class="var-type">string|null</span>
- <span class="var-name">$id</span><span class="var-description">: CG id for the plan</span> </li>
- </ul>
-
-
- </div>
-<a name="methodeditCustomer" id="editCustomer"><!-- --></a>
-<div class="evenrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">editCustomer</span> (line <span class="line-number">402</span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-<p class="short-description">Change customer and subscription information</p>
- <ul class="tags">
- <li><span class="field">link:</span> <a href="https://cheddargetter.com/developers#update-customer-subscription">https://cheddargetter.com/developers#update-customer-subscription</a></li>
- <li><span class="field">throws:</span> CheddarGetter_Response_Exception</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Response.html">CheddarGetter_Response</a></span>
- <span class="method-name">
- editCustomer
- </span>
- (<span class="var-type">string</span>&nbsp;<span class="var-name">$code</span>, [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">null</span>], <span class="var-type"></span>&nbsp;<span class="var-name">$data</span>)
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$code</span><span class="var-description">: Your code for the customer</span> </li>
- <li>
- <span class="var-type">string|null</span>
- <span class="var-name">$id</span><span class="var-description">: CG id for the customer</span> </li>
- <li>
- <span class="var-type">array|null</span>
- <span class="var-name">$data</span><span class="var-description">: <a href="https://cheddargetter.com/developers#update-customer-subscription">https://cheddargetter.com/developers#update-customer-subscription</a></span> </li>
- </ul>
-
-
- </div>
-<a name="methodeditCustomerOnly" id="editCustomerOnly"><!-- --></a>
-<div class="oddrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">editCustomerOnly</span> (line <span class="line-number">422</span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-<p class="short-description">Change customer information only</p>
- <ul class="tags">
- <li><span class="field">link:</span> <a href="https://cheddargetter.com/developers#update-customer">https://cheddargetter.com/developers#update-customer</a></li>
- <li><span class="field">throws:</span> CheddarGetter_Response_Exception</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Response.html">CheddarGetter_Response</a></span>
- <span class="method-name">
- editCustomerOnly
- </span>
- (<span class="var-type">string</span>&nbsp;<span class="var-name">$code</span>, [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">null</span>], <span class="var-type"></span>&nbsp;<span class="var-name">$data</span>)
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$code</span><span class="var-description">: Your code for the customer</span> </li>
- <li>
- <span class="var-type">string|null</span>
- <span class="var-name">$id</span><span class="var-description">: CG id for the customer</span> </li>
- <li>
- <span class="var-type">array|null</span>
- <span class="var-name">$data</span><span class="var-description">: <a href="https://cheddargetter.com/developers#update-customer">https://cheddargetter.com/developers#update-customer</a></span> </li>
- </ul>
-
-
- </div>
-<a name="methodeditSubscription" id="editSubscription"><!-- --></a>
-<div class="evenrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">editSubscription</span> (line <span class="line-number">481</span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-<p class="short-description">Change subscription information</p>
- <ul class="tags">
- <li><span class="field">link:</span> <a href="https://cheddargetter.com/developers#update-subscription">https://cheddargetter.com/developers#update-subscription</a></li>
- <li><span class="field">throws:</span> CheddarGetter_Response_Exception</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Response.html">CheddarGetter_Response</a></span>
- <span class="method-name">
- editSubscription
- </span>
- (<span class="var-type">string</span>&nbsp;<span class="var-name">$code</span>, [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">null</span>], <span class="var-type"></span>&nbsp;<span class="var-name">$data</span>)
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$code</span><span class="var-description">: Your code for the customer</span> </li>
- <li>
- <span class="var-type">string|null</span>
- <span class="var-name">$id</span><span class="var-description">: CG id for the customer</span> </li>
- <li>
- <span class="var-type">array|null</span>
- <span class="var-name">$data</span><span class="var-description">: <a href="https://cheddargetter.com/developers#update-subscription">https://cheddargetter.com/developers#update-subscription</a></span> </li>
- </ul>
-
-
- </div>
-<a name="methodgetAllCustomers" id="getAllCustomers"><!-- --></a>
-<div class="oddrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">getAllCustomers</span> (line <span class="line-number">347</span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-<p class="short-description">Get all customers</p>
-<p class="description"><p>Get all customers subscribed to any product</p></p>
- <ul class="tags">
- <li><span class="field">throws:</span> CheddarGetter_Response_Exception</li>
- <li><span class="field">throws:</span> CheddarGetter_Client_Exception</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Response.html">CheddarGetter_Response</a></span>
- <span class="method-name">
- getAllCustomers
- </span>
- ([<span class="var-type"></span>&nbsp;<span class="var-name">$filters</span> = <span class="var-default">null</span>])
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">array|null</span>
- <span class="var-name">$filters</span> </li>
- </ul>
-
-
- </div>
-<a name="methodgetCustomer" id="getCustomer"><!-- --></a>
-<div class="evenrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">getCustomer</span> (line <span class="line-number">330</span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-<p class="short-description">Get a single customer</p>
- <ul class="tags">
- <li><span class="field">link:</span> <a href="https://cheddargetter.com/developers#single-customer">https://cheddargetter.com/developers#single-customer</a></li>
- <li><span class="field">throws:</span> CheddarGetter_Response_Exception</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Response.html">CheddarGetter_Response</a></span>
- <span class="method-name">
- getCustomer
- </span>
- (<span class="var-type">string</span>&nbsp;<span class="var-name">$code</span>, [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">null</span>])
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$code</span><span class="var-description">: Your code for the customer</span> </li>
- <li>
- <span class="var-type">string|null</span>
- <span class="var-name">$id</span><span class="var-description">: CG id for the customer</span> </li>
- </ul>
-
-
- </div>
-<a name="methodgetCustomers" id="getCustomers"><!-- --></a>
-<div class="oddrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">getCustomers</span> (line <span class="line-number">317</span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-<p class="short-description">Get customers</p>
-<p class="description"><p>Get all customers in the product</p></p>
- <ul class="tags">
- <li><span class="field">link:</span> <a href="https://cheddargetter.com/developers#all-customers">https://cheddargetter.com/developers#all-customers</a></li>
- <li><span class="field">throws:</span> CheddarGetter_Response_Exception</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Response.html">CheddarGetter_Response</a></span>
- <span class="method-name">
- getCustomers
- </span>
- ([<span class="var-type"></span>&nbsp;<span class="var-name">$filters</span> = <span class="var-default">null</span>])
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">array|null</span>
- <span class="var-name">$filters</span><span class="var-description">: <a href="https://cheddargetter.com/developers#all-customers">https://cheddargetter.com/developers#all-customers</a></span> </li>
- </ul>
-
-
- </div>
-<a name="methodgetHttpClient" id="getHttpClient"><!-- --></a>
-<div class="evenrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">getHttpClient</span> (line <span class="line-number">702</span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-<p class="short-description">Get the current http client</p>
- <ul class="tags">
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">Zend_Http_Client|resource</span>
- <span class="method-name">
- getHttpClient
- </span>
- ()
- </div>
-
-
-
- </div>
-<a name="methodgetMarketingCookieName" id="getMarketingCookieName"><!-- --></a>
-<div class="oddrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">getMarketingCookieName</span> (line <span class="line-number">192</span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-<p class="short-description">Get marketing cookie name</p>
- <ul class="tags">
- <li><span class="field">see:</span> <a href="../CheddarGetter/CheddarGetter_Client.html#methodsetMarketingCookie">CheddarGetter_Client::setMarketingCookie()</a></li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">string</span>
- <span class="method-name">
- getMarketingCookieName
- </span>
- ()
- </div>
-
-
-
- </div>
-<a name="methodgetPlan" id="getPlan"><!-- --></a>
-<div class="evenrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">getPlan</span> (line <span class="line-number">247</span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-<p class="short-description">Get a single pricing plan</p>
- <ul class="tags">
- <li><span class="field">link:</span> <a href="https://cheddargetter.com/developers#single-plan">https://cheddargetter.com/developers#single-plan</a></li>
- <li><span class="field">throws:</span> CheddarGetter_Response_Exception</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Response.html">CheddarGetter_Response</a></span>
- <span class="method-name">
- getPlan
- </span>
- (<span class="var-type">string</span>&nbsp;<span class="var-name">$code</span>, [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">null</span>])
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$code</span><span class="var-description">: Your code for the plan</span> </li>
- <li>
- <span class="var-type">string|null</span>
- <span class="var-name">$id</span><span class="var-description">: CG id for the plan</span> </li>
- </ul>
-
-
- </div>
-<a name="methodgetPlans" id="getPlans"><!-- --></a>
-<div class="oddrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">getPlans</span> (line <span class="line-number">234</span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-<p class="short-description">Get pricing plans</p>
-<p class="description"><p>Get all plans in the product.</p></p>
- <ul class="tags">
- <li><span class="field">link:</span> <a href="https://cheddargetter.com/developers#all-plans">https://cheddargetter.com/developers#all-plans</a></li>
- <li><span class="field">throws:</span> CheddarGetter_Response_Exception</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Response.html">CheddarGetter_Response</a></span>
- <span class="method-name">
- getPlans
- </span>
- ([<span class="var-type"></span>&nbsp;<span class="var-name">$filters</span> = <span class="var-default">null</span>])
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">array|null</span>
- <span class="var-name">$filters</span> </li>
- </ul>
-
-
- </div>
-<a name="methodgetProductCode" id="getProductCode"><!-- --></a>
-<div class="evenrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">getProductCode</span> (line <span class="line-number">150</span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-<p class="short-description">Get current product code</p>
- <ul class="tags">
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">string</span>
- <span class="method-name">
- getProductCode
- </span>
- ()
- </div>
-
-
-
- </div>
-<a name="methodgetProductId" id="getProductId"><!-- --></a>
-<div class="oddrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">getProductId</span> (line <span class="line-number">170</span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-<p class="short-description">Get current product id</p>
- <ul class="tags">
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">string</span>
- <span class="method-name">
- getProductId
- </span>
- ()
- </div>
-
-
-
- </div>
-<a name="methodgetUrl" id="getUrl"><!-- --></a>
-<div class="evenrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">getUrl</span> (line <span class="line-number">90</span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-<p class="short-description">Get URL</p>
- <ul class="tags">
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">string</span>
- <span class="method-name">
- getUrl
- </span>
- ()
- </div>
-
-
-
- </div>
-<a name="methodgetUsername" id="getUsername"><!-- --></a>
-<div class="oddrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">getUsername</span> (line <span class="line-number">110</span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-<p class="short-description">Get username</p>
- <ul class="tags">
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result">string</span>
- <span class="method-name">
- getUsername
- </span>
- ()
- </div>
-
-
-
- </div>
-<a name="methodnewCustomer" id="newCustomer"><!-- --></a>
-<div class="evenrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">newCustomer</span> (line <span class="line-number">367</span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-<p class="short-description">Create new customer</p>
- <ul class="tags">
- <li><span class="field">see:</span> <a href="../CheddarGetter/CheddarGetter_Client.html#methodsetMarketingCookie">CheddarGetter_Client::setMarketingCookie()</a></li>
- <li><span class="field">link:</span> <a href="https://cheddargetter.com/developers#add-customer">https://cheddargetter.com/developers#add-customer</a></li>
- <li><span class="field">throws:</span> CheddarGetter_Response_Exception</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Response.html">CheddarGetter_Response</a></span>
- <span class="method-name">
- newCustomer
- </span>
- (<span class="var-type"></span>&nbsp;<span class="var-name">$data</span>)
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">array|null</span>
- <span class="var-name">$data</span><span class="var-description">: <a href="https://cheddargetter.com/developers#add-customer">https://cheddargetter.com/developers#add-customer</a></span> </li>
- </ul>
-
-
- </div>
-<a name="methodremoveItemQuantity" id="removeItemQuantity"><!-- --></a>
-<div class="oddrow">
-
- <div class="method-header">
- <img src="../media/images/Method.png" />
- <span class="method-title">removeItemQuantity</span> (line <span class="line-number">539</span>)
- </div>
-
- <!-- ========== Info from phpDoc block ========= -->
-<p class="short-description">Decrement a usage item quantity</p>
- <ul class="tags">
- <li><span class="field">link:</span> <a href="https://cheddargetter.com/developers#remove-item-quantity">https://cheddargetter.com/developers#remove-item-quantity</a></li>
- <li><span class="field">throws:</span> CheddarGetter_Response_Exception</li>
- <li><span class="field">access:</span> public</li>
- </ul>
-
- <div class="method-signature">
- <span class="method-result"><a href="../CheddarGetter/CheddarGetter_Response.html">CheddarGetter_Response</a></span>
- <span class="method-name">
- removeItemQuantity
- </span>
- (<span class="var-type">string</span>&nbsp;<span class="var-name">$code</span>, [<span class="var-type">string|null</span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">null</span>], <span class="var-type"></span>&nbsp;<span class="var-name">$data</span>)
- </div>
-
- <ul class="parameters">
- <li>
- <span class="var-type">string</span>
- <span class="var-name">$code</span><span class="var-description">: Your code for the customer</span> </li>
- <li>
- <span class="var-type">string|null</span>
- <span class="var-name">$id</span><span class="var-description">: CG id for the customer</span> </li>
- <li>
- <span class="var-type">array</span>