class oembed_preset_ui in oEmbed 6.0

Hierarchy

class \ctools_export_ui
- class \oembed_preset_ui

Expanded class hierarchy of oembed_preset_ui

1 string reference to 'oembed_preset_ui'

oembed_preset.inc in plugins/export_ui/oembed_preset.inc

File

plugins/export_ui/oembed_preset_ui.class.php, line 3

View source

class oembed_preset_ui extends ctools_export_ui {

  /**
   * Provide the actual editing form.
   */
  function edit_form(&$form, &$form_state) {
    parent::edit_form($form, $form_state);
    $form['width'] = array(
      '#type' => 'textfield',
      '#size' => 6,
      '#default_value' => $form_state['item']->width,
      '#title' => t('Max width'),
      '#description' => t('A maximum width in pixels of the embed or 0 for no maximum.'),
    );
    $form['height'] = array(
      '#type' => 'textfield',
      '#size' => 6,
      '#default_value' => $form_state['item']->height,
      '#title' => t('Max height'),
      '#description' => t('A maximum height in pixels of the embed or 0 for no maximum.'),
    );
    $form['disable_title'] = array(
      '#type' => 'checkbox',
      '#default_value' => !empty($form_state['item']->conf['disable_title']),
      '#title' => t('Disable title when other embeddable data is available'),
    );
  }

  /**
   * Handle the submission of the edit form.
   */
  function edit_form_submit(&$form, &$form_state) {
    parent::edit_form_submit($form, $form_state);

    // Since items in our settings are not in the schema, we have to do these
    // manually:
    $form_state['item']->conf['disable_title'] = $form_state['values']['disable_title'];
  }

  /**
   * Provide a list of sort options.
   */
  function list_sort_options() {
    $options = parent::list_sort_options();
    $options += array(
      'width' => t('Width'),
      'height' => t('Height'),
    );
    return $options;
  }

  /**
   * Build a row based on the item.
   */
  function list_build_row($item, &$form_state, $operations) {

    // Set up sorting
    $name = $item->{$this->plugin['export']['key']};

    // Note: $item->type should have already been set up by export.inc so
    // we can use it safely.
    switch ($form_state['values']['order']) {
      case 'disabled':
        $this->sorts[$name] = empty($item->disabled) . $name;
        break;
      case 'title':
        $this->sorts[$name] = $item->{$this->plugin['export']['admin_title']};
        break;
      case 'width':
        $this->sorts[$name] = $item->width;
        break;
      case 'height':
        $this->sorts[$name] = $item->height;
        break;
      case 'name':
        $this->sorts[$name] = $name;
        break;
      case 'storage':
        $this->sorts[$name] = $item->type . $name;
        break;
    }
    $this->rows[$name]['data'] = array();
    $this->rows[$name]['class'] = !empty($item->disabled) ? 'ctools-export-ui-disabled' : 'ctools-export-ui-enabled';

    // If we have an admin title, make it the first row.
    if (!empty($this->plugin['export']['admin_title'])) {
      $this->rows[$name]['data'][] = array(
        'data' => check_plain($item->{$this->plugin['export']['admin_title']}),
        'class' => 'ctools-export-ui-title',
      );
    }
    $this->rows[$name]['data'][] = array(
      'data' => check_plain($name),
      'class' => 'ctools-export-ui-name',
    );
    $this->rows[$name]['data'][] = array(
      'data' => check_plain($item->width),
      'class' => 'ctools-export-ui-width',
    );
    $this->rows[$name]['data'][] = array(
      'data' => check_plain($item->height),
      'class' => 'ctools-export-ui-height',
    );
    $this->rows[$name]['data'][] = array(
      'data' => check_plain($item->type),
      'class' => 'ctools-export-ui-storage',
    );
    $this->rows[$name]['data'][] = array(
      'data' => theme('links', $operations),
      'class' => 'ctools-export-ui-operations',
    );

    // Add an automatic mouseover of the description if one exists.
    if (!empty($this->plugin['export']['admin_description'])) {
      $this->rows[$name]['title'] = $item->{$this->plugin['export']['admin_description']};
    }
  }

  /**
   * Provide the table header.
   */
  function list_table_header() {
    $header = array();
    if (!empty($this->plugin['export']['admin_title'])) {
      $header[] = array(
        'data' => t('Title'),
        'class' => 'ctools-export-ui-title',
      );
    }
    $header[] = array(
      'data' => t('Name'),
      'class' => 'ctools-export-ui-name',
    );
    $header[] = array(
      'data' => t('Width'),
      'class' => 'oembedcore-preset-width',
    );
    $header[] = array(
      'data' => t('Height'),
      'class' => 'oembedcore-preset-height',
    );
    $header[] = array(
      'data' => t('Storage'),
      'class' => 'ctools-export-ui-storage',
    );
    $header[] = array(
      'data' => t('Operations'),
      'class' => 'ctools-export-ui-operations',
    );
    return $header;
  }

}

