1 <?php
  2 
  3 namespace rpf\api\module;
  4 use rpf\api\apiModule;
  5 
  6 /**
  7  * Implementation of bbDomain::readEntry
  8  * (No public api-documentation available)
  9  *
 10  * @package system\module
 11  */
 12 class bbDomain_readEntry extends apiModule
 13 {
 14     protected $rpcMethod = 'bbDomain::readEntry';
 15 
 16     /**
 17      * Set filter on domain-id
 18      *
 19      * @param int $dn
 20      * @return $this
 21      */
 22     public function setDomainId($dn)
 23     {
 24         return $this->addParam('dn', (integer) $dn);
 25     }
 26 
 27     /**
 28      * Set filter on oeid
 29      * (hidden background-order-id, not order-nr)
 30      *
 31      * @param int $oeid
 32      * @return $this
 33      */
 34     public function setOeid($oeid)
 35     {
 36         return $this->addParam('oeid', (integer) $oeid);
 37     }
 38 
 39     /**
 40      * Set filter on seid
 41      * (???)
 42      *
 43      * @param $seid
 44      * @return $this
 45      * @todo documentation
 46      */
 47     public function setSeid($seid)
 48     {
 49         return $this->addParam('seid', (integer) $seid);
 50     }
 51 
 52     /**
 53      * Add Subdomain-infos to result
 54      *
 55      * @param bool $bool
 56      * @return $this
 57      */
 58     public function addSubdomain($bool = true)
 59     {
 60         return $this->addParam('return_subdomain', (bool) $bool);
 61     }
 62 
 63     /**
 64      * Add Frontpage-Extensions to result
 65      * (has anybody ever used this feature?! Send me an email :D )
 66      *
 67      * @param bool $bool
 68      * @return $this
 69      */
 70     public function addFrontpage($bool = true)
 71     {
 72         return $this->addParam('return_frontpage', (bool) $bool);
 73     }
 74 
 75     /**
 76      * @param bool $bool
 77      * @return $this
 78      * @todo documentation
 79      */
 80     public function addMajor($bool = true)
 81     {
 82         return $this->addParam('return_major', (bool) $bool);
 83     }
 84 
 85     /**
 86      * Add domain-settings to result
 87      * (e. g. php-version)
 88      *
 89      * @param bool $bool
 90      * @return $this
 91      */
 92     public function addSettings($bool = true)
 93     {
 94         return $this->addParam('return_settings', (bool) $bool);
 95     }
 96 
 97     /**
 98      * Add domain-handles to result
 99      * (owner, admin-c, tech-c, zone-c)
100      *
101      * @param bool $bool
102      * @return $this
103      */
104     public function addHandles($bool = true)
105     {
106         return $this->addParam('return_handles', (bool) $bool);
107     }
108 
109     /**
110      * @param bool $bool
111      * @return $this
112      * @todo documentation
113      */
114     public function addStaid($bool = true)
115     {
116         return $this->addParam('return_staid', (bool) $bool);
117     }
118 
119     /**
120      * Add dns-records to result
121      *
122      * @param bool $bool
123      * @return $this
124      */
125     public function addNameserver($bool = true)
126     {
127         return $this->addParam('return_nameserver', (bool) $bool);
128     }
129 
130     /**
131      * Add spf-dns-records to result
132      * (???)
133      *
134      * @param bool $bool
135      * @return $this
136      * @todo documentation
137      */
138     public function addSpf($bool = true)
139     {
140         return $this->addParam('return_spf', (bool) $bool);
141     }
142 
143     /**
144      * @param bool $bool
145      * @return $this
146      */
147     public function addWebalizerSettings($bool = true)
148     {
149         return $this->addParam('return_webalizersettings', (bool) $bool);
150     }
151 
152     /**
153      * @param bool $bool
154      * @return $this
155      */
156     public function addPhpini($bool = true)
157     {
158         return $this->addParam('return_phpini', (bool) $bool);
159     }
160 
161     /**
162      * @param bool $bool
163      * @return $this
164      */
165     public function addResellerFields($bool = true)
166     {
167         return $this->addParam('return_reseller_fields', (bool) $bool);
168     }
169 
170     /**
171      * @param bool $bool
172      * @return $this
173      */
174     public function addRpc($bool = true)
175     {
176         return $this->addParam('return_rpc', (bool) $bool);
177     }
178 
179     /**
180      * @param bool $bool
181      * @return $this
182      */
183     public function addLimits($bool = true)
184     {
185         return $this->addParam('return_limits', (bool) $bool);
186     }
187 }

API documentation generated by ApiGen