-
$_branche
-
The category we are currently displaying.
-
$_branche
-
The category we are currently adding to.
-
$_branche
-
The category we're working with, if applicable.
-
$_category
-
The base category we should use for listing. This must be set, or startup will fail.
-
$_category_list
-
This is an array holding the computed category list.
-
$_category_list
-
This is an array holding the computed category list.
-
$_config
-
Search handler configuration. Taken from the type_config, may be null if you don't use it or the user doesn't set it explicitly. The type depends on the type set in the type_config.
-
$_controller
-
The controller instance used to render the various forms.
-
$_controller
-
The DM2 controller instance we use for Editing etc.
-
$_customsearch
-
The handler class responsible for the custom search forms.
-
$_customsearch
-
The handler class responsible for the custom search forms.
-
$_entries
-
The list of entries found.
-
$_entry
-
The entry currently being displayed.
-
$_entry
-
The entry created by the DM2 creation controller callback.
-
$_entry_controller
-
The controller used when editing entries.
-
$_entry_dm
-
A DM created on the current entry.
-
$_filter
-
The string filter used to narrow down the top-level category listing, usually used for alphabetical queries. It is used in the form of a SQL LIKE query.
-
$_handler
-
The handler class that is calling us.
-
$_last_page
-
The last valid page, a one-based index number.
-
$_list_url_base
-
The base URL used within the list handlers' paging code. Cached for better code readability mainly. This is a full prefix replacing MIDCOM_CONTEXT_ANCHORPREFIX.
-
$_page
-
The currently displayed page number, a one-based index number.
-
$_processing_msg
-
The processing message for the image upload tool.
-
$_remote
-
net.nehmer.account Remote management interface class instance.
-
$_schemamgr
-
The schema manager class encaspulating all schema operations referencing account schemas.
-
$_schemamgr
-
The schema manager class encaspulating all schema operations referencing account schemas.
-
$_topic
-
The topic we are working on.
-
$_total
-
The total number of results.
-
$_type
-
The category record encaspulating the root (type) category.
-
$_type
-
The DB type we're working together with.
-
$_type
-
The category record encaspulating the root (type) category.
-
$_type
-
The category record encaspulating the root (type) category.
-
$_type
-
The type we are querying.
-
_add_category_to_list
-
This is a helper which adds the specfied catgory to the _category_list. It computes all members that could be helpful for display.
-
_add_category_to_list
-
This is a helper which adds the specfied catgory to the _category_list. It computes all members that could be helpful for display.
-
_check_account_topic
-
This function checks and, if neccessary, auto-populates the account_topic setting.
-
_check_root_branchen
-
This function loads the account management interface class to determine the account types and check wether we have all required root categories.
-
_copy_controller_data_to_session
-
This internal helper function will put the storage representaiton of all information currently in place in the controller into an session based array. This can be used later using the _get_data_defaults_from_session to start up a null controller again.
-
_create_branche
-
Little helper which creates a new branche under the currently loaded one.
-
_get_details_defaults_from_account
-
Little helper which retrieves the defaults for new entries from the account record, and force-sets the category member accordingly.
-
_get_object_for_guid
-
Internal helper function incorporating a static caching infrastructure for the loaded objects. Used to prevent multiple loaders of the same object, which can slow down the system considerably on large category lists.
-
_handler_categoryselect
-
Shows a welcome page before the actual account setup. Useful to display help messages and the like.
-
_handler_confirm
-
This is the confirm step. It will show the entire entry again, and the user has to acknowledge it.
-
_handler_create
-
Handles category creation. Prepares a controller for usage and creates the actual object.
-
_handler_customsearch
-
Loads the custom search plugin for the selected type. It either displays the search form or processes the search form (which relocates to the entries list).
-
_handler_delete
-
Handles category deletion, no safety interlocks at this point.
-
_handler_delete
-
Deletes an entry.
-
_handler_details
-
This is step three of the adding procedure. It will generate a form based on the schema accociated with the user account linked to the category set. The data entered will be put into the session storage area, so that no temporary object is needed at this point.
-
_handler_edit
-
Handles category editing. Prepares a controller for usage.
-
_handler_edit
-
This call allows you to edit an entry. Only applicable for entries you've write privileges on.
-
_handler_entry
-
Shows an entry.
-
_handler_list
-
The listing handler provides you with a full list of all categories currently in the system for maintainance. The preparation phase is minimal, as most code lies in the recursive loading code in the style.
-
_handler_list
-
This is the basic list handler which provides you with a flat, full listing of all categories. As outlined in the components' main interface class, this code is optimized for a two level hierachy below the root category both to ease implementation and to keep up the performance.
-
_handler_list
-
This is the basic list handler which provides you with a flat, full listing of all categories. As outlined in the components' main interface class, this code is optimized for a two level hierachy below the root category both to ease implementation and to keep up the performance.
-
_handler_list_alpha
-
This is the basic list handler which provides you with a flat, full listing of all categories filtered by a letter from the alphabet.
-
_handler_list_compute_urls
-
Computes the paging and return URLs for the List handler. This is dependant from the currently active handler, which decides where to return to.
-
_handler_list_init_from_branche
-
Initializes the list handler from a category. Calls generate_error an any problem.
-
_handler_list_init_from_customsearch
-
Initializes the list handler for custom searching.
-
_handler_list_load_searchhandler
-
Creates and returns an instance of the custom search handler.
-
_handler_list_self
-
This list handler shows all entries currently accociated to the active user.
-
_handler_list_validate_page_number
-
Checks the selected page number against the boundaries of the total resulste.
-
_handler_thanks
-
Shows a all-ok page.
-
_handler_welcome
-
The welcome handler sets various configuration options if required, so that the component startup is valid from that time on. It will bail with an Error if no admin level user is logged in if anything needs to be done.
-
_handler_welcome
-
Shows a welcome page before the actual account setup. Useful to display help messages and the like.
-
_handler_welcome
-
Welcome page handler, redirects to a root category along the following priorities:
-
_index
-
Internal Helper encaspulating the index call.
-
_index
-
Internal Helper encaspulating the index call.
-
_load_account_remote
-
Helper function called during startup when a handler requires a n.n.account remote control interface. It builds on the schemamgr helper class.
-
_load_searchhandler
-
Creates and returns an instance of the custom search handler.
-
_on_check_document_permissions
-
Checks the index documents' permission using the unindexed _anonymous_read field accociated with the document.
-
_on_created
-
Temporary helper to create a last-modified timestamp and the cached branchen entry counts.
-
_on_deleted
-
Helper to update the cached branchen entry counts.
-
_on_handle
-
General request initialization, which populates the topic toolbar.
-
_on_initialize
-
-
_on_initialize
-
-
_on_initialize
-
Event handler, called after class startup. Errors should trigger generate_error.
-
_on_reindex
-
Iterate over all entries and create an index record using the datamanger2 indexer method. We reuse the same DM2 instance. We use the set branchen to limit the number of objects we look at simultaneously.
-
_on_resolve_permalink
-
Resolves the permalink if the 'indexed' option is set. Supports categories/types, branchen and entries.
-
_on_updated
-
Temporary helper to create a last-modified timestamp and the cached branchen entry counts.
-
_on_watched_dba_delete
-
The delete handler will drop all entries accociated with any person record that has been deleted. We don't need to check for watched classes at this time, since we have no other watches defined.
-
_prepare_confirm_schemadb
-
This helper prepares and returns the schema that should be used to edit the entry to-be-submitted. It will tweak a few settings which differ from the account management tool.
-
_prepare_controller
-
Prepares a nullstorage controller used to manage the entry details. The defaults to use have to be passed to the controller instance, as they can come either from the active session or the currently active account, depending on the registration step.
-
_prepare_details_schemadb
-
This helper prepares and returns the schema that should be used to edit the entry to-be-submitted. It will tweak a few settings which differ from the account management tool.
-
_prepare_entry_controller
-
Prepares a DM2 controller instance useable to edit existing entries.
-
_prepare_entry_dm
-
Prepares an entry datamanager, based off the type we're currently viewing.
-
_prepare_request_data
-
Simple helper which references all important members to the request data listing for usage within the style listing.
-
_prepare_request_data
-
Simple helper which references all important members to the request data listing for usage within the style listing.
-
_prepare_request_data
-
Simple helper which references all important members to the request data listing for usage within the style listing.
-
_prepare_topic_toolbar
-
This function adds all of the standard items (configuration and create links) to the topic toolbar.
-
_preprocess_account_schema
-
This function preprocesses the account schema for the requirements of this component.
-
_process_confirm_form
-
This function processes the details form, and redirects accordingly either to the next/previous step or cancels the entry registration entirely. When moving on to the next step, the submitted data is kept in the session, along with all neccessary controlling information.
-
_process_created_entry
-
This helper processes the entry saved during the DM2 process_form operation.
-
_process_default_mapping
-
Uses the field_mapping config option to rename all field defaults which are unknown in the currently selected schema. No further checks on validity of the replacement names are done.
-
_process_details_form
-
This function processes the details form, and redirects accordingly either to the next/previous step or cancels the entry registration entirely. When moving on to the next step, the submitted data is kept in the session, along with all neccessary controlling information.
-
_process_entry_controller
-
Processes the entry controller form results, this will redirect on form submissions.
-
_show_categoryselect
-
Shows the welcome page
-
_show_confirm
-
Renders the confirm entry page.
-
_show_create
-
Shows the category editor.
-
_show_customsearch
-
Displays the custom search form.
-
_show_delete
-
Shows the delete confirmation.
-
_show_details
-
Renders the details entry form.
-
_show_edit
-
Shows the entry edit form.
-
_show_edit
-
Shows the category editor.
-
_show_entry
-
Shows an entry.
-
_show_list
-
Shows all loaded groups.
-
_show_list
-
Shows all loaded groups, it uses a set of recursivly called functions for this.
-
_show_list
-
Shows all entries in the category.
-
_show_list_alpha
-
Shows all loaded groups.
-
_show_list_category
-
This function renders the actual category with all its required links.
-
_show_list_self
-
Shows all list of all entries owned by the current user.
-
_show_list_sublist
-
This shows the sublisting of a given category, if no guid is passed, the root categories are listed. A separate function is called to display each category individually, which can in turn invoke this function to render the sublisting.
-
_show_thanks
-
Shows a all-ok page.
-
_show_welcome
-
Simple show welcome handler, shows the current processing message.
-
_show_welcome
-
Shows the welcome page
-
_update_branchen_count
-
Triggers the item count update of the branchen entry.
-
_update_breadcrumb_line
-
Helper, updates the context so that we get a complete breadcrum line towards the current location.
-
get_account_schema
-
This function returns a schema class instance matching the user passed to the method. It defaults to the currently active user.
-
get_branche
-
Returns the category of this entry. A new object is created. If the object fails to create, false/null is returned.
-
get_class_magic_default_privileges
-
DBA magic defaults which assign listing porivileges to all authenticated users.
-
get_full_name
-
This helper constructs the full name of the component, in case you don't want to worry about climbing the tree yourself. Note, that there is at least one DB interaction required for this operation, so if you already know the name in your app, try to avoid this call.
-
get_leaves
-
-
get_list_childs_qb
-
Returns a QB which is prepared to list all childs of the object using default sorting.
-
get_list_entries_qb
-
This function will return a QB suitable for listing entries, without any sort order applied.
-
get_live_entry_count
-
This function detects the real entry count for the current category, not the cached one used in the category listings.
-
get_local_element_count
-
Returns the number of elements assigned to the current category, the check lists all elements, regardless of ACL for performance reasons.
-
get_name_for_key
-
-
get_next
-
Returns the next entry after the given one. Used for view-mode paging.
-
get_next
-
Gets the next logical entry in the current category within the alphabetical sort order.
-
get_parent_branche
-
Returns the parent branche, if applicable. A new object is created.
-
get_parent_guid_uncached
-
Links to the uplink parent, which can be null.
-
get_parent_guid_uncached
-
Links to the uplink parent, which can be null.
-
get_previous
-
Gets the previous logical entry in the current category within the alphabetical sort order.
-
get_previous
-
Returns the previous entry after the given one. Used for view-mode paging.
-
get_revised
-
Temporary helper to return a last-modified timestamp.
-
get_root_category
-
This helper function returns the root category accociated with this instance. This is a copy of ourselves in case that we already look at a root cateogry. The lookup is done using the type field.
-
get_root_category_by_type
-
This helper function returns the root category identified by a given account type name. DB inconsistencies will trigger generate_error.
-
get_root_category_url
-
Constructs a relative URL to display a given category based on its configuration settings. This lets you define via configuration wether you want the full listing or the first alphabet letter listing automatically.
-
get_select_list_for_type
-
This static function returns a full select list for all categories in the selected type. It tries to minimize the number of select calls for efficiency reasons.
-
get_total
-
This call returns the total number of hits matching the current query. It is suggested that unchecked QB queries are run, as usual.
-
get_type_config
-
Little helper function, gets the configuratio of a given type regarding alterations to the schema and display defaults.