AnonymousFox

/home/develito/httpdocs/libraries/joomla/linkedin/groups.php

<?php
/**
 * @package     Joomla.Platform
 * @subpackage  Linkedin
 *
 * @copyright   (C) 2013 Open Source Matters, Inc. <https://www.joomla.org>
 * @license     GNU General Public License version 2 or later; see LICENSE
 */

defined('JPATH_PLATFORM') or die();

/**
 * Linkedin API Groups class for the Joomla Platform.
 *
 * @since  3.2.0
 */
class JLinkedinGroups extends JLinkedinObject
{
	/**
	 * Method to get a group.
	 *
	 * @param   string   $id      The unique identifier for a group.
	 * @param   string   $fields  Request fields beyond the default ones.
	 * @param   integer  $start   Starting location within the result set for paginated returns.
	 * @param   integer  $count   The number of results returned.
	 *
	 * @return  array  The decoded JSON response
	 *
	 * @since   3.2.0
	 */
	public function getGroup($id, $fields = null, $start = 0, $count = 5)
	{
		$token = $this->oauth->getToken();

// Set parameters.
		$parameters = array(
			'oauth_token' => $token['key'],
		);

// Set the API base
		$base = '/v1/groups/' . $id;

$data['format'] = 'json';

// Check if fields is specified.
		if ($fields)
		{
			$base .= ':' . $fields;
		}

// Check if start is specified.
		if ($start > 0)
		{
			$data['start'] = $start;
		}

// Check if count is specified.
		if ($count != 5)
		{
			$data['count'] = $count;
		}

// Build the request path.
		$path = $this->getOption('api.url') . $base;

// Send the request.
		$response = $this->oauth->oauthRequest($path, 'GET', $parameters, $data);

return json_decode($response->body);
	}

/**
	 * Method to find the groups a member belongs to.
	 *
	 * @param   string   $id               The unique identifier for a user.
	 * @param   string   $fields           Request fields beyond the default ones.
	 * @param   integer  $start            Starting location within the result set for paginated returns.
	 * @param   integer  $count            The number of results returned.
	 * @param   string   $membershipState  The state of the caller’s membership to the specified group.
	 *                                     Values are: non-member, awaiting-confirmation, awaiting-parent-group-confirmation, member, moderator,
	 *                                     manager, owner.
	 *
	 * @return  array  The decoded JSON response
	 *
	 * @since   3.2.0
	 */
	public function getMemberships($id = null, $fields = null, $start = 0, $count = 5, $membershipState = null)
	{
		$token = $this->oauth->getToken();

// Set parameters.
		$parameters = array(
			'oauth_token' => $token['key'],
		);

// Set the API base
		$base = '/v1/people/';

// Check if id is specified.
		if ($id)
		{
			$base .= $id . '/group-memberships';
		}
		else
		{
			$base .= '~/group-memberships';
		}

$data['format'] = 'json';

// Check if fields is specified.
		if ($fields)
		{
			$base .= ':' . $fields;
		}

// Check if start is specified.
		if ($start > 0)
		{
			$data['start'] = $start;
		}

// Check if count is specified.
		if ($count != 5)
		{
			$data['count'] = $count;
		}

// Check if membership_state is specified.
		if ($membershipState)
		{
			$data['membership-state'] = $membershipState;
		}

// Build the request path.
		$path = $this->getOption('api.url') . $base;

// Send the request.
		$response = $this->oauth->oauthRequest($path, 'GET', $parameters, $data);

return json_decode($response->body);
	}

/**
	 * Method to find the groups a member belongs to.
	 *
	 * @param   string   $personId  The unique identifier for a user.
	 * @param   string   $groupId   The unique identifier for a group.
	 * @param   string   $fields    Request fields beyond the default ones.
	 * @param   integer  $start     Starting location within the result set for paginated returns.
	 * @param   integer  $count     The number of results returned.
	 *
	 * @return  array  The decoded JSON response
	 *
	 * @since   3.2.0
	 */
	public function getSettings($personId = null, $groupId = null, $fields = null, $start = 0, $count = 5)
	{
		$token = $this->oauth->getToken();

// Set parameters.
		$parameters = array(
			'oauth_token' => $token['key'],
		);

// Set the API base
		$base = '/v1/people/';

// Check if person_id is specified.
		if ($personId)
		{
			$base .= $personId . '/group-memberships';
		}
		else
		{
			$base .= '~/group-memberships';
		}

// Check if group_id is specified.
		if ($groupId)
		{
			$base .= '/' . $groupId;
		}

$data['format'] = 'json';

// Check if fields is specified.
		if ($fields)
		{
			$base .= ':' . $fields;
		}

// Check if start is specified.
		if ($start > 0)
		{
			$data['start'] = $start;
		}

// Check if count is specified.
		if ($count != 5)
		{
			$data['count'] = $count;
		}

// Build the request path.
		$path = $this->getOption('api.url') . $base;

// Send the request.
		$response = $this->oauth->oauthRequest($path, 'GET', $parameters, $data);

return json_decode($response->body);
	}

/**
	 * Method to change a groups settings.
	 *
	 * @param   string   $groupId          The unique identifier for a group.
	 * @param   boolean  $showLogo         Show group logo in profile.
	 * @param   string   $digestFrequency  Email digest frequency.
	 * @param   boolean  $announcements    Email announcements from managers.
	 * @param   boolean  $allowMessages    Allow messages from members.
	 * @param   boolean  $newPost          Email for every new post.
	 *
	 * @return  array  The decoded JSON response
	 *
	 * @since   3.2.0
	 */
	public function changeSettings($groupId, $showLogo = null, $digestFrequency = null, $announcements = null,
		$allowMessages = null, $newPost = null)
	{
		$token = $this->oauth->getToken();

// Set parameters.
		$parameters = array(
			'oauth_token' => $token['key'],
		);

// Set the API base
		$base = '/v1/people/~/group-memberships/' . $groupId;

// Build xml.
		$xml = '<group-membership>';

if (!is_null($showLogo))
		{
			$xml .= '<show-group-logo-in-profile>' . $this->booleanToString($showLogo) . '</show-group-logo-in-profile>';
		}

if ($digestFrequency)
		{
			$xml .= '<email-digest-frequency><code>' . $digestFrequency . '</code></email-digest-frequency>';
		}

if (!is_null($announcements))
		{
			$xml .= '<email-announcements-from-managers>' . $this->booleanToString($announcements) . '</email-announcements-from-managers>';
		}

if (!is_null($allowMessages))
		{
			$xml .= '<allow-messages-from-members>' . $this->booleanToString($allowMessages) . '</allow-messages-from-members>';
		}

if (!is_null($newPost))
		{
			$xml .= '<email-for-every-new-post>' . $this->booleanToString($newPost) . '</email-for-every-new-post>';
		}

$xml .= '</group-membership>';

// Build the request path.
		$path = $this->getOption('api.url') . $base;

$header['Content-Type'] = 'text/xml';

// Send the request.
		$response = $this->oauth->oauthRequest($path, 'PUT', $parameters, $xml, $header);

return $response;
	}

/**
	 * Method to join a group.
	 *
	 * @param   string   $groupId          The unique identifier for a group.
	 * @param   boolean  $showLogo         Show group logo in profile.
	 * @param   string   $digestFrequency  Email digest frequency.
	 * @param   boolean  $announcements    Email announcements from managers.
	 * @param   boolean  $allowMessages    Allow messages from members.
	 * @param   boolean  $newPost          Email for every new post.
	 *
	 * @return  array  The decoded JSON response
	 *
	 * @since   3.2.0
	 */
	public function joinGroup($groupId, $showLogo = null, $digestFrequency = null, $announcements = null,
		$allowMessages = null, $newPost = null)
	{
		$token = $this->oauth->getToken();

// Set parameters.
		$parameters = array(
			'oauth_token' => $token['key'],
		);

// Set the success response code.
		$this->oauth->setOption('success_code', 201);

// Set the API base
		$base = '/v1/people/~/group-memberships';

// Build xml.
		$xml = '<group-membership><group><id>' . $groupId . '</id></group>';

if (!is_null($showLogo))
		{
			$xml .= '<show-group-logo-in-profile>' . $this->booleanToString($showLogo) . '</show-group-logo-in-profile>';
		}

if ($digestFrequency)
		{
			$xml .= '<email-digest-frequency><code>' . $digestFrequency . '</code></email-digest-frequency>';
		}

if (!is_null($announcements))
		{
			$xml .= '<email-announcements-from-managers>' . $this->booleanToString($announcements) . '</email-announcements-from-managers>';
		}

if (!is_null($allowMessages))
		{
			$xml .= '<allow-messages-from-members>' . $this->booleanToString($allowMessages) . '</allow-messages-from-members>';
		}

if (!is_null($newPost))
		{
			$xml .= '<email-for-every-new-post>' . $this->booleanToString($newPost) . '</email-for-every-new-post>';
		}

$xml .= '<membership-state><code>member</code></membership-state></group-membership>';

// Build the request path.
		$path = $this->getOption('api.url') . $base;

$header['Content-Type'] = 'text/xml';

// Send the request.
		$response = $this->oauth->oauthRequest($path, 'POST', $parameters, $xml, $header);

return $response;
	}

/**
	 * Method to leave a group.
	 *
	 * @param   string  $groupId  The unique identifier for a group.
	 *
	 * @return  array  The decoded JSON response
	 *
	 * @since   3.2.0
	 */
	public function leaveGroup($groupId)
	{
		$token = $this->oauth->getToken();

// Set parameters.
		$parameters = array(
			'oauth_token' => $token['key'],
		);

// Set the success response code.
		$this->oauth->setOption('success_code', 204);

// Set the API base
		$base = '/v1/people/~/group-memberships/' . $groupId;

// Build the request path.
		$path = $this->getOption('api.url') . $base;

// Send the request.
		$response = $this->oauth->oauthRequest($path, 'DELETE', $parameters);

return $response;
	}

/**
	 * Method to get discussions for a group.
	 *
	 * @param   string   $id             The unique identifier for a group.
	 * @param   string   $fields         Request fields beyond the default ones.
	 * @param   integer  $start          Starting location within the result set for paginated returns.
	 * @param   integer  $count          The number of results returned.
	 * @param   string   $order          Sort order for posts. Valid for: recency, popularity.
	 * @param   string   $category       Category of posts. Valid for: discussion
	 * @param   string   $modifiedSince  Timestamp filter for posts created after the specified value.
	 *
	 * @return  array  The decoded JSON response
	 *
	 * @since   3.2.0
	 */
	public function getDiscussions($id, $fields = null, $start = 0, $count = 0, $order = null, $category = 'discussion', $modifiedSince = null)
	{
		$token = $this->oauth->getToken();

// Set parameters.
		$parameters = array(
			'oauth_token' => $token['key'],
		);

// Set the API base
		$base = '/v1/groups/' . $id . '/posts';

$data['format'] = 'json';

// Check if fields is specified.
		if ($fields)
		{
			$base .= ':' . $fields;
		}

// Check if start is specified.
		if ($start > 0)
		{
			$data['start'] = $start;
		}

// Check if count is specified.
		if ($count > 0)
		{
			$data['count'] = $count;
		}

// Check if order is specified.
		if ($order)
		{
			$data['order'] = $order;
		}

// Check if category is specified.
		if ($category)
		{
			$data['category'] = $category;
		}

// Check if modified_since is specified.
		if ($modifiedSince)
		{
			$data['modified-since'] = $modifiedSince;
		}

// Build the request path.
		$path = $this->getOption('api.url') . $base;

// Send the request.
		$response = $this->oauth->oauthRequest($path, 'GET', $parameters, $data);

return json_decode($response->body);
	}

/**
	 * Method to get posts a user started / participated in / follows for a group.
	 *
	 * @param   string   $groupId        The unique identifier for a group.
	 * @param   string   $role           Filter for posts related to the caller. Valid for: creator, commenter, follower.
	 * @param   string   $personId       The unique identifier for a user.
	 * @param   string   $fields         Request fields beyond the default ones.
	 * @param   integer  $start          Starting location within the result set for paginated returns.
	 * @param   integer  $count          The number of results returned.
	 * @param   string   $order          Sort order for posts. Valid for: recency, popularity.
	 * @param   string   $category       Category of posts. Valid for: discussion
	 * @param   string   $modifiedSince  Timestamp filter for posts created after the specified value.
	 *
	 * @return  array  The decoded JSON response
	 *
	 * @since   3.2.0
	 */
	public function getUserPosts($groupId, $role, $personId = null, $fields = null, $start = 0, $count = 0,
		$order = null, $category = 'discussion', $modifiedSince = null)
	{
		$token = $this->oauth->getToken();

// Set parameters.
		$parameters = array(
			'oauth_token' => $token['key'],
		);

// Set the API base
		$base = '/v1/people/';

// Check if person_id is specified.
		if ($personId)
		{
			$base .= $personId;
		}
		else
		{
			$base .= '~';
		}

$base .= '/group-memberships/' . $groupId . '/posts';

$data['format'] = 'json';
		$data['role'] = $role;