Docs For Class JLinkedin

Description

Joomla Platform class for interacting with a Linkedin API instance.

since: 13.1

Located in /libraries/joomla/linkedin/linkedin.php (line 19)

Variable Summary

JHttp $client

JLinkedinCommunications $communications

JLinkedinCompanies $companies

JLinkedinGroups $groups

JLinkedinJobs $jobs

JLinkedinOAuth $oauth

JRegistry $options

JLinkedinPeople $people

JLinkedinStream $stream

Method Summary

JLinkedin __construct ([JLinkedinOauth $oauth = null], [JRegistry $options = null], [JHttp $client = null])

mixed getOption (string $key)

JLinkedin setOption (string $key, mixed $value)

JLinkedinObject __get (string $name)

Variables

JHttp $client (line 31)

var: The HTTP client object to use in sending HTTP requests.
since: 13.1
access: protected

JLinkedinCommunications $communications (line 73)

var: Linkedin API object for communications.
since: 13.1
access: protected

JLinkedinCompanies $companies (line 55)

var: Linkedin API object for companies.
since: 13.1
access: protected

JLinkedinGroups $groups (line 49)

var: Linkedin API object for groups.
since: 13.1
access: protected

JLinkedinJobs $jobs (line 61)

var: Linkedin API object for jobs.
since: 13.1
access: protected

JLinkedinOAuth $oauth (line 37)

var: The OAuth client.
since: 13.1
access: protected

JRegistry $options (line 25)

var: Options for the Linkedin object.
since: 13.1
access: protected

JLinkedinPeople $people (line 43)

var: Linkedin API object for people.
since: 13.1
access: protected

JLinkedinStream $stream (line 67)

var: Linkedin API object for social stream.
since: 13.1
access: protected

Methods

Constructor __construct (line 84)

Constructor.

since: 13.1
access: public

JLinkedin __construct ([JLinkedinOauth $oauth = null], [JRegistry $options = null], [JHttp $client = null])

JLinkedinOauth $oauth: OAuth object
JRegistry $options: Linkedin options object.
JHttp $client: The HTTP client object.

getOption (line 130)

Get an option from the JLinkedin instance.

return: The option value.
since: 13.1
access: public

mixed getOption (string $key)

string $key: The name of the option to get.

setOption (line 145)

Set an option for the Linkedin instance.

return: This object for method chaining.
since: 13.1
access: public

JLinkedin setOption (string $key, mixed $value)

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

__get (line 104)

Magic method to lazily create API objects

return: Linkedin API object (statuses, users, favorites, etc.).
since: 13.1
throws: InvalidArgumentException
access: public

JLinkedinObject __get (string $name)

string $name: Name of property to retrieve