PanelizerEntityParagraphsItem.class.php in Paragraphs 7

File

plugins/panelizer/entity/PanelizerEntityParagraphsItem.class.php

<?php

/**
 * Panelizer Entity paragraphs item plugin class.
 *
 * Handles paragraph item specific functionality for Panelizer.
 */
class PanelizerEntityParagraphsItem extends PanelizerEntityDefault {

  /**
   * True if the entity supports revisions.
   *
   * @var bool
   */
  public $supports_revisions = TRUE;

  /**
   * Path to the admin page for this entity.
   *
   * @var string
   */
  public $entity_admin_root = 'admin/structure/paragraphs/%paragraphs_panelizer_bundle_name';

  /**
   * Menu depth to the admin page.
   *
   * @var int
   */
  public $entity_admin_bundle = 3;

  /**
   * The name of the database table storing paragraphs items.
   *
   * @var string
   */
  public $views_table = 'paragraphs_item';

  /**
   * {@inheritdoc}
   */
  public function entity_access($op, $entity) {
    return entity_access($op, $this->entity_type, $entity);
  }

  /**
   * {@inheritdoc}
   */
  public function entity_save($entity) {
    entity_save($this->entity_type, $entity);
  }

  /**
   * {@inheritdoc}
   */
  public function entity_identifier($entity) {
    return t('This paragraph item');
  }

  /**
   * {@inheritdoc}
   */
  public function entity_bundle_label() {
    return t('Paragraph item');
  }

  /**
   * {@inheritdoc}
   */
  public function entity_allows_revisions($entity) {
    $retval = array();
    $retval[0] = TRUE;
    $retval[1] = $this
      ->entity_access(!empty($entity->is_new) ? 'create' : 'update', $entity);
    return $retval;
  }

  /**
   * {@inheritdoc}
   */
  public 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);
  }

  /**
   * {@inheritdoc}
   */
  public function add_bundle_setting_form(&$form, &$form_state, $bundle, $type_location) {

    // Call parent.
    parent::add_bundle_setting_form($form, $form_state, $bundle, $type_location);

    // Move panelizer submit handler to the end.
    $submit_handler = 'panelizer_entity_default_bundle_form_submit';
    if (($index = array_search($submit_handler, $form['#submit'])) !== FALSE) {
      unset($form['#submit'][$index]);
      $form['#submit'][] = $submit_handler;
    }
  }

  /**
   * Implements hook_form_alter().
   */
  public function hook_form_alter(&$form, &$form_state, $form_id) {
    if ($form_id == 'paragraphs_admin_bundle_form') {
      if (isset($form['#paragraphs_bundle'])) {
        $bundle = $form['#paragraphs_bundle']->bundle;

        // Workaround for non-existant bundle value on updates.
        $form['panelizer_bundle'] = array(
          '#type' => 'value',
          '#value' => $bundle,
        );
        $this
          ->add_bundle_setting_form($form, $form_state, $bundle, array(
          empty($form_state['values']['locked']) && empty($bundle) ? 'bundle' : 'panelizer_bundle',
        ));
      }
    }
  }

  /**
   * Implements hook_page_alter().
   */
  public function hook_page_alter(&$page) {

    // Add an extra "Panelizer" action on the paragraphs bundles admin page.
    if (current_path() == 'admin/structure/paragraphs') {

      // This only works with some themes.
      if (!empty($page['content']['system_main']['paragraphs_bundle_table'])) {

        // Shortcut.
        $table =& $page['content']['system_main']['paragraphs_bundle_table'];

        // Operations column should always be the last column in header.
        // Increase its colspan by one to include possible panelizer link.
        $operationsCol = end($table['#header']);
        if (!empty($operationsCol['colspan'])) {
          $operationsColKey = key($table['#header']);
          $table['#header'][$operationsColKey]['colspan']++;
        }
        foreach ($table['#rows'] as $bundle => &$row) {
          $bundle_url_str = str_replace('_', '-', $bundle);
          if ($this
            ->is_panelized($bundle) && panelizer_administer_entity_bundle($this, $bundle)) {
            $row[] = array(
              'data' => l(t('panelizer'), 'admin/structure/paragraphs/' . $bundle_url_str . '/panelizer'),
            );
          }
          else {
            $row[] = array(
              'data' => '',
            );
          }
        }
      }
    }
  }

  /**
   * Implements hook_field_attach_form().
   */
  public function hook_field_attach_form($entity, &$form, &$form_state, $langcode) {
    parent::hook_field_attach_form($entity, $form, $form_state, $langcode);

    // Remove '#group' property, so panelizer settings won't be merged into
    // vertical tabs on node forms.
    if (isset($form['panelizer']['#group'])) {
      $form['panelizer']['#group'] = NULL;
    }
  }

  /**
   * Implements hook_field_attach_submit().
   */
  public function hook_field_attach_submit($entity, &$form, &$form_state) {

    // Save paragraph item panelizer settings.
    if (!empty($form_state['panelizer has choice'])) {
      list($entity_id, $revision_id, $bundle) = entity_extract_ids($this->entity_type, $entity);
      foreach ($this->plugin['view modes'] as $view_mode => $view_mode_info) {
        if (isset($form['#parents']) && drupal_array_nested_key_exists($form_state['values'], $form['#parents'])) {
          $values = drupal_array_get_nested_value($form_state['values'], $form['#parents']);
          if (isset($values['panelizer'][$view_mode]['name'])) {
            $entity->panelizer[$view_mode] = clone $this
              ->get_default_panelizer_object($bundle . '.' . $view_mode, $values['panelizer'][$view_mode]['name']);
            if (!empty($entity->panelizer[$view_mode])) {
              $entity->panelizer[$view_mode]->did = NULL;

              // Ensure original values are maintained, if they exist.
              if (isset($form['panelizer'][$view_mode]['name'])) {
                $entity->panelizer[$view_mode]->entity_id = $form['panelizer'][$view_mode]['name']['#entity_id'];
                $entity->panelizer[$view_mode]->revision_id = $form['panelizer'][$view_mode]['name']['#revision_id'];
              }
            }
          }
        }
      }
    }
  }

}

Classes

Name	Description
PanelizerEntityParagraphsItem	Panelizer Entity paragraphs item plugin class.