EnsEMBL::Web::Interface

Location: /modules/EnsEMBL/Web/Interface.pm
Source code · Permalink
No superclasses
No subclasses

Overview

Module for auto-creating a database interface. Methods are provided which allow the user to configure the behaviour of the interface, without having to worry about individual form elements

Accessor

Method

Unknown

  • BUILD
  • create_select_values
  • format_date
  • modify_element
  • named_element
  • relational_element
Documentation coverage: 80 %

Methods

    caption
    Accessor. Optional configuration of captionsReturns: hash - keys should correspond to built-in interface methods, e.g. 'add', 'edit'
    View source

    cgi_populate
    Utility function to populate a data object from CGI parameters instead of from the database
    View source

    configure
    Determines which interface component/command is required by this step
    View source

    data
    Accessor. Returns: An Object::Data::[record or table name] object
    View source

    discover
    Autogenerate elements based on data structure N.B. this sets up some default values that can be customised later
    View source

    dropdown
    Accessor. Flag to set whether the interface uses a dropdown box for selecting records, or radio buttons/checkboxesReturns: boolean
    View source

    edit_fields
    Returns editable fields as form element parameters
    View source

    element
    Accessor.
    View source

    element_order
    Accessor. Determines the order in which elements are displayed on the formReturns: array
    View source

    elements
    Accessor. Returns: hashref whose values are E::W::Interface::Element objects
    View source

    extra_data
    Accessor.
    View source

    history_fields
    Returns a set of standard non-editable fields used to track record modification
    View source

    honeypots
    Identifies fields of type Honeypot and returns an arrayref of names
    View source

    no_preview
    Accessor. Flag to control whether interface offers record preview
    View source

    option_columns
    Accessor. Determines the database columns used to assemble the record labels on the 'Select a Record' pageReturns: array
    View source

    option_order
    Accessor. Determines the order in which records are displayed on the dropdown listReturns: arrayref
    View source

    pass_fields
    Returns editable fields as hidden element parameters
    View source

    permit_delete
    Accessor. Flag to control whether user is allowed to delete records
    View source

    preview_fields
    Returns fields as non-editable text
    View source

    record_filter
    Accessor. Field(s) and value(s) on which to filter editable recordsReturns: hash
    View source

    record_list
    Accessor. Returns: array of data objects of the same type as the parent
    View source

    repeat
    Accessor. Field used to add several identical records with different foreign key values (used in healthchecks for rapid annotation)Returns: string
    View source

    script_name
    Accessor.
    View source

    show_history
    Accessor. Flag to control whether creation and modification details are shownReturns: boolean - 1 if set, 0 if set to n/no (case-insensitive) or if not set
    View source


← Home · Source code