Members

Name	Type	Description	Overrides
ctools_export_ui::$name	property
ctools_export_ui::$options	property
ctools_export_ui::$plugin	property
ctools_export_ui::access	function	Menu callback to determine if an operation is accessible.	1
ctools_export_ui::add_page	function
ctools_export_ui::clone_page	function	Main entry point to clone an item.
ctools_export_ui::delete_page	function	Page callback to delete an exportable item.
ctools_export_ui::disable_page	function	Callback to disable a page.
ctools_export_ui::edit_cache_clear	function	Clear the object cache for the currently edited item.
ctools_export_ui::edit_cache_get	function	Retrieve the item currently being edited from the object cache.
ctools_export_ui::edit_cache_get_key	function	Figure out what the cache key is for this object.
ctools_export_ui::edit_cache_set	function	Cache the item currently currently being edited.
ctools_export_ui::edit_cache_set_key	function
ctools_export_ui::edit_execute_form	function	Execute the form.
ctools_export_ui::edit_execute_form_standard	function	Execute the standard form for editing.
ctools_export_ui::edit_execute_form_wizard	function	Execute the wizard for editing.
ctools_export_ui::edit_finish_validate	function	Perform a final validation check before allowing the form to be finished.
ctools_export_ui::edit_form_import	function	Import form. Provides simple helptext instructions and textarea for pasting a export definition.
ctools_export_ui::edit_form_import_submit	function	Submit callback for import form.
ctools_export_ui::edit_form_import_validate	function	Import form validate handler.
ctools_export_ui::edit_form_validate	function	Validate callback for the edit form.
ctools_export_ui::edit_page	function	Main entry point to edit an item.
ctools_export_ui::edit_save_form	function	Called to save the final product from the edit form.
ctools_export_ui::edit_wizard_back	function	Wizard 'back' callback when using a wizard to edit an item.
ctools_export_ui::edit_wizard_cancel	function	Wizard 'cancel' callback when using a wizard to edit an item.
ctools_export_ui::edit_wizard_finish	function	Wizard 'cancel' callback when using a wizard to edit an item.	1
ctools_export_ui::edit_wizard_next	function	Wizard 'next' callback when using a wizard to edit an item.	1
ctools_export_ui::enable_page	function	Callback to enable a page.
ctools_export_ui::export_page	function	Page callback to display export information for an exportable item.
ctools_export_ui::get_page_title	function	Get a page title for the current page from our plugin strings.
ctools_export_ui::get_wizard_info	function	Get the form info for the wizard.	1
ctools_export_ui::help_area	function	Add text on the top of the page.
ctools_export_ui::hook_menu	function	hook_menu() entry point.
ctools_export_ui::import_page	function	Page callback to import information for an exportable item.
ctools_export_ui::init	function	Fake constructor -- this is easier to deal with than the real constructor because we are retaining PHP4 compatibility, which would require all child classes to implement their own constructor.	1
ctools_export_ui::list_css	function	Add listing CSS to the page.
ctools_export_ui::list_filter	function	Determine if a row should be filtered out.	2
ctools_export_ui::list_footer	function	Render a footer to go after thie list.
ctools_export_ui::list_form	function	Create the filter/sort form at the top of a list of exports.	2
ctools_export_ui::list_form_submit	function	Submit the filter/sort form.
ctools_export_ui::list_form_validate	function	Validate the filter/sort form.
ctools_export_ui::list_header	function	Render a header to go before the list.
ctools_export_ui::list_page	function	Master entry point for handling a list.
ctools_export_ui::list_render	function	Render all of the rows together.
ctools_export_ui::list_search_fields	function	Provide a list of fields to test against for the default "search" widget.	1
ctools_export_ui::set_item_state	function	Set an item's state to enabled or disabled and output to user.
oembed_preset_ui::edit_form	function	Provide the actual editing form. Overrides ctools_export_ui::edit_form
oembed_preset_ui::edit_form_submit	function	Handle the submission of the edit form. Overrides ctools_export_ui::edit_form_submit
oembed_preset_ui::list_build_row	function	Build a row based on the item. Overrides ctools_export_ui::list_build_row
oembed_preset_ui::list_sort_options	function	Provide a list of sort options. Overrides ctools_export_ui::list_sort_options
oembed_preset_ui::list_table_header	function	Provide the table header. Overrides ctools_export_ui::list_table_header

You are here

class oembed_preset_ui in oEmbed 6.0

Hierarchy

File

Members

API Navigation