Your IP : 216.73.217.77
<?php
namespace Ably;
use Ably\Exceptions\AblyException;
use Ably\Models\ChannelOptions;
use Ably\Models\Message;
use Ably\Models\PaginatedResult;
use Ably\Models\Status\ChannelDetails;
use Ably\Utils\Stringifiable;
use MessagePack\MessagePack;
use MessagePack\PackOptions;
/**
* Represents a channel
* @property-read Presence $presence Presence object for this channel
* @method publish(Message $message)
* @method publish(string $name, string $data)
*/
class Channel {
private $name;
private $channelPath;
private $ably;
private $presence;
/**
* @var \Ably\Models\ChannelOptions
*/
public $options;
/**
* Constructor
* @param AblyRest $ably Ably API instance
* @param string $name Channel's name
* @param ChannelOptions|array|null $options Channel options (for encrypted channels)
* @throws AblyException
*/
public function __construct( AblyRest $ably, $name, $options = [] ) {
$this->ably = $ably;
$this->name = $name;
$this->channelPath = "/channels/" . urlencode( $name );
$this->presence = new Presence( $ably, $this );
$this->setOptions( $options );
}
/**
* Magic getter for the $presence property
*/
public function __get( $name ) {
if ($name == 'presence') {
return $this->presence;
}
throw new AblyException( 'Undefined property: '.__CLASS__.'::'.$name );
}
/**
* Posts a message to this channel
* @param mixed ... Either a Message, array of Message-s, or (string eventName, string data)
* @throws \Ably\Exceptions\AblyException
*/
public function __publish_request_body($first) {
// Process arguments
$messages = [];
if ( is_a( $first, 'Ably\Models\Message' ) ) { // single Message
$messages[] = $first;
} else if ( is_array( $first ) ) { // array of Messages
$messages = $first;
} else {
throw new AblyException(
'Wrong parameters provided, use either Message, array of Messages, or name and data', 40003, 400
);
}
// Cipher and Idempotent
$emptyId = true;
foreach ( $messages as $msg ) {
if ( $this->options->cipher ) {
$msg->setCipherParams( $this->options->cipher );
}
if ( $msg->id ) {
$emptyId = false;
}
}
if ($emptyId && $this->ably->options->idempotentRestPublishing) {
$baseId = base64_encode( openssl_random_pseudo_bytes(12) );
foreach ( $messages as $key => $msg ) {
$msg->id = $baseId . ":" . $key;
}
}
// Serialize
if($this->ably->options->useBinaryProtocol) {
if ( count($messages) == 1) {
$serialized = MessagePack::pack($messages[0]->encodeAsArray(), PackOptions::FORCE_STR);
} else {
$array = [];
foreach ( $messages as $msg ) {
$array[] = $msg->encodeAsArray();
}
$serialized = MessagePack::pack($array, PackOptions::FORCE_STR);
}
}
else {
if ( count($messages) == 1) {
$serialized = $messages[0]->toJSON();
} else {
$jsonArray = [];
foreach ( $messages as $msg ) {
$jsonArray[] = $msg->toJSON();
}
$serialized = '[' . implode( ',', $jsonArray ) . ']';
}
}
return $serialized;
}
public function publish(...$args) {
$first = $args[0];
$params = [];
if ( is_string( $first ) ) { // eventName, data[, clientId][, extras]
$msg = new Message();
$msg->name = $first;
$msg->data = $args[1];
// TODO RSL1h: Remove clientId/extras extras support for 2.0
$argsn = count($args);
if ( $argsn == 3 ) {
if ( is_string($args[2]) )
$msg->clientId = $args[2];
else if ( is_array($args[2]) )
$msg->extras = $args[2];
} else if ( $argsn == 4 ) {
$msg->clientId = $args[2];
$msg->extras = $args[3];
}
$request_body = $this->__publish_request_body($msg);
} else {
$request_body = $this->__publish_request_body($first);
if ( count($args) > 1 ) {
$params = $args[1];
}
}
$url = $this->channelPath . '/messages';
if (!empty($params)) {
$url .= '?' . Stringifiable::buildQuery( $params );
}
$this->ably->post( $url, $headers = [], $request_body );
return true;
}
/**
* Retrieves channel's history of messages
* @param array $params Parameters to be sent with the request
* @return PaginatedResult
*/
public function history( $params = [] ) {
return new PaginatedResult( $this->ably, 'Ably\Models\Message',
$this->getCipherParams(),
'GET', $this->getPath() . '/messages',
$params );
}
/**
* Retrieves current channel active status with no. of publishers, subscribers, presenceMembers etc
* @return ChannelDetails
*/
public function status() {
return ChannelDetails::from($this->ably->get("/channels/" . $this->getName()));
}
/**
* @return string Channel's name
*/
public function getName() {
return $this->name;
}
/**
* @return string Channel portion of the request URI
*/
public function getPath() {
return $this->channelPath;
}
/**
* @return CipherParams|null Cipher params if the channel is encrypted
*/
public function getCipherParams() {
return $this->options->cipher;
}
/**
* @return ChannelOptions
*/
public function getOptions() {
return $this->options;
}
/**
* Sets channel options
* @param array|null $options channel options
* @throws AblyException
*/
public function setOptions( $options = [] ) {
$this->options = new ChannelOptions( $options );
}
}