RoomsFormHelper.php

<?php
/**
 * Rooms Helper
 *
 * @author Noriko Arai <arai@nii.ac.jp>
 * @author Shohei Nakajima <nakajimashouhei@gmail.com>
 * @link http://www.netcommons.org NetCommons Project
 * @license http://www.netcommons.org/license.txt NetCommons License
 * @copyright Copyright 2014, NetCommons Project
 */

App::uses('AppHelper', 'View/Helper');
App::uses('Room', 'Rooms.Model');

/**
 * ルームFormヘルパー
 *
 * RoomsFormComponentとセットで使用する
 *
 * @author Shohei Nakajima <nakajimashouhei@gmail.com>
 * @package NetCommons\UserAttribute\View\Helper
 */
class RoomsFormHelper extends AppHelper {

/**
 * 使用するヘルパー
 *
 * @var array
 */
	public $helpers = array(
		'NetCommons.LinkButton',
		'NetCommons.MessageFlash',
		'NetCommons.NetCommonsForm',
		'NetCommons.NetCommonsHtml',
		'Rooms.Rooms',
	);

/**
 * Before render callback. beforeRender is called before the view file is rendered.
 *
 * Overridden in subclasses.
 *
 * @param string $viewFile The view file that is going to be rendered
 * @return void
 */
	public function beforeRender($viewFile) {
		$this->NetCommonsHtml->css('/rooms/css/style.css');
		parent::beforeRender($viewFile);
	}

/**
 * Roomに対するプラグインチェックボックスリスト
 *
 * @param string $fieldName フィールド名
 * @param array $attributes HTMLの属性オプション
 * @return string HTML
 */
	public function checkboxRooms($fieldName, $attributes = array()) {
		$html = '';

		$roomTreeList = $this->_View->viewVars['roomTreeList'];

		if (! $roomTreeList) {
			return $html;
		}

		$html .= $this->NetCommonsForm->hidden($fieldName, array(
			'value' => false,
		));
		$this->NetCommonsForm->unlockField($fieldName);

		$html .= '<dl>';
		foreach ($roomTreeList as $roomId => $tree) {
			$nest = substr_count($tree, Room::$treeParser);
			$html .= $this->__room($fieldName, $roomId, $nest, $attributes);
		}
		$html .= '</dl>';

		return $html;
	}

/**
 * Roomに対するプラグインチェックボックスリスト
 *
 * self::checkboxRooms()から実行される
 *
 * @param string $fieldName フィールド名
 * @param int $roomId ルームID
 * @param string $nest インデント
 * @param array $attributes HTMLの属性オプション
 * @return string HTML
 */
	private function __room($fieldName, $roomId, $nest, $attributes = array()) {
		$html = '';

		$rooms = $this->_View->viewVars['rooms'];
		$default = Hash::get($attributes, 'default', array());

		if (! Hash::get($rooms, $roomId) ||
				Hash::get($rooms, $roomId . '.Room.space_id') === Space::PRIVATE_SPACE_ID &&
				! Hash::get($attributes, 'privateSpace', true)) {
			return $html;
		}
		$room = Hash::get($rooms, $roomId);

		$html .= '<dd class="form-group form-inline">';
		$html .= str_repeat('<span class="rooms-tree"> </span>', $nest);

		$html .= $this->NetCommonsForm->checkbox($fieldName . '.', array(
			'label' => $this->Rooms->roomName($room),
			'escape' => false,
			'div' => false,
			'id' => $this->domId($fieldName . $roomId),
			'value' => $roomId,
			'hiddenField' => false,
			'checked' => in_array((string)$roomId, $default, true),
		));

		$html .= $this->NetCommonsForm->hidden('Room.' . $roomId . '.id', array(
			'value' => $roomId
		));
		$html .= '</dd>';

		return $html;
	}

/**
 * ルーム設定タブの出力
 *
 * @return string HTML
 */
	public function settingTabs() {
		$activeSpaceId = $this->_View->viewVars['activeSpaceId'];
		if (isset($this->_View->viewVars['activeRoomId'])) {
			$activeRoomId = $this->_View->viewVars['activeRoomId'];
		} else {
			$activeRoomId = null;
		}

		$output = '';
		if ($this->_View->params['action'] === 'add') {
			$disabled = 'disabled';
			$urlRooms = '#';
			$urlRolesRoomsUsers = '#';
			$urlPluginsRooms = '#';
		} else {
			$disabled = '';
			$urlRooms = '/rooms/rooms/' . $this->_View->params['action'] . '/' .
					h($activeSpaceId) . '/' . h($activeRoomId) . '/';
			$urlRolesRoomsUsers = '/rooms/rooms_roles_users/edit/' .
					h($activeSpaceId) . '/' . h($activeRoomId) . '/';
			$urlPluginsRooms = '/rooms/plugins_rooms/edit/' .
					h($activeSpaceId) . '/' . h($activeRoomId) . '/';
		}

		$output .= '<ul class="nav nav-pills" role="tablist">';
		if ($this->_View->params['controller'] === 'rooms') {
			$class = 'active';
		} else {
			$class = $disabled;
		}
		$output .= '<li class="' . $class . '">';
		$output .= $this->NetCommonsHtml->link(__d('rooms', 'General setting'), $urlRooms);
		$output .= '</li>';

		$communityRoomId = Space::getRoomIdRoot(Space::COMMUNITY_SPACE_ID);
		$privateRoomId = Space::getRoomIdRoot(Space::PRIVATE_SPACE_ID);
		$noRoomsRolesUsers = [$privateRoomId, $communityRoomId];
		if (! in_array(Hash::get($this->_View->request->data, 'Room.id'), $noRoomsRolesUsers, true)) {
			if ($this->_View->params['controller'] === 'rooms_roles_users') {
				$class = 'active';
			} else {
				$class = $disabled;
			}
			$output .= '<li class="' . $class . '">';
			$output .= $this->NetCommonsHtml->link(
				__d('rooms', 'Edit the members to join'), $urlRolesRoomsUsers
			);
			$output .= '</li>';
		}

		if (Hash::get($this->_View->request->data, 'Room.id') !== $communityRoomId) {
			if ($this->_View->params['controller'] === 'plugins_rooms') {
				$class = 'active';
			} else {
				$class = $disabled;
			}
			$output .= '<li class="' . $class . '">';
			$output .= $this->NetCommonsHtml->link(
				__d('rooms', 'Select the plugins to join'), $urlPluginsRooms
			);
			$output .= '</li>';
		}
		$output .= '</ul>';

		return $output;
	}

/**
 * 状態の変更
 *
 * @param array $room ルームデータ配列
 * @return string HTML
 */
	public function changeStatus($room) {
		$this->_View->request->data = $room;
		$output = '';

		$output .= $this->NetCommonsForm->create('Room', array(
			'type' => 'put',
			'class' => 'inline-block rooms-change-status',
			'url' => NetCommonsUrl::actionUrlAsArray(array(
				'action' => 'active', $room['Space']['id'], $room['Room']['id']
			)),
		));

		$output .= $this->NetCommonsForm->hidden('Room.id');
		if ($room['Room']['active']) {
			$output .= $this->NetCommonsForm->hidden('Room.active', array('value' => '0'));
			$output .= $this->NetCommonsForm->button(__d('rooms', 'Open'), array(
				'name' => 'save',
				'class' => 'btn btn-default btn-xs',
				'ng-disabled' => 'sending'
			));
		} else {
			$output .= $this->NetCommonsForm->hidden('Room.active', array('value' => '1'));
			$output .= $this->NetCommonsForm->button(__d('rooms', 'Under maintenance'), array(
				'name' => 'save',
				'class' => 'btn btn-default btn-xs',
				'ng-disabled' => 'sending'
			));
		}
		$output .= $this->NetCommonsForm->end();

		return $output;
	}

/**
 * スペース編集の説明＋ボタン
 *
 * @param int $spaceId スペースID
 * @return string HTML
 */
	public function editSpaceDescription($spaceId) {
		$space = $this->_View->viewVars['spaces'][$spaceId];

		$output = '';
		$output .= '<div class="clearfix">';

		$button = '';
		$button .= $this->LinkButton->edit(
			'',
			array(
				'controller' => 'rooms',
				'action' => 'edit',
				'key' => $space['Space']['id'],
				'key2' => $space['Room']['id']
			),
			array('iconSize' => 'btn-xs')
		);

		if ($spaceId === Space::PUBLIC_SPACE_ID) {
			$output .= sprintf(
				__d('rooms', 'The setting of %s space also to non-members is published.'),
				$this->Rooms->roomName($space)
			);

			$button .= $this->LinkButton->edit(
				__d('rooms', 'Edit the members'),
				array(
					'controller' => 'rooms_roles_users',
					'action' => 'edit',
					'key' => $space['Space']['id'],
					'key2' => $space['Room']['id']
				),
				array('iconSize' => 'btn-xs space-edit-rooms-roles-users')
			);
		} elseif ($spaceId === Space::PRIVATE_SPACE_ID) {
			$output .= sprintf(
				__d('rooms', 'The setting of %s space.'),
				$this->Rooms->roomName($space)
			);

			$button .= $this->LinkButton->edit(
				__d('rooms', 'Select the plugins to join'),
				array(
					'controller' => 'plugins_rooms',
					'action' => 'edit',
					'key' => $space['Space']['id'],
					'key2' => $space['Room']['id']
				),
				array('iconSize' => 'btn-xs space-edit-rooms-roles-users')
			);
		} else {
			$output .= sprintf(
				__d('rooms', 'The setting of %s space.'),
				$this->Rooms->roomName($space)
			);
		}

		$output .= $this->NetCommonsHtml->div(
			null, $button, array('class' => 'pull-right')
		);
		$output .= '</div>';

		return $this->MessageFlash->description($output);
	}

/**
 * ルーム追加の説明＋ボタン
 *
 * @param int $spaceId スペースID
 * @return string HTML
 */
	public function addRoomDescription($spaceId) {
		$space = $this->_View->viewVars['spaces'][$spaceId];

		$output = '';
		$output .= '<div class="clearfix">';

		$output .= sprintf(
			__d('rooms', 'In %s space, to add a new room.'),
			$this->Rooms->roomName($space)
		);

		$output .= $this->NetCommonsHtml->div(null,
			$this->LinkButton->add(
				__d('rooms', 'Room'),
				array(
					'controller' => 'room_add',
					'action' => 'basic',
					'key' => $space['Space']['id'],
					'key2' => $space['Room']['id']
				),
				array('iconSize' => 'btn-xs')
			),
			array(
				'class' => 'pull-right'
			)
		);

		$output .= '</div>';

		return $this->MessageFlash->description($output);
	}

/**
 * ルームの説明
 *
 * @param int $spaceId スペースID
 * @return string HTML
 */
	public function indexRoomDescription($spaceId) {
		$space = $this->_View->viewVars['spaces'][$spaceId];

		$output = '';

		$output .= sprintf(
			__d('rooms', 'The setting of each room was created in a %s space.'),
			$this->Rooms->roomName($space)
		);

		return $this->MessageFlash->description($output);
	}

/**
 * すべての会員をデフォルトで参加させる
 *
 * @param string $fieldName フィールド名
 * @param array $options HTMLの属性オプション
 * @return string HTML
 */
	public function inputDefaultParticipation($fieldName, $options = array()) {
		$output = '';

		$roomNames = [];

		if (isset($this->_View->viewVars['parentRooms'])) {
			$pathName = '{n}.RoomsLanguage.{n}[language_id=' . Current::read('Language.id') . '].name';
			$roomNames = Hash::extract($this->_View->viewVars['parentRooms'], $pathName);
		}
		if ($this->_View->request->params['controller'] === 'room_add') {
			if (! $roomNames) {
				$label = __d('rooms', 'Open for all members');
			} else {
				$label = sprintf(
					__d('rooms', 'Open for %s room\'s members'),
					implode(RoomsHelper::ROOM_NAME_PAUSE, array_map('h', $roomNames))
				);
			}
		} else {
			if (count($roomNames) <= 2) {
				$label = __d('rooms', 'Open for all members');
			} else {
				array_pop($roomNames);
				$label = sprintf(
					__d('rooms', 'Open for %s room\'s members'),
					implode(RoomsHelper::ROOM_NAME_PAUSE, array_map('h', $roomNames))
				);
			}
		}

		if ($this->_View->viewVars['participationFixed']) {
			$output .= $this->NetCommonsForm->hidden($fieldName);
		}

		$output .= $this->NetCommonsForm->inlineCheckbox($fieldName,
			Hash::merge(array(
				'label' => $label,
				'disabled' => $this->_View->viewVars['participationFixed'],
			), $options)
		);

		return $output;
	}

/**
 * Roomに対するセレクトボックス
 *
 * @param string $fieldName フィールド名
 * @param array $attributes HTMLの属性オプション
 * @return string HTML
 */
	public function selectRooms($fieldName, $attributes = array()) {
		$html = '';

		$roomTreeList = $this->_View->viewVars['roomTreeList'];
		$rooms = $this->_View->viewVars['rooms'];

		if (! $roomTreeList) {
			return $html;
		}

		$options = array();
		foreach ($roomTreeList as $roomId => $tree) {
			$room = Hash::get($rooms, $roomId);

			$nest = substr_count($tree, Room::$treeParser);
			$options[$roomId] = str_repeat('&nbsp;&nbsp;', $nest) . $this->Rooms->roomName($room);
		}

		$html .= $this->NetCommonsForm->input($fieldName,
			Hash::merge(array(
				'type' => 'select',
				'options' => $options,
				'label' => false,
				'div' => false,
				'error' => false,
				'escape' => false,
			), $attributes)
		);

		return $html;
	}

/**
 * ルーム管理一覧で使用する各ルームでの並び順情報
 *
 * @param array $rooms 一覧で表示するルーム情報配列
 * @return array
 */
	public function getRoomOrderList($rooms) {
		$roomOrderList = [];
		$childCount = [];
		foreach ($rooms as $room) {
			if (isset($childCount[$room['Room']['parent_id']])) {
				$childCount[$room['Room']['parent_id']]++;
			} else {
				$childCount[$room['Room']['parent_id']] = 1;
			}
			$roomOrderList[] = [
				'room_id' => $room['Room']['id'],
				'order' => $room['Room']['weight'],
				'siblings' => 0,
				'parent_id' => $room['Room']['parent_id']
			];
		}
		foreach ($roomOrderList as &$roomOrder) {
			$roomOrder['siblings'] = $childCount[$roomOrder['parent_id']];
		}
		return $roomOrderList;
	}
}