[midcom.baseclasses] element index

Package indexes

All elements
c e g h i m n p r s _
_
top
Variable $_ais_class_suffix
midcom_baseclasses_components_interface::$_ais_class_suffix in interface.php
This is the class suffix used when constructing the AIS handler class.
Variable $_autoload_files
midcom_baseclasses_components_interface::$_autoload_files in interface.php
A list of files, relative to the components root directory, that should be loaded during initialization.
Variable $_autoload_libraries
midcom_baseclasses_components_interface::$_autoload_libraries in interface.php
A list of libraries which should by loaded during initialization.
Variable $_component
midcom_baseclasses_components_navigation::$_component in navigation.php
Internal helper, holds the name of the component. Should be used whenever the components' name is required instead of hardcoding it.
Variable $_component
midcom_baseclasses_components_request::$_component in request.php
Internal helper, holds the name of the component. Should be used whenever the components' name is required instead of hardcoding it.
Variable $_component
midcom_baseclasses_components_interface::$_component in interface.php
The name of the component, e.g. de.linkm.taviewer
Variable $_component
midcom_baseclasses_components_purecode::$_component in purecode.php
Internal helper, holds the name of the component. Should be used whenever the components' name is required instead of hardcoding it.
Variable $_component_data
midcom_baseclasses_components_request::$_component_data in request.php
Component data storage area.
Variable $_component_data
midcom_baseclasses_components_purecode::$_component_data in purecode.php
Component data storage area.
Variable $_component_data
midcom_baseclasses_components_navigation::$_component_data in navigation.php
Component data storage area.
Variable $_component_path
midcom_baseclasses_components_interface::$_component_path in interface.php
The full path to the components' root directory. Used for loading files.
Variable $_config
midcom_baseclasses_components_purecode::$_config in purecode.php
The current configuration.
Variable $_config
midcom_baseclasses_components_navigation::$_config in navigation.php
The current configuration.
Variable $_config
midcom_baseclasses_components_request::$_config in request.php
The current configuration.
Variable $_config_snippet_name
midcom_baseclasses_components_interface::$_config_snippet_name in interface.php
This is used during initialization when loading the default configurations
Variable $_context_data
midcom_baseclasses_components_interface::$_context_data in interface.php
This variable holds the context-specific data during processing.
Variable $_data
midcom_baseclasses_components_interface::$_data in interface.php
The component-specific data storage, hold in the global Array $midcom_component_data, which is indexed by the component name.
Variable $_handler
midcom_baseclasses_components_request::$_handler in request.php
This is a reference to the handler which declared to be able to handle the request. The array will contain the original index of the handler in the 'id' member for backtracking purposes. The variable argument list will be placed into 'args' for performance reasons.
Variable $_i18n
midcom_baseclasses_components_request::$_i18n in request.php
A handle to the i18n service.
Variable $_i18n
midcom_baseclasses_components_purecode::$_i18n in purecode.php
A handle to the i18n service.
Variable $_i18n
midcom_baseclasses_components_navigation::$_i18n in navigation.php
A handle to the i18n service.
Variable $_l10n
midcom_baseclasses_components_request::$_l10n in request.php
The components' L10n string database
Variable $_l10n
midcom_baseclasses_components_navigation::$_l10n in navigation.php
The components' L10n string database
Variable $_l10n
midcom_baseclasses_components_purecode::$_l10n in purecode.php
The components' L10n string database
Variable $_l10n_midcom
midcom_baseclasses_components_purecode::$_l10n_midcom in purecode.php
The global MidCOM string database
Variable $_l10n_midcom
midcom_baseclasses_components_navigation::$_l10n_midcom in navigation.php
The global MidCOM string database
Variable $_l10n_midcom
midcom_baseclasses_components_request::$_l10n_midcom in request.php
The global MidCOM string database
Variable $_local_toolbar
midcom_baseclasses_components_request_admin::$_local_toolbar in request_admin.php
The toolbar local to the current request
Variable $_meta_toolbar
midcom_baseclasses_components_request_admin::$_meta_toolbar in request_admin.php
The Metadata toolbar. You should normally have no need to modify it.
Variable $_nap_class_suffix
midcom_baseclasses_components_interface::$_nap_class_suffix in interface.php
This is the class suffix used when constructing the NAP handler class.
Variable $_nap_instance
midcom_baseclasses_components_interface::$_nap_instance in interface.php
The NAP interface instance from the component, initialized on demand.
Variable $_purecode
midcom_baseclasses_components_interface::$_purecode in interface.php
Set this to true for pure-code components.
Variable $_request_data
midcom_baseclasses_components_request::$_request_data in request.php
Request specific data storage area. Registered in the component context as ''.
Variable $_request_switch
midcom_baseclasses_components_request::$_request_switch in request.php
Request execution switch configuration.
Variable $_site_class_suffix
midcom_baseclasses_components_interface::$_site_class_suffix in interface.php
This is the class suffix used when constructing the on-site handler class.
Variable $_topic
midcom_baseclasses_components_navigation::$_topic in navigation.php
The topic for which we are handling a requiest.
Variable $_topic
midcom_baseclasses_components_request::$_topic in request.php
The topic for which we are handling a requiest.
Variable $_topic_toolbar
midcom_baseclasses_components_request_admin::$_topic_toolbar in request_admin.php
The toolbar of the topic.
Variable $_version
midcom_baseclasses_components_interface::$_version in interface.php
The internal version number of the interface. This value is currently unused in MidCOM context and may be deprecated in the future.
Method _check_nap_instance
midcom_baseclasses_components_interface::_check_nap_instance() in interface.php
Checks, wether an instance of the NAP interface class has already been created and creates it if not.
Method _handler_config_dm
midcom_baseclasses_components_request_admin::_handler_config_dm() in request_admin.php
Datamanager configuration handler interface.
Method _handler_config_dm_prepare
midcom_baseclasses_components_request_admin::_handler_config_dm_prepare() in request_admin.php
Helper function that prepares a datamanager instance for the config_dm handler.
Method _load_configuration
midcom_baseclasses_components_interface::_load_configuration() in interface.php
Loads the configuration file specified by the component configuration
Method _load_schema_database
no_odindata_quickform_admin::_load_schema_database() in admin.php
Internal helper, loads the configured schema database into the class.
Method _on_check_document_permissions
midcom_baseclasses_components_interface::_on_check_document_permissions() in interface.php
Verif an indexer document's permissions. This is used for custom, advanced access control within a components domain.
Method _on_get_metadata
midcom_baseclasses_components_request::_on_get_metadata() in request.php
Returns a metadata object for the currently selected object, or null if no Metadata is available. The default implementation defaults to the topics' metadata object.
Method _on_handle
midcom_baseclasses_components_request::_on_handle() in request.php
Component specific initialization code for the handle phase. AIS, for example, uses this to preapre the toolbar arrays. The name of the request handler is passed as an argumet to the event handler.
Method _on_handler_config_dm_prepared
midcom_baseclasses_components_request_admin::_on_handler_config_dm_prepared() in request_admin.php
Event handler, called after the configuration datamanager instance has been created but not yet initialized. Use this hook to modify the schema where neccessary.
Method _on_handler_config_dm_preparing
midcom_baseclasses_components_request_admin::_on_handler_config_dm_preparing() in request_admin.php
Event handler, called before the configuration datamanger is created. Use this to prepare anything that is required to start up the Datamanager.
Method _on_handler_config_dm_saved
midcom_baseclasses_components_request_admin::_on_handler_config_dm_saved() in request_admin.php
Event handler, called when the configuration system has successfully stored new configuration settings.
Method _on_initialize
no_odindata_quickform_admin::_on_initialize() in admin.php
Method _on_initialize
midcom_baseclasses_components_request::_on_initialize() in request.php
Initialization event handler, called at the end of the initialization process immediately before the request handler configuration is read.
Method _on_initialize
midcom_baseclasses_components_interface::_on_initialize() in interface.php
This is an event handler, called after the basic component initialization has been done just before the initialize call will return to MidCOM.
Method _on_reindex
midcom_baseclasses_components_interface::_on_reindex() in interface.php
Reindex the given topic. The complete configuration set is already available in $config. The original index records are already deleted, so you do not need to bother about this.
Method _on_set_object
midcom_baseclasses_components_navigation::_on_set_object() in navigation.php
Event handler called after a new topic has been set. The configuration is already loaded at this point.
Method _on_show
midcom_baseclasses_components_request::_on_show() in request.php
Generic output initialization code. The return value lets you control wether the output method accociated with the handler declaration is called, return false to override this automatism, true, the default, will call the output handler normally.
Method _prepare_handler
midcom_baseclasses_components_request::_prepare_handler() in request.php
Helper function, which prepares the handler callback for execution.
Method _prepare_request_switch
midcom_baseclasses_components_request::_prepare_request_switch() in request.php
This private helper post-processes the initial information as set by the constructor.
Method _prepare_topic_toolbar
no_odindata_quickform_admin::_prepare_topic_toolbar() in admin.php
This function adds all of the standard items (configuration and create links) to the topic toolbar.
Method _show_config_dm
midcom_baseclasses_components_request_admin::_show_config_dm() in request_admin.php
Simple display handler for the config_dm handler, it uses the MidCOM L10n string 'component configuration' as heading, and immediately displays the form afterwards.
c
top
Method can_handle
midcom_baseclasses_components_interface::can_handle() in interface.php
Relays the can_handle call to the component, instantinating a new AIS or Site class respecitvly. It will execute can_handle of that class, retruning its result to MidCOM.
Method can_handle
midcom_baseclasses_components_request::can_handle() in request.php
CAN_HANDLE Phase interface, checks against all registered handlers if a vaild one can be found. You should not need to override this, instead, use the HANDLE Phase for further checks.
Method check_document_permissions
midcom_baseclasses_components_interface::check_document_permissions() in interface.php
Verif an indexer document's permissions.
Method configure
midcom_baseclasses_components_interface::configure() in interface.php
Configures the component for usage. The configuration is merged, and, if neccessary, an existing handler object is purged.
e
top
Variable $errcode
midcom_baseclasses_components_request::$errcode in request.php
The last error code of the component. Set this when the request handling fails.
Variable $errstr
midcom_baseclasses_components_request::$errstr in request.php
The last error message of the component. Set this when the request handling fails.
Method errcode
midcom_baseclasses_components_interface::errcode() in interface.php
Returns the last error code of the component.
Method errstr
midcom_baseclasses_components_interface::errstr() in interface.php
Returns the last error message of the component.
g
top
Method get_current_leaf
midcom_baseclasses_components_interface::get_current_leaf() in interface.php
Returns the currently selected leaf of the request.
Method get_leaves
midcom_baseclasses_components_navigation::get_leaves() in navigation.php
Leaf listing function, the default implementation returns an empty array indicating no leaves. Note, that the active leaf index set by the other parts of the component must match one leav out of this list.
Method get_leaves
no_odindata_quickform_navigation::get_leaves() in navigation.php
Method get_leaves
midcom_baseclasses_components_interface::get_leaves() in interface.php
Relays the get_leaves call to the NAP instance.
Method get_metadata
midcom_baseclasses_components_request::get_metadata() in request.php
Returns the metadata of the currently selected object. It uses a callback to determine a metadata object which contains the neccessary information.
Method get_metadata
no_odindata_quickform_admin::get_metadata() in admin.php
Method get_node
midcom_baseclasses_components_navigation::get_node() in navigation.php
Return the node configuration. This defaults to use the topic the NAP instance has been set to directly. You can usually fall back to this behavoir safely, adding a toolbar using the $toolbar parameter in child classes.
Method get_node
no_odindata_quickform_navigation::get_node() in navigation.php
Method get_node
midcom_baseclasses_components_interface::get_node() in interface.php
Relays the get_node call to the NAP instance.
h
top
Method handle
midcom_baseclasses_components_request::handle() in request.php
This method handles the request using the handler determined by the can_handle check.
Method handle
midcom_baseclasses_components_interface::handle() in interface.php
Relays the handle call to the component.
i
top
Method initialize
midcom_baseclasses_components_request::initialize() in request.php
Initializes the request handler class, called by the component interface after instantination. Required to allow safe $this references during startup.
Method initialize
midcom_baseclasses_components_interface::initialize() in interface.php
Initializes the component. It will first load all dependent libraries and then include the snippets referenced by the component. The components local data storage area is initialized and referenced into the global storage area.
Method initialize
midcom_baseclasses_components_navigation::initialize() in navigation.php
Initialize the NAP class, sets all state variables.
Method is_internal
midcom_baseclasses_components_interface::is_internal() in interface.php
Relays the is_internal check for the current object.
Page interface.php
interface.php in interface.php
m
top
Class midcom_baseclasses_components_interface
midcom_baseclasses_components_interface in interface.php
Baseclass to use for the component interface in MIDCOM.
Method midcom_baseclasses_components_interface
midcom_baseclasses_components_interface::midcom_baseclasses_components_interface() in interface.php
Initialize the class, nothing to do yet.
Method midcom_baseclasses_components_navigation
midcom_baseclasses_components_navigation::midcom_baseclasses_components_navigation() in navigation.php
Create the navigation instance, the constructor doesn't do anything yet, startup is handled by initialize().
Class midcom_baseclasses_components_navigation
midcom_baseclasses_components_navigation in navigation.php
Base class to encaspulate a NAP interface. Does all the neccessary work for setting the object to the right topic. you just have to fill the gaps for getting the leaves and node data.
Method midcom_baseclasses_components_purecode
midcom_baseclasses_components_purecode::midcom_baseclasses_components_purecode() in purecode.php
Initialize all member variables, remember to set $_component before calling this constructor from your derived classes.
Class midcom_baseclasses_components_purecode
midcom_baseclasses_components_purecode in purecode.php
Base class used for writing pure code components, retrieves a few common variables from the components current environment.
Class midcom_baseclasses_components_request
midcom_baseclasses_components_request in request.php
Base class to encaspulate a request to the component, instantinated by the MidCOM component interface.
Method midcom_baseclasses_components_request
midcom_baseclasses_components_request::midcom_baseclasses_components_request() in request.php
Initializes the class, only basic variable assignement. Your own constructor should call this function first.
Method midcom_baseclasses_components_request_admin
midcom_baseclasses_components_request_admin::midcom_baseclasses_components_request_admin() in request_admin.php
Initialize the toolbar references after constructing the base class.
Class midcom_baseclasses_components_request_admin
midcom_baseclasses_components_request_admin in request_admin.php
Base class to encaspulate a admin request to the component, instantinated by the MidCOM component interface.
n
top
Page navigation.php
navigation.php in navigation.php
Class no_odindata_quickform_admin
no_odindata_quickform_admin in admin.php
Base class to encaspulate a admin request to the component, instantinated by the MidCOM component interface.
Method no_odindata_quickform_admin
no_odindata_quickform_admin::no_odindata_quickform_admin() in admin.php
Class no_odindata_quickform_navigation
no_odindata_quickform_navigation in navigation.php
Base class to encaspulate a NAP interface. Does all the neccessary work for setting the object to the right topic. you just have to fill the gaps for getting the leaves and node data.
Method no_odindata_quickform_navigation
no_odindata_quickform_navigation::no_odindata_quickform_navigation() in navigation.php
p
top
Page purecode.php
purecode.php in purecode.php
Method properties
midcom_baseclasses_components_interface::properties() in interface.php
Returns the component properties. This is built from the configured member variables. The name is taken out of the components' L10n library, using the component name as l10n string id.
r
top
Page request_admin.php
request_admin.php in request_admin.php
Page request.php
request.php in request.php
Method read_array_from_file
midcom_baseclasses_components_interface::read_array_from_file() in interface.php
This helper function reads a file from disk and evaluates its content as array.
Method read_array_from_snippet
midcom_baseclasses_components_interface::read_array_from_snippet() in interface.php
This helper function reads a snippet and evaluates its content as array.
Method reindex
midcom_baseclasses_components_interface::reindex() in interface.php
This new interface function will initiate a reindex run for the given component and topic. See the _on_reindex() event handler for details.
s
top
Method set_object
midcom_baseclasses_components_navigation::set_object() in navigation.php
Set a new content object. This updates the local configuration copy with the topic in question. It calls the event handler _on_set_object after initializing everything in case you need to do some custom initializations as well.
Method set_object
midcom_baseclasses_components_interface::set_object() in interface.php
Releays the set_object call to the nap instance. Checks if the NAP instance has already been created beforehand.
Method show
midcom_baseclasses_components_request::show() in request.php
Display the content, it uses the handler as determined by can_handle.
Method show_content
midcom_baseclasses_components_interface::show_content() in interface.php
Relays the show content call to the component, invoking output.
c e g h i m n p r s _