1 <?php
  2 
  3 namespace rpf\api\module;
  4 use rpf\api\apiModule;
  5 
  6 /**
  7  * Implementation of bbCustomer::readEntry
  8  *
  9  * @package system\module
 10  */
 11 class bbCustomer_readEntry extends apiModule
 12 {
 13     protected $rpcMethod = 'bbCustomer::readEntry';
 14 
 15     /**
 16      * Set filter on ctid (customerId)
 17      *
 18      * @param $ceid
 19      * @return $this
 20      */
 21     public function setCeid($ceid)
 22     {
 23         return $this->addParam('ceid', (integer) $ceid);
 24     }
 25 
 26     /**
 27      * Set filter on customer-id
 28      * (alias for $this setCeid())
 29      *
 30      * @param $ceid
 31      * @return $this
 32      */
 33     public function setCustomerId($ceid)
 34     {
 35         return $this->setCeid($ceid);
 36     }
 37 
 38     /**
 39      * Set filter on uid (User-iD)
 40      *
 41      * @param $uid
 42      * @return $this
 43      */
 44     public function setUid($uid)
 45     {
 46         return $this->addParam('uid', $uid);
 47     }
 48 
 49     /**
 50      * Set filter on user-id
 51      * (alias for $this setUid())
 52      *
 53      * @param $uid
 54      * @return $this
 55      */
 56     public function setUserId($uid)
 57     {
 58         return $this->setUid($uid);
 59     }
 60 
 61     /**
 62      * Set filter on newsletter
 63      *
 64      * @param $newsletter
 65      * @return $this
 66      */
 67     public function setNewsletter($newsletter = true)
 68     {
 69         return $this->addParam('newsletter',(bool) $newsletter);
 70     }
 71 
 72     /**
 73      * Return address
 74      *
 75      * @param $bool
 76      * @return $this
 77      * @link https://github.com/ADoebeling/RP2-Framework/issues/31
 78      */
 79     public function addReturnAddress($bool = true)
 80     {
 81         //Misspelling!
 82         return $this->addParam('return_adress', (bool) $bool);
 83     }
 84 
 85     /**
 86      * Return adress-country
 87      *
 88      * @param $bool
 89      * @return $this
 90      */
 91     public function addReturnAddressCountry($bool= true)
 92     {
 93         $this->addParam('return_adress', (bool) $bool);
 94         return $this->addParam('return_adress_country', (bool) $bool);
 95     }
 96 
 97     /**
 98      * Return orders
 99      *
100      * @param $bool
101      * @return $this
102      */
103     public function addReturnOrders($bool = true)
104     {
105         return $this->addParam('return_orders', (bool) $bool);
106     }
107 
108     /**
109      * Return account_entrys -> Rechnungen des Kunden
110      * need return_orders
111      *
112      * @param $bool
113      * @return $this
114      * @link https://github.com/ADoebeling/RP2-Framework/issues/32
115      */
116     public function addReturnAccountEntries($bool = true)
117     {
118         $this->addParam('return_orders', (bool) $bool);
119         return $this->addParam('return_account_entrys', (bool) $bool);
120     }
121 
122     /**
123      * Return settlements -> Buchungen
124      *
125      * @param $bool
126      * @return $this
127      */
128     public function addReturnSettlements($bool = true)
129     {
130         $this->addParam('return_account_entrys', (bool) $bool);
131         return $this->addParam('return_account_entrys', (bool) $bool);
132     }
133 
134     /**
135      * Return limits
136      *
137      * @param $bool
138      * @return $this
139      */
140     public function addReturnLimits($bool = true)
141     {
142         $this->addParam('return_orders', (bool) $bool);
143         return $this->addParam('return_limits', (bool) $bool);
144     }
145 
146     /**
147      * Return tariff
148      *
149      * @param $bool
150      * @return $this
151      */
152     public function addReturnTariff($bool = true)
153     {
154         $this->addParam('return_orders', (bool) $bool);
155         return $this->addParam('return_tariff', (bool) $bool);
156     }
157 
158     /**
159      * Return user
160      *
161      * @param $bool
162      * @return $this
163      */
164     public function addReturnUser($bool = true)
165     {
166         return $this->addParam('return_user', (bool) $bool);
167     }
168 
169     /**
170      * Return policy
171      *
172      * @param $bool
173      * @return $this
174      */
175     public function addReturnPolicy($bool = true)
176     {
177         $this->addParam('return_user', (bool) $bool);
178         return $this->addParam('return_policy', (bool) $bool);
179     }
180 
181     /**
182      * Return handles
183      *
184      * @param $bool
185      * @return $this
186      */
187     public function addReturnHandles($bool = true)
188     {
189         return $this->addParam('return_handles', (bool) $bool);
190     }
191 
192     /**
193      * Return staid
194      *
195      * @param $bool
196      * @return $this
197      */
198     public function addReturnStaid($bool = true)
199     {
200         return $this->addParam('return_staid', (bool) $bool);
201     }
202 
203     /**
204      * Return overview
205      *
206      * @param $bool
207      * @return $this
208      */
209     public function addReturnOverview($bool = true)
210     {
211         return $this->addParam('return_overview', (bool) $bool);
212     }
213 
214     /**
215      * Return pay-info
216      *
217      * @param $bool
218      * @return $this
219      */
220     public function addReturnPayInfo($bool = true)
221     {
222         return $this->addParam('return_payinfo', (bool) $bool);
223     }
224 
225     /**
226      * Return pay-info_bank
227      *
228      * @param $bool
229      * @return $this
230      */
231     public function addReturnPayInfoBank($bool = true)
232     {
233         $this->addParam('return_payinfo', (bool) $bool);
234         return $this->addParam('return_payinfo_bank', (bool) $bool);
235     }
236 
237     /**
238      * Return payment
239      *
240      * @param $bool
241      * @return $this
242      */
243     public function addReturnPayment($bool = true)
244     {
245         $this->addParam('return_payinfo', (bool) $bool);
246         return $this->addParam('return_payment', (bool) $bool);
247     }
248 
249     /**
250      * Return phone_encodet
251      *
252      * @param $bool
253      * @return $this
254      */
255     public function addReturnPhoneEncodet($bool = true)
256     {
257         $this->addParam('return_adress', (bool) $bool);
258         return $this->addParam('return_phone_encodet', (bool) $bool);
259     }
260 }

API documentation generated by ApiGen