diff options
author | diosmosis <benaka@piwik.pro> | 2015-09-03 01:49:52 +0300 |
---|---|---|
committer | diosmosis <benaka@piwik.pro> | 2015-09-03 01:49:52 +0300 |
commit | d824d8beea96e916ca0fe8a696e6507cbb77955b (patch) | |
tree | a27e590431128a839a8f38b3206afe91b2187185 /core/Plugin/Segment.php | |
parent | 173259c446a6446936f3cfdea4735124a0d346b7 (diff) |
Fill out some doc blocks.
Diffstat (limited to 'core/Plugin/Segment.php')
-rw-r--r-- | core/Plugin/Segment.php | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/core/Plugin/Segment.php b/core/Plugin/Segment.php index e25409064c..8a9688fb0b 100644 --- a/core/Plugin/Segment.php +++ b/core/Plugin/Segment.php @@ -53,7 +53,9 @@ class Segment private $suggestedValuesCallback; /** - * TODO + * If true, this segment will only be visible to the user if the user has view access + * to one of the requested sites (see API.getSegmentsMetadata). + * * @var bool */ private $requiresAtLeastViewAccess = false; @@ -263,7 +265,10 @@ class Segment } /** - * TODO + * Returns true if this segment should only be visible to the user if the user has view access + * to one of the requested sites (see API.getSegmentsMetadata), false if it should always be + * visible to the user (even the anonymous user). + * * @return boolean * @ignore */ @@ -273,7 +278,9 @@ class Segment } /** - * TODO + * Sets whether the segment should only be visible if the user requesting it has view access + * to one of the requested sites and if the user is not the anonymous user. + * * @param boolean $requiresAtLeastViewAccess * @ignore */ |