aboutsummaryrefslogtreecommitdiffstats
path: root/include/permissions.php
diff options
context:
space:
mode:
authorRedMatrix <info@friendica.com>2015-03-30 10:04:15 +1100
committerRedMatrix <info@friendica.com>2015-03-30 10:04:15 +1100
commit9ae9aedb15dfcb66f5bd9d866bdfb76309c81788 (patch)
treee12ee862af63e2a66602aa91c5a4e1ff011476f9 /include/permissions.php
parent4df7a22ff5d8fccb1b24e411772904d973129ca4 (diff)
parentd0361582b0b620064aff90bf88f01d1072b308fe (diff)
downloadvolse-hubzilla-9ae9aedb15dfcb66f5bd9d866bdfb76309c81788.tar.gz
volse-hubzilla-9ae9aedb15dfcb66f5bd9d866bdfb76309c81788.tar.bz2
volse-hubzilla-9ae9aedb15dfcb66f5bd9d866bdfb76309c81788.zip
Merge pull request #944 from dawnbreak/docu
Correcting reported Doxygen syntax warnings.
Diffstat (limited to 'include/permissions.php')
-rw-r--r--include/permissions.php28
1 files changed, 14 insertions, 14 deletions
diff --git a/include/permissions.php b/include/permissions.php
index 4d7def346..82145066b 100644
--- a/include/permissions.php
+++ b/include/permissions.php
@@ -1,6 +1,6 @@
<?php
/**
- * @file incldue/permissions.php
+ * @file include/permissions.php
*
* This file conntains functions to check and work with permissions.
*/
@@ -445,21 +445,21 @@ function site_default_perms() {
/**
- * @function get_role_perms($role)
- * @param string $role
- *
- * Given a string for the channel role ('social','forum', etc)
+ * @brief Return an array of all permissions for this role.
+ *
+ * Given a string for the channel role ('social','forum', etc)
* return an array of all permission fields pre-filled for this role.
* This includes the channel permission scope indicators (anything beginning with 'channel_') as well as
- * perms_auto: true or false to create auto-permissions for this channel
- * perms_follow: The permissions to apply when initiating a connection request to another channel
- * perms_accept: The permissions to apply when accepting a connection request from another channel (not automatic)
- * default_collection: true or false to make the default ACL include the channel's default collection
- * directory_publish: true or false to publish this channel in the directory
+ * * perms_auto: true or false to create auto-permissions for this channel
+ * * perms_follow: The permissions to apply when initiating a connection request to another channel
+ * * perms_accept: The permissions to apply when accepting a connection request from another channel (not automatic)
+ * * default_collection: true or false to make the default ACL include the channel's default collection
+ * * directory_publish: true or false to publish this channel in the directory
* Any attributes may be extended (new roles defined) and modified (specific permissions altered) by plugins
*
+ * @param string $role
+ * @return array
*/
-
function get_role_perms($role) {
$ret = array();
@@ -800,9 +800,8 @@ function get_role_perms($role) {
}
/**
- * @brief Returns a list or roles, grouped by type
+ * @brief Returns a list or roles, grouped by type.
*
- * @param string $current The current role
* @return string Returns an array of roles, grouped by type
*/
function get_roles() {
@@ -811,7 +810,8 @@ function get_roles() {
t('Community Forum') => array('forum' => t('Mostly Public'), 'forum_restricted' => t('Restricted'), 'forum_private' => t('Private')),
t('Feed Republish') => array('feed' => t('Mostly Public'), 'feed_restricted' => t('Restricted')),
t('Special Purpose') => array('soapbox' => t('Celebrity/Soapbox'), 'repository' => t('Group Repository')),
- t('Other') => array('custom' => t('Custom/Expert Mode')));
+ t('Other') => array('custom' => t('Custom/Expert Mode'))
+ );
return $roles;
}