You are here

Home » API reference » Panelizer 7.3 » PanelizerEntityComment.class.php

class PanelizerEntityComment in Panelizer 7.3

Panelizer Entity comment plugin class.

Handles comment specific functionality for Panelizer.

Hierarchy

Expanded class hierarchy of PanelizerEntityComment

1 string reference to 'PanelizerEntityComment'
comment.inc in plugins/entity/comment.inc

File

plugins/entity/PanelizerEntityComment.class.php, line 12
Class for the Panelizer comment entity plugin.

View source 
class PanelizerEntityComment extends PanelizerEntityDefault {
  public $views_table = 'comment';
  public $uses_page_manager = FALSE;
  public function entity_access($op, $entity) {
    if ($op == 'edit') {
      return comment_access($op, $entity);
    }

    // The view operation is not implemented by core.
    if ($op == 'view') {
      return TRUE;
    }
    return FALSE;
  }

  /**
   * Implement the save function for the entity.
   */
  public function entity_save($entity) {
    comment_save($entity);
  }
  public function settings_form(&$form, &$form_state) {
    parent::settings_form($form, $form_state);
  }
  public function entity_identifier($entity) {
    return t('This comment');
  }
  public function entity_bundle_label() {
    return t('Comment node type');
  }
  function get_default_display($bundle, $view_mode) {

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

  /**
   * 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 = 'comment_view_panelizer';
    $handler->task = 'comment_view';
    $handler->subtask = '';
    $handler->handler = 'panelizer_node';
    $handler->weight = -100;
    $handler->conf = array(
      'title' => t('Comment panelizer'),
      'context' => 'argument_entity_id:comment_1',
      'access' => array(),
    );
    $handlers['comment_view_panelizer'] = $handler;
    return $handlers;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
PanelizerEntityComment::$uses_page_manager public property
PanelizerEntityComment::$views_table public property The base table in SQL the entity uses, for views support. Overrides PanelizerEntityDefault::$views_table
PanelizerEntityComment::entity_access public function Determine if the current user has $op access on the $entity. Overrides PanelizerEntityInterface::entity_access
PanelizerEntityComment::entity_bundle_label public function Get the name of bundles on the entity. Overrides PanelizerEntityDefault::entity_bundle_label
PanelizerEntityComment::entity_identifier public function Get the visible identifier if the identity. Overrides PanelizerEntityDefault::entity_identifier
PanelizerEntityComment::entity_save public function Implement the save function for the entity. Overrides PanelizerEntityInterface::entity_save
PanelizerEntityComment::get_default_display function Provide a default display for newly panelized entities. Overrides PanelizerEntityDefault::get_default_display
PanelizerEntityComment::hook_default_page_manager_handlers public function Implements a delegated hook_page_manager_handlers().
PanelizerEntityComment::settings_form public function Add entity specific form to the Panelizer settings form. Overrides PanelizerEntityDefault::settings_form
PanelizerEntityDefault::$displays private property Storage for the display defaults already loaded by the system. Used in default_display_exists().
PanelizerEntityDefault::$displays_loaded private property
PanelizerEntityDefault::$enabled_view_modes private property
PanelizerEntityDefault::$entity_admin_root public property Where in the entity admin UI we should add Panelizer tabs with bundles. 3
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::add_bundle_setting_form_validate public function Validate callback for the bundle edit form. 1
PanelizerEntityDefault::admin_bundle_display_path public function Obtain the system path to an entity bundle's display settings page for a specific view mode. Overrides PanelizerEntityInterface::admin_bundle_display_path
PanelizerEntityDefault::check_page_manager_status public function Check if the necessary Page Manager display is enabled and the appropriate variant has not been disabled. Overrides PanelizerEntityInterface::check_page_manager_status
PanelizerEntityDefault::clone_panelizer public function Create a new, scrubbed version of a panelizer object.
PanelizerEntityDefault::default_display_exists public function Determine whether a specific default display object exists. Overrides PanelizerEntityInterface::default_display_exists
PanelizerEntityDefault::delete_entity_panelizer function Delete panelizers associated with the entity.
PanelizerEntityDefault::entity_allows_revisions public function Determine if the entity allows revisions. Overrides PanelizerEntityInterface::entity_allows_revisions 1
PanelizerEntityDefault::entity_base_url function Provides the base panelizer URL for an entity.
PanelizerEntityDefault::get_available_view_modes public function Identify the view modes that are available for use with this entity bundle. Overrides PanelizerEntityInterface::get_available_view_modes
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_display_default_name public function Determine the default name for the default object. Overrides PanelizerEntityInterface::get_default_display_default_name
PanelizerEntityDefault::get_default_display_name public function Determine the default display name for a given bundle & view mode combination. Overrides PanelizerEntityInterface::get_default_display_name
PanelizerEntityDefault::get_default_display_variable_name public function Determine the variable name used to identify the default display for the given bundle/view mode combination. Overrides PanelizerEntityInterface::get_default_display_variable_name
PanelizerEntityDefault::get_default_panelizer_object public function Load the named default display 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_enabled_view_modes public function Identify the view modes that are enabled for use with Panelizer. Overrides PanelizerEntityInterface::get_enabled_view_modes
PanelizerEntityDefault::get_entity_view_entity public function Fetch the entity out of a build for hook_entity_view. Overrides PanelizerEntityInterface::get_entity_view_entity 2
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_page_manager_task_name public function Obtain the machine name of the Page Manager task. Overrides PanelizerEntityInterface::get_page_manager_task_name 1
PanelizerEntityDefault::get_substitute public function Identifies a substitute view mode for a given bundle. Overrides PanelizerEntityInterface::get_substitute
PanelizerEntityDefault::get_view_mode public function Identify the view mode that will actually be used for a specific request. Overrides PanelizerEntityInterface::get_view_mode
PanelizerEntityDefault::has_default_panel public function Determine if a bundle has a default display. 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 1
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_form_alter public function Overrides PanelizerEntityInterface::hook_form_alter 3
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 1
PanelizerEntityDefault::is_page_manager_enabled public function Identify whether page manager is enabled for this entity type. Overrides PanelizerEntityInterface::is_page_manager_enabled 1
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::make_fake_tabs function Create some fake tabs that are attached to a page output.
PanelizerEntityDefault::page_content function
PanelizerEntityDefault::page_context function
PanelizerEntityDefault::page_layout function
PanelizerEntityDefault::page_overview function Switched page callback to give the overview page
PanelizerEntityDefault::page_reset function Switched page callback to give the settings form.
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::preprocess_panelizer_view_mode public function Preprocess the entity view mode template. 1
PanelizerEntityDefault::render_entity function Render the panels display for a given panelizer entity. Overrides PanelizerEntityInterface::render_entity 1
PanelizerEntityDefault::reset_entity_panelizer function Reset displays so that the defaults can be used instead.
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
PanelizerEntityDefault::wrap_default_panelizer_pages function Provides a wrapper for the panelizer page output.
PanelizerEntityDefault::wrap_entity_panelizer_pages function Provides a wrapper for the panelizer page output.