summaryrefslogtreecommitdiffstats
path: root/lib/api/kolab_api_service_domains.php
diff options
context:
space:
mode:
authorAleksander Machniak <alec@alec.pl>2012-03-26 09:22:50 +0200
committerAleksander Machniak <alec@alec.pl>2012-03-26 09:22:50 +0200
commit0b8849e31162e07bdc5dbfef9ea95b3cf3d5c9b8 (patch)
tree32105cbca3f46f88a3e843f5aa012c4b297e89c7 /lib/api/kolab_api_service_domains.php
parent079b73cd67fbb7d103fe1e4ba2ffdb97b1a6f390 (diff)
downloadwebadmin-0b8849e31162e07bdc5dbfef9ea95b3cf3d5c9b8.tar.gz
Added more phpdoc comments
Diffstat (limited to 'lib/api/kolab_api_service_domains.php')
-rw-r--r--lib/api/kolab_api_service_domains.php22
1 files changed, 19 insertions, 3 deletions
diff --git a/lib/api/kolab_api_service_domains.php b/lib/api/kolab_api_service_domains.php
index e32aeb7..e964936 100644
--- a/lib/api/kolab_api_service_domains.php
+++ b/lib/api/kolab_api_service_domains.php
@@ -24,19 +24,35 @@
*/
/**
- *
+ * Service providing domains listing
*/
class kolab_api_service_domains extends kolab_api_service
{
+
+ /**
+ * Returns service capabilities.
+ *
+ * @param string $domain Domain name
+ *
+ * @return array Capabilities list
+ */
public function capabilities($domain)
{
return array(
'list' => 'r',
-// 'search' => 'r',
);
}
- public function domains_list($get, $post) {
+ /**
+ * Users listing (with searching).
+ *
+ * @param array $get GET parameters
+ * @param array $post POST parameters
+ *
+ * @return array List result with 'list' and 'count' items
+ */
+ public function domains_list($get, $post)
+ {
$auth = Auth::get_instance();
$domains = $auth->list_domains();