Class Folks_Api

Folks api

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.

Horde_Registry_Api

Folks_Api

Package: Folks
Author: Duck duck@obala.net
Located at Api.php

Methods summary
`public`	# `__construct( )`
`public string`	# `getImageUrl( string $user, string $view = 'small', boolean $full = false )` Returns profile image URL. Returns profile image URL. Parameters `$user` User uid `$view` The view ('small', 'big') to show. `$full` Return a path that includes the server name? Returns `string` The image path.
`public`	# `commentCallback( integer $id, string $type = 'title', array $params = null )` Callback for comment API. Callback for comment API. Parameters `$id` Internal data identifier. `$type` Type of data to retreive (title, owner...). `$params` Parameter to be passed to callback function
`public`	# `hasComments( )` Comments are enebled Comments are enebled
`public`	# `getOnlineUsers( )` Get online users Get online users
`public`	# `getProfile( string $user = null )` Get user profile Get user profile Parameters `$user` User to get profile for
`public array`	# `getFriends( string $user = null )` Get user friends Get user friends Parameters `$user` Username to get friends for Returns `array` of users
`public true`	# `addFriend( string $user = null )` Add user to our friend list Add user to our friend list Parameters `$user` $friend Friend's usersame Returns `true` or PEAR_Error
`public true`	# `removeFriend( string $user = null )` Remove user from a fiend list Remove user from a fiend list Parameters `$user` $friend Friend's usersame Returns `true` or PEAR_Error
`public array`	# `getBlacklist( string $user = null )` Get user blacklist Get user blacklist Parameters `$user` Username to get blacklist for Returns `array` of users
`public`	# `addBlacklisted( string $user = null )` Add user to a blacklist list Add user to a blacklist list Parameters `$user` Usersame
`public`	# `removeBlacklisted( string $user = null )` Remove user from a blacklist list Remove user from a blacklist list Parameters `$user` Usersame
`public array`	# `isBlacklisted( string $user = null )` Are we blackisted by user this user? Are we blackisted by user this user? Parameters `$user` Username to get blacklist for Returns `array` of users
`public`	# `listTimeObjectCategories( )` Users categories Users categories
`public`	# `listTimeObjects( array $categories, Horde_Date $start, Horde_Date $end )` Lists users with birthdays/goout dates as time objects. Lists users with birthdays/goout dates as time objects. Parameters `$categories` The time categories (from listTimeObjectCategories) to list. `$start` The start date of the period. `$end` The end date of the period.
`public boolean`	# `logActivity( mixed $message, string $scope = 'folks', string $user = null )` Log user's activity Log user's activity Parameters `$message` Activity message or details `$scope` Scope `$user` $user Returns `boolean` True on success or a PEAR_Error object on failure.
`public array`	# `getActivity( string $user, integer $limit = 10 )` Get user's activity Get user's activity Parameters `$user` Username `$limit` Number of actions to return Returns `array` Activity log
`public boolean`	# `setStatus( booelan $online = true, string $user = null )` Set user status Set user status Parameters `$online` True to set user online, false to push it offline `$user` Username Returns `boolean` True if succes, PEAR_Error on failure
`public boolean`	# `getStatus( string $user = null )` Get user status Get user status Parameters `$user` Username Returns `boolean` True if user is online, false otherwise

Properties summary
`public array`	`$links` Links. Links.	# `array( 'show' => '%application%/user.php?user=\|user\|' )`

Packages

Classes

Class Folks_Api

Parameters

Returns

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns