$Person->friends()

Returns a stack of people who $person has added the "friend" flag to. This is not a two-way relationship: $person's friends do not have to agree.

By default, this will contain the 20 most recently added friends. If you need to see more friends, pass a number on your first use of the function:

$all_my_friends = $person->friends(10000000);

Examples:

You might want to output a list of someone's friends:

$person->friends()->output('short');

Our display how many friends someone has....

echo $person->friends()->totalCount();

Or, load content that was authored by anyone in my list of friends:

$POD->getContent(array(
  'userId'=>$person->friends(500)->extract('id')
));

See also: $Person->addFriend(), $Person->removeFriend(), and $Person->isFriendsWith().

Don't forget: because this function returns a stack, it has all the capabilities of stacks.

• Discuss This Document

No comments have been posted yet.

0.9 Latest Version:
Release Notes