You are here

class PanelizerEntityUser in Panelizer 7.2

Same name and namespace in other branches
  1. 7.3 plugins/entity/PanelizerEntityUser.class.php \PanelizerEntityUser

Panelizer Entity user plugin class.

Handles user specific functionality for Panelizer.

Hierarchy

Expanded class hierarchy of PanelizerEntityUser

1 string reference to 'PanelizerEntityUser'
user.inc in plugins/entity/user.inc

File

plugins/entity/PanelizerEntityUser.class.php, line 12
Class for the Panelizer taxonomy term entity plugin.

View source
class PanelizerEntityUser extends PanelizerEntityDefault {
  public $entity_admin_root = 'admin/config/people/accounts';

  // No bundle support so we hardcode the default bundle.
  public $entity_admin_bundle = 'user';
  public $views_table = 'users';
  public function entity_access($op, $entity) {

    // This must be implemented by the extending class.
    if ($op == 'update' || $op == 'delete') {
      return user_edit_access($entity);
    }
    if ($op == 'view') {
      return user_view_access($entity);
    }
    return FALSE;
  }

  /**
   * Implement the save function for the entity.
   */
  public function entity_save($entity) {

    // IMPORTANT NOTE: this can *only* update panelizer items!
    user_save($entity, array(
      'panelizer' => $entity->panelizer,
    ));
  }

  /**
   * Implement the save function for the entity.
   */
  public function entity_allows_revisions($entity) {
    return array(
      FALSE,
      FALSE,
    );
  }
  public function settings_form(&$form, &$form_state) {
    parent::settings_form($form, $form_state);
    if (!empty($this->plugin['bundles']['user'])) {
      $task = page_manager_get_task('user_view');
      if (!empty($task['disabled'])) {
        drupal_set_message('The user template page is currently not enabled in page manager. You must enable this for Panelizer to be able to panelize users.', 'warning');
      }
      $handler = page_manager_load_task_handler($task, '', 'user_view_panelizer');
      if (!empty($handler->disabled)) {
        drupal_set_message('The panelizer variant on the user template page is currently not enabled in page manager. You must enable this for Panelizer to be able to panelize users.', 'warning');
      }
    }
  }
  public function entity_identifier($entity) {
    return t('This user');
  }
  public function entity_bundle_label() {
    return t('User');
  }
  function get_default_display() {

    // For now we just go with the empty display.
    // @todo come up with a better default display.
    return parent::get_default_display();
  }

  /**
   * Implements a delegated hook_page_manager_handlers().
   *
   * This makes sure that all panelized entities have the proper entry
   * in page manager for rendering.
   */
  public function hook_default_page_manager_handlers(&$handlers) {
    $handler = new stdClass();
    $handler->disabled = FALSE;

    /* Edit this to true to make a default handler disabled initially */
    $handler->api_version = 1;
    $handler->name = 'user_view_panelizer';
    $handler->task = 'user_view';
    $handler->subtask = '';
    $handler->handler = 'panelizer_node';
    $handler->weight = -100;
    $handler->conf = array(
      'title' => t('User panelizer'),
      'context' => 'argument_entity_id:user_1',
      'access' => array(),
    );
    $handlers['user_view_panelizer'] = $handler;
    return $handlers;
  }

