aboutsummaryrefslogtreecommitdiffstats
path: root/Zotlabs/Access/AccessList.php
diff options
context:
space:
mode:
authorgit-marijus <mario@mariovavti.com>2018-01-12 10:15:43 +0100
committerGitHub <noreply@github.com>2018-01-12 10:15:43 +0100
commit07b67963f128157e85c891057da2c42c286166e7 (patch)
treeb4b74f9fe5f140bc53830a12691d831ffe6cfa3a /Zotlabs/Access/AccessList.php
parent47c14d3ca1078ca1c3d94096542f14a7a537266e (diff)
parentaa63c23839990045e8e4a1a283b91a1cd21e1e9c (diff)
downloadvolse-hubzilla-07b67963f128157e85c891057da2c42c286166e7.tar.gz
volse-hubzilla-07b67963f128157e85c891057da2c42c286166e7.tar.bz2
volse-hubzilla-07b67963f128157e85c891057da2c42c286166e7.zip
Merge pull request #951 from dawnbreak/docu
:bulb: Add source documentation from recent conversations.
Diffstat (limited to 'Zotlabs/Access/AccessList.php')
-rw-r--r--Zotlabs/Access/AccessList.php8
1 files changed, 6 insertions, 2 deletions
diff --git a/Zotlabs/Access/AccessList.php b/Zotlabs/Access/AccessList.php
index 6471b0b1d..7cf7b5587 100644
--- a/Zotlabs/Access/AccessList.php
+++ b/Zotlabs/Access/AccessList.php
@@ -3,10 +3,14 @@
namespace Zotlabs\Access;
/**
- * @brief AccessList class.
+ * @brief AccessList class which represents individual content ACLs.
*
* A class to hold an AccessList object with allowed and denied contacts and
* groups.
+ *
+ * After evaluating @ref ::Zotlabs::Access::PermissionLimits "PermissionLimits"
+ * and @ref ::Zotlabs::Lib::Permcat "Permcat"s individual content ACLs are evaluated.
+ * These answer the question "Can Joe view *this* album/photo?".
*/
class AccessList {
/**
@@ -103,7 +107,7 @@ class AccessList {
* @brief Return an array consisting of the current access list components
* where the elements are directly storable.
*
- * @return Associative array with:
+ * @return array An associative array with:
* * \e string \b allow_cid => string of allowed cids
* * \e string \b allow_gid => string of allowed gids
* * \e string \b deny_cid => string of denied cids