Folks_Api
extends Horde_Registry_Api
in package
Folks api
Copyright 2008 Obala d.o.o (www.obala.si)
See the enclosed file LICENSE for license information (BSD). If you did not receive this file, see http://cvs.horde.org/co.php/folks/LICENSE.
Tags
Table of Contents
- $_links : array<string|int, mixed>
- Links.
- addBlacklisted() : mixed
- Add user to a blacklist list
- addFriend() : true
- Add user to our friend list
- commentCallback() : mixed
- Callback for comment API.
- disabled() : mixed
- getActivity() : array<string|int, mixed>
- Get user's activity
- getBlacklist() : array<string|int, mixed>
- Get user blacklist
- getFriends() : array<string|int, mixed>
- Get user friends
- getImageUrl() : string
- Returns profile image URL.
- getOnlineUsers() : mixed
- Get online users
- getProfile() : mixed
- Get user profile
- getStatus() : bool
- Get user status
- hasComments() : mixed
- Comments are enebled
- isBlacklisted() : array<string|int, mixed>
- Are we blackisted by user this user?
- listTimeObjectCategories() : mixed
- Users categories
- listTimeObjects() : mixed
- Lists users with birthdays/goout dates as time objects.
- logActivity() : bool
- Log user's activity
- removeBlacklisted() : mixed
- Remove user from a blacklist list
- removeFriend() : true
- Remove user from a fiend list
- setStatus() : bool
- Set user status
Properties
$_links
Links.
protected
array<string|int, mixed>
$_links
= array('show' => '%application%/user.php?user=|user|')
Methods
addBlacklisted()
Add user to a blacklist list
public
addBlacklisted([string $user = null ]) : mixed
Parameters
- $user : string = null
-
Usersame
Return values
mixed —addFriend()
Add user to our friend list
public
addFriend([mixed $user = null ]) : true
Parameters
- $user : mixed = null
Return values
true —or PEAR_Error
commentCallback()
Callback for comment API.
public
commentCallback(int $id[, string $type = 'title' ][, array<string|int, mixed> $params = null ]) : mixed
Parameters
- $id : int
-
Internal data identifier.
- $type : string = 'title'
-
Type of data to retreive (title, owner...).
- $params : array<string|int, mixed> = null
-
Parameter to be passed to callback function
Return values
mixed —disabled()
public
disabled() : mixed
Return values
mixed —getActivity()
Get user's activity
public
getActivity(string $user[, int $limit = 10 ]) : array<string|int, mixed>
Parameters
- $user : string
-
Username
- $limit : int = 10
-
Number of actions to return
Return values
array<string|int, mixed> —Activity log
getBlacklist()
Get user blacklist
public
getBlacklist([string $user = null ]) : array<string|int, mixed>
Parameters
- $user : string = null
-
Username to get blacklist for
Return values
array<string|int, mixed> —of users
getFriends()
Get user friends
public
getFriends([string $user = null ]) : array<string|int, mixed>
Parameters
- $user : string = null
-
Username to get friends for
Return values
array<string|int, mixed> —of users
getImageUrl()
Returns profile image URL.
public
getImageUrl(string $user[, string $view = 'small' ][, bool $full = false ]) : string
Parameters
- $user : string
-
User uid
- $view : string = 'small'
-
The view ('small', 'big') to show.
- $full : bool = false
-
Return a path that includes the server name?
Return values
string —The image path.
getOnlineUsers()
Get online users
public
getOnlineUsers() : mixed
Return values
mixed —getProfile()
Get user profile
public
getProfile([string $user = null ]) : mixed
Parameters
- $user : string = null
-
User to get profile for
Return values
mixed —getStatus()
Get user status
public
getStatus([string $user = null ]) : bool
Parameters
- $user : string = null
-
Username
Return values
bool —True if user is online, false otherwise
hasComments()
Comments are enebled
public
hasComments() : mixed
Return values
mixed —isBlacklisted()
Are we blackisted by user this user?
public
isBlacklisted([string $user = null ]) : array<string|int, mixed>
Parameters
- $user : string = null
-
Username to get blacklist for
Return values
array<string|int, mixed> —of users
listTimeObjectCategories()
Users categories
public
listTimeObjectCategories() : mixed
Return values
mixed —listTimeObjects()
Lists users with birthdays/goout dates as time objects.
public
listTimeObjects(array<string|int, mixed> $categories, Horde_Date $start, Horde_Date $end) : mixed
Parameters
- $categories : array<string|int, mixed>
-
The time categories (from listTimeObjectCategories) to list.
- $start : Horde_Date
-
The start date of the period.
- $end : Horde_Date
-
The end date of the period.
Return values
mixed —logActivity()
Log user's activity
public
logActivity(mixed $message[, string $scope = 'folks' ][, string $user = null ]) : bool
Parameters
- $message : mixed
-
Activity message or details
- $scope : string = 'folks'
-
Scope
- $user : string = null
-
$user
Return values
bool —True on success or a PEAR_Error object on failure.
removeBlacklisted()
Remove user from a blacklist list
public
removeBlacklisted([string $user = null ]) : mixed
Parameters
- $user : string = null
-
Usersame
Return values
mixed —removeFriend()
Remove user from a fiend list
public
removeFriend([mixed $user = null ]) : true
Parameters
- $user : mixed = null
Return values
true —or PEAR_Error
setStatus()
Set user status
public
setStatus([booelan $online = true ][, string $user = null ]) : bool
Parameters
- $online : booelan = true
-
True to set user online, false to push it offline
- $user : string = null
-
Username
Return values
bool —True if succes, PEAR_Error on failure