PHPXRef 0.7 : Drupal 6 (yi-drupal) : Detail view of ctools_export

Base class for export UI.

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.

get_page_title($op, $item = NULL) X-Ref

Get a page title for the current page from our plugin strings.

help_area($form_state) X-Ref

Add text on the top of the page.

hook_menu(&$items) X-Ref

hook_menu() entry point.

Child implementations that need to add or modify menu items should
probably call parent::hook_menu($items) and then modify as needed.

access($op, $item) X-Ref

Menu callback to determine if an operation is accessible.

This function enforces a basic access check on the configured perm
string, and then additional checks as needed.

param: $op
param: $item
return:

list_page($js, $input) X-Ref

Master entry point for handling a list.

It is unlikely that a child object will need to override this method,
unless the listing mechanism is going to be highly specialized.

list_form(&$form, &$form_state) X-Ref

Create the filter/sort form at the top of a list of exports.

This handles the very default conditions, and most lists are expected
to override this and call through to parent::list_form() in order to
get the base form and then modify it as necessary to add search
gadgets for custom fields.

list_form_validate(&$form, &$form_state) X-Ref

Validate the filter/sort form.

It is very rare that a filter form needs validation, but if it is
needed, override this.

list_form_submit(&$form, &$form_state) X-Ref

Submit the filter/sort form.

This submit handler is actually responsible for building up all of the
rows that will later be rendered, since it is doing the filtering and
sorting.

For the most part, you should not need to override this method, as the
fiddly bits call through to other functions.

list_filter($form_state, $item) X-Ref

Determine if a row should be filtered out.

This handles the default filters for the export UI list form. If you
added additional filters in list_form() then this is where you should
handle them.

return:

list_search_fields() X-Ref

Provide a list of fields to test against for the default "search" widget.

This widget will search against whatever fields are configured here. By
default it will attempt to search against the name, title and description fields.

list_sort_options() X-Ref

Provide a list of sort options.

Override this if you wish to provide more or change how these work.
The actual handling of the sorting will happen in build_row().

list_css() X-Ref

Add listing CSS to the page.

Override this if you need custom CSS for your list.

list_build_row($item, &$form_state, $operations) X-Ref

Build a row based on the item.

By default all of the rows are placed into a table by the render
method, so this is building up a row suitable for theme('table').
This doesn't have to be true if you override both.

list_table_header() X-Ref

Provide the table header.

If you've added columns via list_build_row() but are still using a
table, override this method to set up the table header.

list_render(&$form_state) X-Ref

Render all of the rows together.

By default we place all of the rows in a table, and this should be the
way most lists will go.

Whatever you do if this method is overridden, the ID is important for AJAX
so be sure it exists.

list_header($form_state) X-Ref

Render a header to go before the list.

This will appear after the filter/sort widgets.

list_footer($form_state) X-Ref

Render a footer to go after thie list.

This is a good place to add additional links.

add_page($js, $input, $step = NULL) X-Ref

No description

edit_page($js, $input, $item, $step = NULL) X-Ref

Main entry point to edit an item.

clone_page($js, $input, $original, $step = NULL) X-Ref

Main entry point to clone an item.

edit_execute_form(&$form_state) X-Ref

Execute the form.

Add and Edit both funnel into this, but they have a few different
settings.

edit_execute_form_standard(&$form_state) X-Ref

Execute the standard form for editing.

By default, export UI will provide a single form for editing an object.

get_wizard_info(&$form_state) X-Ref

Get the form info for the wizard.

This gets the form info out of the plugin, then adds defaults based on
how we want edit forms to work.

Overriding this can allow child UIs to tweak this info for specialized
wizards.

param: array $form_state

edit_execute_form_wizard(&$form_state) X-Ref

Execute the wizard for editing.

For complex objects, sometimes a wizard is needed. This is normally
activated by setting 'use wizard' => TRUE in the plugin definition
and then creating a 'form info' array to feed the wizard the data
it needs.

When creating this wizard, the plugin is responsible for defining all forms
that will be utilized with the wizard.

Using 'add order' or 'edit order' can be used to ensure that add/edit order
is different.

edit_wizard_back(&$form_state) X-Ref

Wizard 'back' callback when using a wizard to edit an item.

The wizard callback delegates this back to the object.

edit_wizard_next(&$form_state) X-Ref

Wizard 'next' callback when using a wizard to edit an item.

The wizard callback delegates this back to the object.

edit_wizard_cancel(&$form_state) X-Ref

Wizard 'cancel' callback when using a wizard to edit an item.

The wizard callback delegates this back to the object.

edit_wizard_finish(&$form_state) X-Ref

Wizard 'cancel' callback when using a wizard to edit an item.

The wizard callback delegates this back to the object.

edit_cache_get($item, $op = 'edit') X-Ref

Retrieve the item currently being edited from the object cache.

edit_cache_set($item, $op = 'edit') X-Ref

Cache the item currently currently being edited.

edit_cache_set_key($item, $name) X-Ref

No description

edit_cache_clear($item, $op = 'edit') X-Ref

Clear the object cache for the currently edited item.

edit_cache_get_key($item, $op) X-Ref

Figure out what the cache key is for this object.

edit_save_form($form_state) X-Ref

Called to save the final product from the edit form.

edit_form(&$form, &$form_state) X-Ref

Provide the actual editing form.

edit_form_validate(&$form, &$form_state) X-Ref

Validate callback for the edit form.

edit_finish_validate(&$form, &$form_state) X-Ref

Perform a final validation check before allowing the form to be
finished.

edit_form_submit(&$form, &$form_state) X-Ref

Handle the submission of the edit form.

At this point, submission is successful. Our only responsibility is
to copy anything out of values onto the item that we are able to edit.

If the keys all match up to the schema, this method will not need to be
overridden.

enable_page($js, $input, $item) X-Ref

Callback to enable a page.

disable_page($js, $input, $item) X-Ref

Callback to disable a page.

set_item_state($state, $js, $input, $item) X-Ref

Set an item's state to enabled or disabled and output to user.

If javascript is in use, this will rebuild the list and send that back
as though the filter form had been executed.

delete_page($js, $input, $item) X-Ref

Page callback to delete an exportable item.

export_page($js, $input, $item) X-Ref

Page callback to display export information for an exportable item.

import_page($js, $input, $step = NULL) X-Ref

Page callback to import information for an exportable item.

edit_form_import(&$form, &$form_state) X-Ref

Import form. Provides simple helptext instructions and textarea for
pasting a export definition.

edit_form_import_validate($form, &$form_state) X-Ref

Import form validate handler.

Evaluates code and make sure it creates an object before we continue.

edit_form_import_submit($form, &$form_state) X-Ref

Submit callback for import form.

Stores the item in the session.