File: platform/plugins/Streams/handlers/Streams/participants/tool.php

<?php

/**
 * @module Streams-tools
 */

/**
 * This tool renders the participants in a stream
 * @class Streams participants
 * @constructor
 * @param {array} [$options] Provide options for this tool
 *   @param {string} $options.publisherId The id of the publisher
 *   @param {string} $options.streamName The name of the stream
 *   @param {Streams_Stream} [$options.stream] You can pass this instead of publisherId and streamName
 *   @param {array} [$options.invite] Pass an array here to pass as fields to 
 *     Streams/participants/invite template, otherwise the invite button doesn't appear.
 *   @param {integer} [$options.max]
 *    The number, if any, to show in the denominator of the summary
 *   @param {integer} [$options.maxShow=10]
 *    The maximum number of participants to fetch for display
 *   @param {Q.Event} [$options.onRefresh] An event that occurs when the tool is refreshed
 *   @param {boolean} [$options.showSummary] Whether to show a summary
 *   @param {boolean} [$options.showBlanks] Whether to show blank avatars in place of remaining spots
 *   @param {boolean} [$options.renderOnClient=false]
 *    If true, only the html container is rendered, so the client will do the rest.
 */
function Streams_participants_tool($options)
{
	if (!empty($options['renderOnClient'])) {
		Q_Response::setToolOptions($options);
		return '';
	}
 	$publisherId = Q::ifset($options, 'publisherId', null);
 	$streamName = Q::ifset($options, 'streamName', null);
	if (!empty($options['stream'])) {
		$stream = $options['stream'];
		$publisherId = $stream->publisherId;
		$streamName = $stream->name;
		unset($options['stream']);
	}
	if (!isset($publisherId)) {
		$publisherId = Streams::requestedPublisherId(true);
	}
	if (!isset($streamName)) {
		$streamName = Streams::requestedName(true);
	}
	$options['publisherId'] = $publisherId;
	$options['streamName'] = $streamName;
	$max = Q_Config::get(
		'Streams', 'participants', 'max', 
		Q::ifset($options, 'max', null)
	);
	$maxShow = Q::ifset($options, 'maxShow', 10);
	$showBlanks = Q::ifset($options, 'showBlanks', false);
	$showSummary = Q::ifset($options, 'showSummary', false);
	
	if (empty($stream)) {
		$stream = Streams::fetchOne(null, $publisherId, $streamName);
	}
	if (empty($stream)) {
		throw new Q_Exception_MissingRow(array(
			'table' => 'Stream', 
			'criteria' => "{publisherId: '$publisherId', name: '$streamName'}"
		));
	}
	if (!$stream->testReadLevel('participants')) {
		throw new Users_Exception_NotAuthorized();
	}
	$participants = $stream->getParticipants(compact('limit', 'offset', 'state'));
	
	Q_Response::addScript('{{Streams}}/js/Streams.js', 'Streams');
	Q_Response::addStylesheet('{{Streams}}/css/Streams.css', 'Streams');
	$options['rendered'] = true;
	Q_Response::setToolOptions($options);
	$stream->addPreloaded();
	
	$avatars = '';
	$c = 0;
	if ($participants) {
		$i = 0;
		foreach ($participants as $p) {
			if ($p->state !== 'participating') {
				continue;
			}
			++$c;
			if (!$maxShow or ++$i <= $maxShow) {
				$avatars .= Q::tool("Users/avatar", array(
					'userId' => $p->userId,
					'icon' => true,
					'short' => true
				), $p->userId);
			}
		}
	}
	Q_Response::setToolOptions('count', $c);
	$blanks = '';
	if ($showBlanks) {
		for ($i = $c; $i < $maxShow - 1; ++$i) {
			$blanks .= Q::tool("Users/avatar", array(
				'userId' => '',
				'icon' => true,
				'short' => true
			), "blank_$i");
		}
	}
	$spans = "<span class='Streams_participants_avatars'>$avatars</span>"
		. "<span class='Streams_participants_blanks'>$blanks</span>";
	$container = "<div class='Streams_participants_container'>$spans</div>";
	$count = "<span class='Streams_participants_count'>$c</span>";
	$m = isset($options['max']) ? '/'.$options['max'] : '';
	$max = "<span class='Streams_participants_max'>$m</span>";
	$img = Q_Html::img('{{Q}}/img/expand.png', 'expand', array(
		'class' => 'Streams_participants_expand_img'
	));
	$control = "<div class='Streams_participants_expand'>$img<span class='Streams_participants_expand_text'>See All</span></div>";
	$summary = "<div class='Streams_participants_summary'><span>$count$max</span></div>";
	$controls = "<div class='Streams_participants_controls'>$control</div>";
	return $controls.$summary.$container;
}