JLinkedinPeople

class JLinkedinPeople extends JLinkedinObject

Linkedin API People class for the Joomla Platform.

Methods

__construct( Registry $options = null, JHttp $client = null, JLinkedinOAuth $oauth = null)

Constructor.

from JLinkedinObject
string
booleanToString( boolean $bool)

Method to convert boolean to string.

from JLinkedinObject
mixed
getOption( string $key)

Get an option from the JLinkedinObject instance.

from JLinkedinObject
JLinkedinObject
setOption( string $key, mixed $value)

Set an option for the JLinkedinObject instance.

from JLinkedinObject
array
getProfile( string $id = null, string $url = null, string $fields = null, string $type = 'standard', string $language = null)

Method to get a member's profile.

array
getConnections( string $fields = null, integer $start, integer $count = 500, string $modified = null, string $modified_since = null)

Method to get a list of connections for a user who has granted access to his/her account.

array
search( string $fields = null, string $keywords = null, string $first_name = null, string $last_name = null, string $company_name = null, boolean $current_company = null, string $title = null, boolean $current_title = null, string $school_name = null, string $current_school = null, string $country_code = null, integer $postal_code = null, integer $distance = null, string $facets = null, array $facet = null, integer $start, integer $count = 10, string $sort = null)

Method to get information about people.

Details

__construct( Registry $options = null, JHttp $client = null, JLinkedinOAuth $oauth = null)

Constructor.

Parameters

Registry $options Linkedin options object.
JHttp $client The HTTP client object.
JLinkedinOAuth $oauth The OAuth client.

string booleanToString( boolean $bool)

Method to convert boolean to string.

Parameters

boolean $bool The boolean value to convert.

Return Value

string String with the converted boolean.

mixed getOption( string $key)

Get an option from the JLinkedinObject instance.

Parameters

string $key The name of the option to get.

Return Value

mixed The option value.

JLinkedinObject setOption( string $key, mixed $value)

Set an option for the JLinkedinObject instance.

Parameters

string $key The name of the option to set.
mixed $value The option value to set.

Return Value

JLinkedinObject This object for method chaining.

array getProfile( string $id = null, string $url = null, string $fields = null, string $type = 'standard', string $language = null)

Method to get a member's profile.

Parameters

string $id Member id of the profile you want.
string $url The public profile URL.
string $fields Request fields beyond the default ones.
string $type Choosing public or standard profile.
string $language A comma separated list of locales ordered from highest to lowest preference.

Return Value

array The decoded JSON response

array getConnections( string $fields = null, integer $start, integer $count = 500, string $modified = null, string $modified_since = null)

Method to get a list of connections for a user who has granted access to his/her account.

Parameters

string $fields Request fields beyond the default ones.
integer $start Starting location within the result set for paginated returns.
integer $count The number of results returned.
string $modified Values are updated or new.
string $modified_since Value as a Unix time stamp of milliseconds since epoch.

Return Value

array The decoded JSON response

Method to get information about people.

Parameters

string $fields Request fields beyond the default ones. provide 'api-standard-profile-request' field for out of network profiles.
string $keywords Members who have all the keywords anywhere in their profile.
string $first_name Members with a matching first name. Matches must be exact.
string $last_name Members with a matching last name. Matches must be exactly.
string $company_name Members who have a matching company name on their profile.
boolean $current_company A value of true matches members who currently work at the company specified in the company-name parameter.
string $title Matches members with that title on their profile.
boolean $current_title A value of true matches members whose title is currently the one specified in the title-name parameter.
string $school_name Members who have a matching school name on their profile.
string $current_school A value of true matches members who currently attend the school specified in the school-name parameter.
string $country_code Matches members with a location in a specific country. Values are defined in by ISO 3166 standard. Country codes must be in all lower case.
integer $postal_code Matches members centered around a Postal Code. Must be combined with the country-code parameter. Not supported for all countries.
integer $distance Matches members within a distance from a central point. This is measured in miles.
string $facets Facet buckets to return, e.g. location.
array $facet Array of facet values to search over. Contains values for location, industry, network, language, current-company, past-company and school, in exactly this order, null must be specified for an element if no value.
integer $start Starting location within the result set for paginated returns.
integer $count The number of results returned.
string $sort Controls the search result order. There are four options: connections, recommenders, distance and relevance.

Return Value

array The decoded JSON response