class RoomsUnitUIController in Rooms - Drupal Booking for Hotels, B&Bs and Vacation Rentals 7

UI controller.

Hierarchy

• class \EntityDefaultUIController
  • class \RoomsUnitUIController

1 string reference to 'RoomsUnitUIController'

rooms_unit_entity_info in modules/rooms_unit/rooms_unit.module

Implements hook_entity_info().

File

modules/rooms_unit/rooms_unit.admin.inc, line 15

Rooms editing UI.

class RoomsUnitUIController extends EntityDefaultUIController {

  /**
   * Overrides hook_menu() defaults. Main reason for doing this is that
   * parent class hook_menu() is optimized for entity type administration.
   */
  public function hook_menu() {
    $items = array();
    $id_count = count(explode('/', $this->path));
    $wildcard = isset($this->entityInfo['admin ui']['menu wildcard']) ? $this->entityInfo['admin ui']['menu wildcard'] : '%' . $this->entityType;
    $items[$this->path] = array(
      'title' => 'Bookable Units',
      'description' => 'Add, edit, and update bookable units.',
      'page callback' => 'system_admin_menu_block_page',
      'access arguments' => array(
        'access bookable units overview',
      ),
      'file path' => drupal_get_path('module', 'system'),
      'file' => 'system.admin.inc',
      'weight' => 10,
    );

    // Change the add page menu to multiple types of entities.
    $items[$this->path . '/add'] = array(
      'title' => 'Add a Bookable Unit',
      'description' => 'Create a new bookable unit.',
      'page callback' => 'rooms_unit_add_page',
      'access callback' => '_rooms_unit_add_access',
      'type' => MENU_NORMAL_ITEM,
      'weight' => 20,
      'file' => 'rooms_unit.admin.inc',
      'file path' => drupal_get_path('module', $this->entityInfo['module']),
    );

    // Add menu items to add each different type of room.
    foreach (rooms_unit_get_types() as $type) {
      $items[$this->path . '/add/' . $type->type] = array(
        'title' => 'Add @unit_type_label unit',
        'title arguments' => array(
          '@unit_type_label' => $type->label,
        ),
        'page callback' => 'rooms_unit_create_form_wrapper',
        'page arguments' => array(
          $type->type,
        ),
        'access callback' => 'rooms_unit_access',
        'access arguments' => array(
          'create',
          rooms_unit_create(array(
            'type' => $type->type,
            'uid' => 0,
          )),
        ),
        'file' => 'rooms_unit.admin.inc',
        'file path' => drupal_get_path('module', $this->entityInfo['module']),
      );
    }

    // Loading and editing Rooms entities.
    $items[$this->path . '/unit/' . $wildcard] = array(
      'title callback' => 'rooms_unit_page_title',
      'title arguments' => array(
        $id_count + 1,
      ),
      'page callback' => 'rooms_unit_page_view',
      'page arguments' => array(
        $id_count + 1,
      ),
      'access callback' => 'rooms_unit_access',
      'access arguments' => array(
        'view',
        $id_count + 1,
      ),
      'context' => MENU_CONTEXT_PAGE | MENU_CONTEXT_INLINE,
    );
    $items[$this->path . '/unit/' . $wildcard . '/view'] = array(
      'title' => 'View',
      'type' => MENU_DEFAULT_LOCAL_TASK,
      'weight' => -10,
      'context' => MENU_CONTEXT_PAGE | MENU_CONTEXT_INLINE,
    );
    $items[$this->path . '/unit/' . $wildcard . '/edit'] = array(
      'title' => 'Edit',
      'page callback' => 'rooms_unit_form_wrapper',
      'page arguments' => array(
        $id_count + 1,
      ),
      'access callback' => 'rooms_unit_access',
      'access arguments' => array(
        'update',
        $id_count + 1,
      ),
      'weight' => 0,
      'type' => MENU_LOCAL_TASK,
      'context' => MENU_CONTEXT_PAGE | MENU_CONTEXT_INLINE,
      'file' => 'rooms_unit.admin.inc',
      'file path' => drupal_get_path('module', $this->entityInfo['module']),
    );
    $items[$this->path . '/unit/' . $wildcard . '/delete'] = array(
      'title' => 'Delete',
      'page callback' => 'rooms_unit_delete_form_wrapper',
      'page arguments' => array(
        $id_count + 1,
      ),
      'access callback' => 'rooms_unit_access',
      'access arguments' => array(
        'delete',
        $id_count + 1,
      ),
      'type' => MENU_LOCAL_TASK,
      'context' => MENU_CONTEXT_INLINE,
      'weight' => 10,
      'file' => 'rooms_unit.admin.inc',
      'file path' => drupal_get_path('module', $this->entityInfo['module']),
    );

    // Menu item for viewing rooms.
    $items['unit/' . $wildcard] = array(
      'title callback' => 'rooms_unit_page_title',
      'title arguments' => array(
        1,
      ),
      'page callback' => 'rooms_unit_page_view',
      'page arguments' => array(
        1,
      ),
      'access callback' => 'rooms_unit_access',
      'access arguments' => array(
        'view',
        1,
      ),
      'type' => MENU_CALLBACK,
    );
    return $items;
  }

  /**
   * Creates the markup for the add Bookable Unit Entities page within the class
   * so it can easily be extended/overridden.
   */
  public function addPage() {
    $item = menu_get_item();
    $content = system_admin_menu_block($item);
    if (count($content) == 1) {
      $item = array_shift($content);
      drupal_goto($item['href']);
    }
    return array(
      '#theme' => 'rooms_unit_add_list',
      '#content' => $content,
    );
  }

}

Members

Name	Modifiers	Type	Description	Overrides
EntityDefaultUIController::$entityInfo	protected	property
EntityDefaultUIController::$entityType	protected	property
EntityDefaultUIController::$id_count	protected	property
EntityDefaultUIController::$overviewPagerLimit	public	property	Defines the number of entries to show per page in overview table.
EntityDefaultUIController::applyOperation	public	function	Applies an operation to the given entity.
EntityDefaultUIController::entityFormSubmitBuildEntity	public	function	Entity submit builder invoked via entity_ui_form_submit_build_entity().
EntityDefaultUIController::hook_forms	public	function	Provides definitions for implementing hook_forms().
EntityDefaultUIController::operationCount	protected	function	Returns the operation count for calculating colspans.
EntityDefaultUIController::operationForm	public	function	Builds the operation form.
EntityDefaultUIController::operationFormSubmit	public	function	Operation form submit callback.	1
EntityDefaultUIController::operationFormValidate	public	function	Operation form validation callback.
EntityDefaultUIController::overviewForm	public	function	Builds the entity overview form.
EntityDefaultUIController::overviewFormSubmit	public	function	Overview form submit callback.
EntityDefaultUIController::overviewFormValidate	public	function	Overview form validation callback.
EntityDefaultUIController::overviewTable	public	function	Generates the render array for a overview table for arbitrary entities matching the given conditions.
EntityDefaultUIController::overviewTableHeaders	protected	function	Generates the table headers for the overview table.
EntityDefaultUIController::overviewTableRow	protected	function	Generates the row for the passed entity and may be overridden in order to customize the rows.
EntityDefaultUIController::__construct	public	function
RoomsUnitUIController::addPage	public	function	Creates the markup for the add Bookable Unit Entities page within the class so it can easily be extended/overridden.
RoomsUnitUIController::hook_menu	public	function	Overrides hook_menu() defaults. Main reason for doing this is that parent class hook_menu() is optimized for entity type administration. Overrides EntityDefaultUIController::hook_menu