Returns the currently logged in user, if there is one.
| public getAuth ( string $format = null ) : mixed | ||
| $format | string | The return format, defaults to the unique Horde ID. Alternative formats: - bare: (string) Horde ID without any domain information. EXAMPLE: foo@example.com would be returned as 'foo'. - domain: (string) Domain of the Horde ID. EXAMPLE: foo@example.com would be returned as 'example.com'. - original: (string) The username used to originally login to Horde. |
| return | mixed | The user ID or false if no user is logged in. |
/**
* Locks a uri
*
* @param string $uri
* @param Locks\LockInfo $lockInfo
* @return bool
*/
public function lock($uri, Locks\LockInfo $lockInfo)
{
list($app) = explode('/', $uri);
$type = $lockInfo->scope == Locks\LockInfo::EXCLUSIVE ? Horde_Lock::TYPE_EXCLUSIVE : Horde_Lock::TYPE_SHARED;
try {
$lockId = $this->_lock->setLock($this->_registry->getAuth(), $app, $uri, $lockInfo->timeout ?: Horde_Lock::PERMANENT, $type);
$lockInfo->token = $lockId;
} catch (Horde_Lock_Exception $e) {
throw new DAV\Exception($e->getMessage(), $e->getCode(), $e);
}
}
/**
* Returns the favouriteRecipients data for RI requests.
*
* @param integer $max The maximum number of recipients to return.
*
* @return array An array of email addresses.
*/
public function getRecipientCache($max = 100)
{
$cache = $GLOBALS['injector']->getInstance('Horde_Cache');
$cache_key = 'HCASC:' . $this->_registry->getAuth() . ':' . $max;
if (!$cache->exists($cache_key, 3600)) {
$results = $this->_registry->mail->favouriteRecipients($max);
$cache->set($cache_key, json_encode($results));
} else {
$results = json_decode($cache->get($cache_key, 3600));
}
return $results;
}
/**
* Finds out if the user has the specified rights to the given object,
* specific to a certain application.
*
* @param string $permission The permission to check.
* @param array $opts Additional options:
* <pre>
* 'app' - (string) The app to check.
* DEFAULT: The current pushed app.
* 'opts' - (array) Additional options to pass to the app function.
* DEFAULT: None
* </pre>
*
* @return mixed The specified permissions.
*/
public function hasAppPermission($permission, $opts = array())
{
$app = isset($opts['app']) ? $opts['app'] : $this->_registry->getApp();
if ($this->_perms->exists($app . ':' . $permission)) {
$perms = $this->_perms->getPermissions($app . ':' . $permission, $this->_registry->getAuth());
if ($perms === false) {
return false;
}
$args = array($permission, $perms, isset($opts['opts']) ? $opts['opts'] : array());
try {
return $this->_registry->callAppMethod($app, 'hasPermission', array('args' => $args));
} catch (Horde_Exception $e) {
}
}
return true;
}