README

SOcial Network InterConnect

The Sonic SDK provides a complete toolset to ease the integration of the Sonic protocol into new and existing Online Social Network (OSN) platforms. It is written in PHP 5.6 and is fully compatible with PHP 7.0. The Sonic SDK can be installed via Composer or fetched directly from GitHub.

System requirements

PHP 5.6+ or PHP 7.0+
OpenSSL 1.0.0+
cURL 7.20.0+
composer

Changelog

0.5.1

0.5.0

Reworked resource migration
Reworked resource feature
Reworked resource link
Renamed resource stream to activity
Marked resource person deprecated
Added resource image
Improvement and fixes

0.3.0

Added Access Control functionality
Added code examples
Various fixes and improvements

0.2.5

Added feature negotiation functionality
Various fixes and improvements

0.2.0

Added migration functionality
Added search functionality
Various fixes and improvements

0.1.9

Added unit tests
Added logging support
Code cleanup
Removed unused classes/functions
Various fixes and improvements

0.1.0

Initial release

Installation

Install via composer with

$ composer require sgoendoer/sonic

or configure your composer.json like this:

"require": {
	"sgoendoer/sonic": "0.5.1"
}

and run

$ composer update

Configuration

For the configuration of the Sonic class, the sgoendoer\Sonic\Config\Configuration can be populated with the desired values. Values, which are not set explicitly will stay at their default values.

Configuration::setTimezone('Europe/Berlin')
Configuration::setVerbose(1);

Configuration values

Initialization

<?php

require_once(__DIR__ . '/vendor/autoload.php');

use sgoendoer\Sonic\Sonic;

use sgoendoer\Sonic\Config\Configuration;

use sgoendoer\Sonic\Identity\EntityAuthData;
use sgoendoer\Sonic\Identity\SocialRecord;
use sgoendoer\Sonic\Identity\SocialRecordManager;

try {
	// Sonic requires the \Sonic\Identity\SocialRecord of the Sonic platform for
	// initialization. Here, we import one from a String resource using
	// \Sonic\Identity\SocialRecordManager
	
	$platformSR = '{"socialRecord":{"@context": --truncated-- }';
	
	$sr = SocialRecordManager::importSocialRecord($platformSR);
	$platformSocialRecord = $sr['socialRecord'];
	$platformAccountKeyPair = $sr['accountKeyPair'];
	$platformPersonalKeyPair = $sr['personalKeyPair'];
	
	// We do the same for a user "Alice's" \Sonic\Identity\SocialRecord
	
	$aliceSR = '{"socialRecord":{"@context": --truncated -- }';
	
	$sr = SocialRecordManager::importSocialRecord($aliceSR);
	$userSocialRecord = $sr['socialRecord'];
	$userAccountKeyPair = $sr['accountKeyPair'];
	$userPersonalKeyPair = $sr['personalKeyPair'];
	
	// Before we can initialize the Sonic SDK, we need to pass a few configuration parameters.
	// Parameters we don't set explicitly will be set to default values.
	
	Configuration::setTimezone('Europe/Berlin');
	Configuration::setVerbose(1);
	
	// Now, we can initialize the Sonic SDK. The SDK's context will be set to "platform"
	// automatically
	
	$sonic = Sonic::initInstance(new EntityAuthData(
									$platformSocialRecord,
									$platformAccountKeyPair,
									$platformPersonalKeyPair));
											
	// From this point on, the Sonic SDK is fully initialized. Anyhow, the context must be
	// set to "user" in order to perform requests in the context of a user:
	
	Sonic::setUserAuthData(
		new EntityAuthData($userSocialRecord, $userAccountKeyPair));
	Sonic::setContext(Sonic::CONTEXT_USER);
	
	// Now we can perform a request to another user's profile using a GlobalID
	
	$globalID = '28B6TE8T9NUO202C5NZIUTNQSP88E70B8JAWH4FQ58OJOB8LIF';
	
	$response = (new ProfileRequestBuilder($globalID))
				->createGETProfile()
				->dispatch();
	$profile = ProfileObjectBuilder::buildFromJSON($response->getPayload());
	
	echo $profile->getJSONString() . "\n\n";
} catch (\Exception $e) {}
?>

sgoendoer / sonic

Maintainers

Details