diff options
Diffstat (limited to 'engine/classes/ElggAccess.php')
| -rw-r--r-- | engine/classes/ElggAccess.php | 102 |
1 files changed, 70 insertions, 32 deletions
diff --git a/engine/classes/ElggAccess.php b/engine/classes/ElggAccess.php index 57cceef03..0aed477fc 100644 --- a/engine/classes/ElggAccess.php +++ b/engine/classes/ElggAccess.php @@ -1,32 +1,70 @@ -<?php
-/**
- * Temporary class used to determing if access is being ignored
- */
-class ElggAccess {
- /**
- * Bypass Elgg's access control if true.
- * @var bool
- */
- private $ignore_access;
-
- /**
- * Get current ignore access setting.
- * @return bool
- */
- public function get_ignore_access() {
- return $this->ignore_access;
- }
-
- /**
- * Set ignore access.
- *
- * @param $ignore bool true || false to ignore
- * @return bool Previous setting
- */
- public function set_ignore_access($ignore = true) {
- $prev = $this->ignore_access;
- $this->ignore_access = $ignore;
-
- return $prev;
- }
-}
\ No newline at end of file +<?php +/** + * Class used to determine if access is being ignored. + * + * @package Elgg.Core + * @subpackage Access + * @access private + * @see elgg_get_ignore_access() + * + * @todo I don't remember why this was required beyond scope concerns. + */ +class ElggAccess { + /** + * Bypass Elgg's access control if true. + * @var bool + */ + private $ignore_access; + + // @codingStandardsIgnoreStart + /** + * Get current ignore access setting. + * + * @return bool + * @deprecated 1.8 Use ElggAccess::getIgnoreAccess() + */ + public function get_ignore_access() { + elgg_deprecated_notice('ElggAccess::get_ignore_access() is deprecated by ElggAccess::getIgnoreAccess()', 1.8); + return $this->getIgnoreAccess(); + } + // @codingStandardsIgnoreEnd + + /** + * Get current ignore access setting. + * + * @return bool + */ + public function getIgnoreAccess() { + return $this->ignore_access; + } + + // @codingStandardsIgnoreStart + /** + * Set ignore access. + * + * @param bool $ignore Ignore access + * + * @return bool Previous setting + * + * @deprecated 1.8 Use ElggAccess:setIgnoreAccess() + */ + public function set_ignore_access($ignore = true) { + elgg_deprecated_notice('ElggAccess::set_ignore_access() is deprecated by ElggAccess::setIgnoreAccess()', 1.8); + return $this->setIgnoreAccess($ignore); + } + // @codingStandardsIgnoreEnd + + /** + * Set ignore access. + * + * @param bool $ignore Ignore access + * + * @return bool Previous setting + */ + public function setIgnoreAccess($ignore = true) { + $prev = $this->ignore_access; + $this->ignore_access = $ignore; + + return $prev; + } +} |
