$POD->getPeople()

$people = $POD->getPeople($conditions,$sort,$count,$offset);

Get a stack of person objects that match the parameters you pass in.

Parameters

$conditions	An associative array of stack parameters that describe the people you want to load. See the stack parameters document for constructing these arrays.
$sort	A SQL style sort statement. Defaults to 'lastVisit DESC'
$count	Maximum number of people to return. Defaults to 20
$offset	Offset results by this many people. (for use in paging)

Examples

Get a simple list of the people who have logged in most recently:

$most_recent = $POD->getPeople();

Get a list of people who have a certain specific meta field:

$people = $POD->getPeople(array(
  'm.name'=>'special'
));

Get a list of people who have a specific value for a specific meta field:

$people = $POD->getPeople(array(
  'm.name'=>'special',
  'm.value'=>'featured'
));

Get a list of people with a specific flag - this example will return any person flagged by any other user with the "warn" flag:

$people = $POD->getPeople(array(
  'flag.name'=> 'warn',
));

Get a list of people with a specific flag/value set - this example will return any person flagged by any other user with the rating flag set to 5:

$people = $POD->getPeople(array(
  'flag.name'=> 'rating',
  'flag.value'=> '5'
));

Get a list of people with a specific flag set by a specific user. This is how you would pull a list of a person's friends:

$person = $POD->currentUser();
$friends = $POD->getPeople(array(
  'flag.name'=>'friend',
  'flag.userId'=>$person->get('id');
));

Get a list of people who flagged a user with a specific flag. This is how you would pull a list of a person's followers (people who have added the friend flag):

$person = $POD->currentUser();
$friends = $POD->getPeople(array(
  'flag.name'=>'friend',
  'flag.itemId'=>$person->get('id');
));

Get a list of people who flagged a specific piece of content with a specific flag. This is how you would pulla list of all the people who have favorited a specific piece of content:

$favorite_users = $POD->getPeople(array(
  'flag.name'=>'favorite',
  'flag.itemId'=>$content->get('id')
));

Be sure to check out the stack documentation for all the functionality the resulting stack will have!

• Discuss This Document

No comments have been posted yet.

Download the latest version of PeoplePods!

0.9 Latest Version:
Release Notes

Join the PeoplePods developer network and get direct access to documentation, additional plugins, and our forums!

Username:

What is your email address?

Choose a password:

  Already Registered? Login