  /**
   * Implements a delegated hook_form_alter.
   *
   * We want to add Panelizer settings for the bundle to the node type form.
   */
  public function hook_form_alter(&$form, &$form_state, $form_id) {
    if ($form_id == 'user_admin_settings') {
      $this
        ->add_bundle_setting_form($form, $form_state, 'user', NULL);
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
PanelizerEntityDefault::$entity_type public property The entity type the plugin is for. This is from the $plugin array.
PanelizerEntityDefault::$plugin public property The plugin metadata.
PanelizerEntityDefault::$supports_revisions public property True if the entity supports revisions. 1
PanelizerEntityDefault::access_admin function
PanelizerEntityDefault::access_default_panelizer_object public function Determine if the current user has access to the $panelizer. Overrides PanelizerEntityInterface::access_default_panelizer_object
PanelizerEntityDefault::add_admin_links public function Helper function to add administrative menu items into an entity's already existing structure.
PanelizerEntityDefault::add_bundle_setting_form public function Add the panelizer settings form to a single entity bundle config form.
PanelizerEntityDefault::add_bundle_setting_form_submit public function Submit callback for the bundle edit form.
PanelizerEntityDefault::clone_panelizer public function Create a new, scrubbed version of a panelizer object.
PanelizerEntityDefault::delete_entity_panelizer function
PanelizerEntityDefault::get_base_contexts public function Callback to get the base context for a panelized entity Overrides PanelizerEntityInterface::get_base_contexts
PanelizerEntityDefault::get_bundle_title public function
PanelizerEntityDefault::get_contexts public function Fetch an object array of CTools contexts from panelizer information. Overrides PanelizerEntityInterface::get_contexts
PanelizerEntityDefault::get_default_panelizer_object public function Load the named default panel for the bundle. Overrides PanelizerEntityInterface::get_default_panelizer_object
PanelizerEntityDefault::get_default_panelizer_objects public function Get the default panelizers for the given bundle.
PanelizerEntityDefault::get_internal_default_panelizer public function An internal representation of a panelizer object, used to seed when we have none and want something to get started.
PanelizerEntityDefault::get_panelizer_object function Get a panelizer object for the key. Overrides PanelizerEntityInterface::get_panelizer_object
PanelizerEntityDefault::has_default_panel public function Determine if a bundle has a default panel. Overrides PanelizerEntityInterface::has_default_panel
PanelizerEntityDefault::has_panel_choice public function Determine if a bundle is allowed choices. Overrides PanelizerEntityInterface::has_panel_choice
PanelizerEntityDefault::hook_admin_paths public function Implements a delegated hook_menu. Overrides PanelizerEntityInterface::hook_admin_paths
PanelizerEntityDefault::hook_entity_delete public function Overrides PanelizerEntityInterface::hook_entity_delete
PanelizerEntityDefault::hook_entity_insert public function Overrides PanelizerEntityInterface::hook_entity_insert
PanelizerEntityDefault::hook_entity_load public function Overrides PanelizerEntityInterface::hook_entity_load
PanelizerEntityDefault::hook_entity_update public function Overrides PanelizerEntityInterface::hook_entity_update
PanelizerEntityDefault::hook_field_attach_delete_revision public function Overrides PanelizerEntityInterface::hook_field_attach_delete_revision
PanelizerEntityDefault::hook_field_attach_form public function
PanelizerEntityDefault::hook_field_attach_submit public function
PanelizerEntityDefault::hook_menu public function Implements a delegated hook_menu. Overrides PanelizerEntityInterface::hook_menu
PanelizerEntityDefault::hook_menu_alter public function Overrides PanelizerEntityInterface::hook_menu_alter
PanelizerEntityDefault::hook_panelizer_defaults public function Implements a delegated hook_panelizer_defaults().
PanelizerEntityDefault::hook_permission public function Implements a delegated hook_permission. Overrides PanelizerEntityInterface::hook_permission
PanelizerEntityDefault::hook_views_data_alter public function Implement views support for panelizer entity types. Overrides PanelizerEntityInterface::hook_views_data_alter
PanelizerEntityDefault::init function Initialize the plugin and store the plugin info. Overrides PanelizerEntityInterface::init
PanelizerEntityDefault::is_panelized public function Determine if a bundle is panelized. Overrides PanelizerEntityInterface::is_panelized
PanelizerEntityDefault::load_default_panelizer_objects public function Get the default panels, keyed by names.
PanelizerEntityDefault::page_content function
PanelizerEntityDefault::page_context function
PanelizerEntityDefault::page_layout function
PanelizerEntityDefault::page_settings function Switched page callback to give the settings form.
PanelizerEntityDefault::panelizer_access function Determine if the user has access to the panelizer operation for this type.
PanelizerEntityDefault::render_entity function Render the panels display for a given panelizer entity. Overrides PanelizerEntityInterface::render_entity
PanelizerEntityDefault::settings_form_submit public function Submit entity specific settings on the Panelizer settings form. Overrides PanelizerEntityInterface::settings_form_submit
PanelizerEntityDefault::settings_form_validate public function Validate entity specific settings on the Panelizer settings form. Overrides PanelizerEntityInterface::settings_form_validate
PanelizerEntityUser::$entity_admin_bundle public property
PanelizerEntityUser::$entity_admin_root public property Where in the entity admin UI we should add Panelizer tabs with bundles. Overrides PanelizerEntityDefault::$entity_admin_root
PanelizerEntityUser::$views_table public property The base table in SQL the entity uses, for views support. Overrides PanelizerEntityDefault::$views_table
PanelizerEntityUser::entity_access public function Determine if the current user has $op access on the $entity. Overrides PanelizerEntityInterface::entity_access
PanelizerEntityUser::entity_allows_revisions public function Implement the save function for the entity. Overrides PanelizerEntityDefault::entity_allows_revisions
PanelizerEntityUser::entity_bundle_label public function Get the name of bundles on the entity. Overrides PanelizerEntityDefault::entity_bundle_label
PanelizerEntityUser::entity_identifier public function Get the visible identifier if the identity. Overrides PanelizerEntityDefault::entity_identifier
PanelizerEntityUser::entity_save public function Implement the save function for the entity. Overrides PanelizerEntityInterface::entity_save
PanelizerEntityUser::get_default_display function Provide a default display for newly panelized entities. Overrides PanelizerEntityDefault::get_default_display
PanelizerEntityUser::hook_default_page_manager_handlers public function Implements a delegated hook_page_manager_handlers().
PanelizerEntityUser::hook_form_alter public function Implements a delegated hook_form_alter. Overrides PanelizerEntityDefault::hook_form_alter
PanelizerEntityUser::settings_form public function Add entity specific form to the Panelizer settings form. Overrides PanelizerEntityDefault::settings_form