[midcom.helper.datamanager2] element index

Package indexes

All elements
a b c d e f g h i j k l m n o p r s t u v w _
_
top
Variable $_all_elements
All elements in the select list. saved for performance reasons.
Variable $_attachment_map
This array maps attachment identifiers to image identifier/derived image name pairs.
Variable $_callback
In case the options are returned by a callback, this member holds the callback instance.
Variable $_callback
Optional callback that will be used if the storage variant "callback" has been called.
Variable $_callback
In case the options are returned by a callback, this member holds the callback instance.
Variable $_config
Configuration as passed from the callback.
Variable $_controllers
Array of Datamanager 2 controllers for child object display and management
Variable $_creation_controllers
Array of Datamanager 2 controllers for child object creation
Variable $_currentGroupName
The current group running
Variable $_currentGroups
The stack of groups
Variable $_currentGroupTemplates
All group templates for running groups (i.e. prepared and ready).
Variable $_current_tmpname
The current working file.
Variable $_current_tmpname
The current working file.
Variable $_defaults
The defaults to use when loading the data from the "artificial" storage.
Variable $_editable
Variable $_element
The input textbox used which needs to be frozen when operating on the captcha.
Variable $_elements
The QF Element list added to the form. Saved for freezing/unfreezing.
Variable $_elements
The list of elements added to the widget, indexed by their element name.
Variable $_elements
The list of elements added to the widget, indexed by their element name.
Variable $_elementTemplate
Element template string
Variable $_exitcode
Latest exit code
Variable $_external_config
This variable contains configuration data which is not directly related to the operation of the type, but required for the operation of external tools like the storage manager. The type should never touch this variable, which is controlled by a corresponding getter/setter pair.
Variable $_external_config
This variable contains configuration data which is not directly related to the operation of the type, but required for the operation of external tools like the storage manager. The type should never touch this variable, which is controlled by a corresponding getter/setter pair.
Variable $_field
A reference to the schema field we should draw. Description texts etc. are taken from here.
Variable $_fieldname
The name of the schema field we are currently processing.
Variable $_filename
The original filename of the uploaded file.
Variable $_filename
The original filename of the uploaded file.
Variable $_filter
The image-filter instance to use.
Variable $_filter
The image-filter instance to use.
Variable $_form
The QuickForm we are using.
Variable $_formmanager
A reference to the Formmanager instance.
Variable $_formTemplate
Form template string
Variable $_group
The group of elements forming our widget.
Variable $_group
The group of elements forming our widget.
Variable $_groupElements
Array with HTML generated for group elements
Variable $_groupElementTemplate
Template for an element inside a group
Variable $_groupTemplate
Element template string
Variable $_groupTemplates
Array containing the templates for elements within groups
Variable $_groupWrap
HTML that wraps around the group elements
Variable $_groupWraps
Array containing the templates for group wraps.
Variable $_headerTemplate
Header Template string
Variable $_hiddenHtml
Collected HTML of the hidden fields
Variable $_html
The HTML of the form
Variable $_identifier
The current image identifier to use when operating on images.
Variable $_inGroup
True if we are inside a group
Variable $_initialize_dependencies
Whether widget should always load its dependencies on initialization, or only during add_elements_to_form call.
Variable $_key_field
The key field used for referencing.
Variable $_lastfield
Variable $_list_all_done
This flag will be set after list_all has been executed to short-cut various lookups where possible.
Variable $_loaded_groups
The cache of loaded group names, indexed by the selected key field.
Variable $_membership_objects
This is a QB resultset of all membership objects currently constructed. It is indexed by membership record guid. It will be populated during startup, when the stored data is loaded. During save, this list will be used to determine the objects that have to be deleted.
Variable $_member_limit_regex
This is a regular expression pattern constructed from $member_limit_like to verify active records against the regex. Tied to $member_limit_like and only valid during convert_to_storage.
Variable $_namespace
This is the Namespace to use for all HTML/CSS/JS elements. It is deduced by the formmanager and tries to be as smart as possible to work safely with more then one form on a page.
Variable $_original_mimetype
The original mimetype of the uploaded file.
Variable $_original_mimetype
The original mimetype of the uploaded file.
Variable $_original_tmpname
The name of the original temporary uploaded file (which will already be converted to a Web-Aware format).
Variable $_original_tmpname
The name of the original temporary uploaded file (which will already be converted to a Web-Aware format).
Variable $_passphrase
The passphrase currently in use.
Variable $_pending_attachments
This list is used when updating an existing image. It keeps track
Variable $_pending_attachments
This list is used when updating an existing attachment. It keeps track
Variable $_plusrow_group
The dummyrow used to create a plusrow.
Variable $_raw_schema
The raw schema array as read by the system. This is a reference into the schema database.
Variable $_raw_schemadb
The raw schema database as read by the system.
Variable $_real_value
The real value as stored in the object. This takes crypting etc. into account.
Variable $_requiredNoteTemplate
Required Note template string
Variable $_schema
A reference to the data schema used for processing.
Variable $_schema
The schema (not the schema database!) to use for operation. This variable will always contain a parsed representation of the schema, so that one can swiftly switch between individual schemas of the Database.
Variable $_schema
The schema (not the schema database!) to use for operation. This variable will always contain a parsed representation of the schema, so that one can swiftly switch between individual schemas of the Database.
Variable $_schemadb
The schema database in use for the child elements
Variable $_schemadb
The schema database to use for operation. This variable will always contain a parsed representation of the schema, so that one can swiftly switch between individual schemas of the Database. This is a list of midcom_helper_datamanager2_schema instances, indexed by their name.
Variable $_select_element
The select element in use. This need spearate tracking due to the potential group code. This makes tracking of empty return values much easier. It is populated during add_elements_to_form().
Variable $_session_domain
The session namespace to use.
Variable $_session_key
The session key in use for this Formmanager instance.
Variable $_target_mimetype
The target mimetype used after automatic conversion for all generated images.
Variable $_target_mimetype
The target mimetype used after automatic conversion for all generated images.
Variable $_templates
Array containing the templates for customised elements
Variable $_title
The image title entered by the user. Stored in each attachments title field.
Variable $_tmpid_fieldname
The name of the hidden field used to remember the temporary object id.
Variable $_type
This is a reference to the type we're based on.
Variable $_types
The list of types which should be used for rendering. They must match the schemadb passed to the class.
Variable $_upload_element
The QF upload form element, used for processing.
Variable $_value_field
The field use for display purposes.
Method _add_attachment_row
Adds a row for an existing attachment
Method _add_element
Creates an element that is returened and added to a row
Method _add_expand_js
Method _add_external_html_elements
Adds the external HTML dependencies, both JS and CSS. A static flag prevents multiple insertions of these dependencies.
Method _add_external_html_elements
Adds the external HTML dependencies, both JS and CSS. A static flag prevents multiple insertions of these dependencies.
Method _add_image_row
Adds a row for an existing image
Method _add_initscript
This helper will construct the TinyMCE initscript based on the specified configuration.
Method _add_new_upload_row
Adds the new upload row to the bottom of the table.
Method _add_new_upload_row
Adds the new upload row to the bottom of the table.
Method _add_rules_and_filters
This helper function adds all rules and filters which are deducable from the schema to the form. It recognizes the follwing schema options:
Method _add_table_footer
Adds the table footer.
Method _add_table_footer
Adds the table footer.
Method _add_table_header
Adds the table header to the widget.
Method _add_table_header
Adds the table header to the widget.
Method _add_thumbnail_to_derived_images
Small internal helper function. It adds a derived 'thumbnail' image to the list used if and only if the auto_thumbnail option is set. Any existing thumbnail declaration will be silently overwritten!
Method _add_thumbnail_to_derived_images
Small internal helper function. It adds a derived 'thumbnail' image to the list used if and only if the auto_thumbnail option is set. Any existing thumbnail declaration will be silently overwritten!
Method _auto_convert_to_web_type
Automatically convert the uploaded file to a web-compatible type. Uses only the first image of multi-page uploads (like PDFs) and populates the _target_mimetype member accordingly. The orignal_tmpname file is manipulated directly.
Method _auto_convert_to_web_type
Automatically convert the uploaded file to a web-compatible type. Uses only the first image of multi-page uploads (like PDFs) and populates the _target_mimetype member accordingly. The orignal_tmpname file is manipulated directly.
Method _cast_formgroup_to_replacedelete
Switches the Element Group from a simple upload form to a replace/delete constellation.
Method _cast_formgroup_to_upload
Switches the Element Group from a replace/delete constellation to a simple upload form.
Method _cast_to_storage_object
cast $storage to a simple midgard storage implementation. the reference should propagate this.
Method _check_class
Method _check_for_update
The following checks are made, in order:
Method _check_for_update
The following checks are made, in order:
Method _check_new_upload
Checks whether a new file has been uploaded. If yes, it is processed.
Method _check_new_upload
Checks whether a new file has been uploaded. If yes, it is processed.
Method _complete_field_defaults
Internal helper function which completes all missing field declaration members so that all fields can be treated uniformly.
Method _compute_elements
Computes the element list to form the widget. It populates the _elements memeber, which is initialized with a new, empty array during startup.
Method _compute_elements
Computes the element list to form the widget. It populates the _elements memeber, which is initialized with a new, empty array during startup.
Method _convert_multiple_from_storage
Converts the selected options according to the multiple_storagemode setting.
Method _convert_multiple_to_storage
Converts the selected options according to the multiple_storagemode setting.
Method _create_default_renderer
Creates an instance of the renderer set in the system configuration. This is called during the initialize code and will make the renderer available immediately after startup.
Method _create_frozen_elements
Create the frozen element listing.
Method _create_frozen_elements
Constructs the widget for frozen operation: Only a single static element is added indicating the current type state.
Method _create_initscript
Generates the initscript for the current field.
Method _create_plusrow
create an empty row at the bottom of
Method _create_random_suffix
Creates random string of 8 characters
Method _create_replace_elements
Creates the elements to manage an existing upload, offering "delete" and "upload new file" operations.
Method _create_unfrozen_elements
Create the unfrozen element listing.
Method _create_upload_elements
Creates the upload elements for empty types.
Method _create_working_copy
This function creates a new working copy and stores the filename in _current_tmpname.
Method _create_working_copy
This function creates a new working copy and stores the filename in _current_tmpname.
Method _csv_encode
Encodes the given string into CSV according to these rules: Any appearance of the separator or one of the two newline characters \n and \r will trigger quoting. In quoting mode, the entire string will be enclosed in double-quotes.
Method _get_advanced_configuration
Returns the "advanced" configuration
Method _get_configuration
Returns the configuration theme based on the local_config_theme.
Method _get_imploded_options
Prepares the imploded storage string. All entries containing the pipe char (used as glue) will be logged and skipped silently.
Method _get_key
Returns the key as configured for the given group.
Method _get_master_foreign_key
Returns the foreign key of the master object. This is either the ID or the GUID of the master object, depending on the $master_is_id member.
Method _get_mimetype
Internal helper function, determines the mime-type of the specified file.
Method _get_mimetype
Internal helper function, determines the mime-type of the specified file.
Method _get_simple_configuration
Returns the default/simple configuraiton:
Method _get_single_key
Method _get_tiny_configuration
Returns the "tiny" configuration
Method _is_ajax_editable
Method _is_widget_visible
This helper function checks wether a given widget is visible.
Method _load_attachment
This function will load a given attachment from the disk, and then calls a function which updates the $attachments_info listing.
Method _load_creation_controllers
Method _load_group
Loads the group referenced by the key passed. The loaded group is written into the _loaded_groups field. If the list_all_done flag is set, the function will exit silently without doing anything.
Method _load_membership_objects
Loads all membership records from the database. May only be called if an storage object is defined.
Method _load_schema
This function parses the schema and populates all members with the corresponding information, completing defaults where neccessary.
Method _load_schemadb
This functnio loads the schema database into the class, either from a copy already in memory, or from an URL resolvable by midcom_get_snippet_content.
Method _load_types
This function will create all type objects for the current schema. It will load class files where neccessary (using require_once), and then create a set of instances based on the schema.
Method _load_widget
This function will create all widget objects for the current schema. It will load class files where neccessary (using require_once), and then create a set of instances based on the schema.
Method _load_widget
This function will create all widget objects for the current schema. It will load class files where neccessary (using require_once), and then create a set of instances based on the schema.
Method _load_widgets
...
Method _on_configuring
Initialize the value with an empty Date class.
Method _on_configuring
This function, is called before the configuration keys are merged into the types configuration.
Method _on_configuring
Set the base URL accordingly (this requires midcom_config access and is thus not possible using class member initializers.
Method _on_configuring
This changes the defaults for the textarea size to something more usable for a WYSIWYG editor.
Method _on_configuring
This function, is called before the configuration keys are merged into the types configuration.
Method _on_configuring
Compatibility handler for the deprecated is_html configuration option.
Method _on_configuring
Adapts the min/maxyear defaults if the base date is set to UNIXDATE storage.
Method _on_initialize
The initialization event handler verifies the correct type.
Method _on_initialize
The initialization event handler, check type.
Method _on_initialize
Initialize the class, if neccessary, create a callback instance, otherwise validate that an option array is present.
Method _on_initialize
The initialization event handler post-processes the maxlength setting.
Method _on_initialize
The initialization event handler post-processes the maxlength setting.
Method _on_initialize
This startup handler validates that the class is populated correctly.
Method _on_initialize
The initialization event handler validates the base type.
Method _on_initialize
Validates the base type
Method _on_initialize
Initialize the class, if neccessary, create a callback instance, otherwise validate that an option array is present.
Method _on_initialize
The initialization event handler verifies the used type.
Method _on_initialize
The initialization event handler validates the base type.
Method _on_initialize
The initialization event handler verifies the correct type.
Method _on_initialize
Initialize the class, if neccessary, create a callback instance, otherwise validate that an option array is present.
Method _on_initialize
This event handler is called during construction, so passing references to $this to the outside is unsafe at this point.
Method _on_initialize
This event handler is called after construction, so passing references to $this to the outside is safe at this point.
Method _on_initialize
This is called during intialization the function is used to
Method _on_initialize
The initialization event handler post-processes the maxlength setting.
Method _on_initialize
The initialization event handler creates the captcha passphrase (if neccessary).
Method _on_initialize
Initialize the class, if neccessary, create a callback instance, otherwise validate that an option array is present.
Method _on_initialize
The initialization event handler validates the base type
Method _on_initialize
The initialization event handler post-processes the maxlength setting.
Method _on_initialize
The initialization event handler post-processes the maxlength setting.
Method _on_initialize
Validates the base type.
Method _on_initialize
This startup handler validates that the privileges array is populated.
Method _on_initialize
The initialization event handler verifies the correct type.
Method _on_initialize
Initialize the class, if neccessary, create a callback instance, otherwise validate that an option array is present.
Method _on_initialize
The initialization event handler post-processes the maxlength setting.
Method _on_load_data
Method _on_load_data
Override this function to implement the storage method for your backend.
Method _on_load_data
This returns the defaults set. An empty string is used for unset defaults.
Method _on_store_data
We don't store anything, this can be safely ignored therefore.
Method _on_store_data
Method _on_store_data
Override this function to implement the storage method for your backend.
Method _on_update_object
This callback is invoked once the storage object has been completly updated with the information from all types. You need to store it to the database at this point.
Method _on_update_object
We do as if we can store successfully at all times.
Method _on_update_object
Method _on_validate
The validateion callback ensures that we dont't have an array or an object as a value, which would be wrong.
Method _on_validate
The validateion callback ensures that we dont't have an array or an object as a value, which would be wrong.
Method _on_validate
The validateion callback ensures that we dont't have an array or an object as a value, which would be wrong.
Method _on_validate
The validateion callback ensures that we dont't have an array or an object as a value, which would be wrong.
Method _on_validate
Type-specific validation callback, this is executed before any custom validation rules which apply through the customization interface.
Method _on_validate
The validation callback ensures that we are in the bounds defined by the type configuration. The value is rounded prior to processing.
Method _prepareTemplate
Helper method for renderElement
Method _process_options
Reads and validates the configuration options. Invalid options are logged and ignored.
Method _round_value
Rounds the value according to the precision rules. If arbitary precision is set, no rounding is done, and the function exits without changing the value.
Method _save_attachment_listing
This function synchronizes the attachment listing parameter of this field with the current attachment state.
Method _save_derived_image
This is the actual code which filters and saves a derived image.
Method _save_derived_image
This is the actual code which filters and saves a derived image.
Method _save_derived_images
This loops over the defined derived images (if any) and constructs each of them in turn.
Method _save_derived_images
This loops over the defined derived images (if any) and constructs each of them in turn.
Method _save_image_listing
This saves a map of attachment identifiers to image identifier/name pairs.
Method _save_main_image
Saves the main image to the type, doing transformation work if configured to do so.
Method _save_main_image
Saves the main image to the type, doing transformation work if configured to do so.
Method _save_original
If we are configured to do so, we save the original image.
Method _save_original
If we are configured to do so, we save the original image.
Method _setGroupTemplates
Called by start/finishGroup() to set the current template elements
Method _set_image
Adds or updates an image to the type. Loads and processes the $tmpname file on disk. The identifier is used to select the image in question.
Method _set_image_size
This is a simple helper which evaluates the imagesize information of a given file and adds that information as parameters to the attachmend identified by its identifier.
Method _sort_attachments
This override adds a sorting call for the images member, which is sorted by main image filename.
Method _sort_attachments
This function sorts the attachment lists by filename. It has to be called after each attachment operation. It uses a user-defined ordering function for each of the two arrays to be sorted: _sort_attachments_callback() and _sort_attachments_info_callback().
Method _sort_attachments_callback
User-defined array sorting callback, used for sorting $attachments. See the usort() documentation for further details.
Method _sort_attachments_info_callback
User-defined array sorting callback, used for sorting $attachments_info. See the usort() documentation for further details.
Method _sort_images_callback
User-defined array sorting callback, used for sorting $images. See the usort() documentation for further details.
Method _translate
This is a shortcut to the translate_schema_string function.
Method _translate
This is a shortcut to the translate_schema_string function.
Method _update_attachment_info
Synchronizes the attachments info array with the attachment referenced by the identifier.
Method _update_attachment_info
Adds information specific to this type to the attachment info block (based on the information in the $_attachment_map):
Method _update_member_limit_regex
Synchronizes the member list regex with the given LIKE query.
Method _update_real_value
Internal helper function, which converts the currently set value (the clear-text password) to the desired storage format, either crypting or prepending a double asterisk.
a
top
Variable $ajax_mode
Whether we're in AJAX mode
Variable $ajax_options
Options to pass for the AJAX controller
Variable $allow_multiple
This flag controls wether multiple selections are allowed, or not.
Variable $allow_other
Set this to true if you want to allow selection of values not part of the regular selection list. In this case you'll find the other options collected in the $others member.
Variable $assignee
The name assignee of the privilege to manage (f.x. 'USERS')
Variable $attachments
All attachments covered by this field. The array contains midcom_baseclasses_database_attachment objects indexed by their identifier within the field.
Variable $attachments_info
This member is populated and synchronized with all known changes to the
Variable $attachment_server_url
This is the base URL used for attachment serving. It defaults to the global MidCOM attachment handler at the sites root. When constructing Attachment Info blocks, this URL is completed using "{$baseurl}{$guid}/{$filename}".
Variable $auto_thumbnail
The maximum witdh/height (in this order) of the thumbnail to be auto-created.
Variable $auto_thumbnail
The maximum witdh/height (in this order) of the thumbnail to be auto-created.
Method add_attachment
Adds a new attachment based on a file on-disk.
Method add_attachment_by_handle
Adds a new attachment based on a file on-disk.
Method add_creation_data
Method add_elements_to_form
Adds a PEAR Date widget to the form
Method add_elements_to_form
Adds a (multi)select widget to the form, depending on the base type config.
Method add_elements_to_form
Adds the checkbox if and only if either the base object is yet null (new object being created) or the user has privileges permissions on the base object.
Method add_elements_to_form
Adds a simple single-line text form element at this time.
Method add_elements_to_form
Adds checkboxes / radioboxes to the form.
Method add_elements_to_form
Adds a simple single-line text form element at this time.
Method add_elements_to_form
This call, which must be overridden by subclasses, adds the neccessary form elements to the form passed by reference.
Method add_elements_to_form
Adds checkboxes / radioboxes to the form.
Method add_elements_to_form
Adds a simple single-line text form element at this time.
Method add_elements_to_form
Adds a simple single-line text form element at this time.
Method add_elements_to_form
Constructs the child object listing.
Method add_elements_to_form
Adds the radibox triplet to the form if and only if we have the permissions.
Method add_elements_to_form
Adds a simple single-line text form element at this time.
Method add_elements_to_form
Adds a pair of password input fields as a group to the form.
Method add_elements_to_form
Constructs the upload list.
Method add_elements_to_form
Constructs the upload list.
Method add_elements_to_form
Adds a simple single-line text form element at this time.
Method add_elements_to_form
Adds a simple checkbox form element.
Method add_elements_to_form
Adds a simple single-line text form element at this time.
Method add_image
Adds a new image to the list.
Method add_object_item
Adds a item for an existing object
Method append_field
This function adds a new field to the schema, appending it at the end of the current field listing. This is callable after the construction of the object, to allow you to add additional fields like component required fields to the list.
Method autoset_storage
This function is a shortcut that combines set_schema and set_storage together.
Page ajax.php
ajax.php in ajax.php
Page ajax.php
ajax.php in ajax.php
b
top
Page blobs.php
blobs.php in blobs.php
Page boolean.php
boolean.php in boolean.php
c
top
Variable $callback
The name of or reference to the callback object to be used.
Variable $callback_method
The name of the callback method to execute. This defaults to _dm2_create_callback.
Variable $callback_object
A reference to the object containing the creation callback. This reference must be set prior initialization.
Variable $child_class
Variable $child_constraints
Variable $child_foreign_key_fieldname
Variable $child_schemadb
Variable $class
Class to search for
Variable $component
Which component the searched class belongs to
Variable $confirm_text
The confirmation note appended to the label of the second, password confirmation field.
Variable $constraints
Associative array of constraints (besides the search term), always AND
Variable $crypted
Indicating crypted operation
Variable $csv_export_key
Set this to true if you want the keys to be exported to the csv dump instead of the values. Note, that this does not affect import, which is only available with keys, not values.
Variable $csv_export_key
Set this to true if you want the keys to be exported to the csv dump instead of the values. Note, that this does not affect import, which is only available with keys, not values.
Variable $csv_export_key
Set this to true if you want the keys to be exported to the csv dump instead of the values. Note, that this does not affect import, which is only available with keys, not values.
Variable $customdata
This array holds custom information attached to this schema. Its exact usage is component dependant.
Method can_do
Checks wether the current user has the given privilege on the storage backend.
Method can_do
Checks wether the current user has the given privilege on the storage backend.
Method clearAllTemplates
Clears all the HTML out of the templates that surround notes, elements, etc.
Method compute_form_result
This function computes the form result based on the button clicked and on the current validation result.
Method convert_from_csv
CVS conversion is mapped to regular type conversion.
Method convert_from_csv
Method convert_from_csv
Method convert_from_csv
Method convert_from_csv
CVS conversion is mapped to regular type conversion.
Method convert_from_csv
CSV conversion works from the storage representation, converting the arrays into simple text lists.
Method convert_from_csv
Method convert_from_csv
Method convert_from_csv
CSV conversion works from the storage representation, converting the arrays into simple text lists.
Method convert_from_csv
Method convert_from_csv
Method convert_from_csv
CSV conversion works from the storage representation, converting the arrays into simple text lists.
Method convert_from_csv
Constructs the object based on its CSV representation (which is already decoded in terms of escaping.)
Method convert_from_storage
Converts storage format to live format, all invalid keys are dropped, and basic validation is done to ensure constraints like allow_multiple are met.
Method convert_from_storage
Loads the privileges value from the database if we have sufficient privileges, otherwise the value stays false. This is ok as storage operations will be ignored as well.
Method convert_from_storage
First, we load the attachment_map information so that we can collect all images together. Then we call the base class.
Method convert_from_storage
Method convert_from_storage
Reads all entries from the mapping table. This overrides the base types I/O code completly.
Method convert_from_storage
Method convert_from_storage
Converts storage format to live format, all invalid keys are dropped, and basic validation is done to ensure constraints like allow_multiple are met.
Method convert_from_storage
Calls the base type to read all attachments, then extracts the title of the main attachment, if applicable.
Method convert_from_storage
Loades the privilege from the DB if and only if a storage object is already present and we have sufficient privileges.
Method convert_from_storage
Converts storage format to live format, all invalid keys are dropped, and basic validation is done to ensure constraints like allow_multiple are met.
Method convert_from_storage
Converts from storage format to "operational" format, which might include more information then the pure storage format. Depending on the $serialized_storage member, the framework will automatically deal with deserializaiton of the information.
Method convert_from_storage
Explicitly converts the passed value into a float, there is a str_replace() added to account for possibly broken localized strings (although they shouldn't happen during saving, you never know).
Method convert_from_storage
Method convert_from_storage
Method convert_from_storage
This function loads all known attachments from the storage object. It will leave the field empty in case the storage object is null.
Method convert_from_storage
This function uses the PEAR Date constructor to handle the conversion.
Method convert_from_storage
This function loads child objects of the storage object. It will leave the field empty in case the storage object is null.
Method convert_list_to_stdout
Converts the given list of objects (usually a QB resultset) to CSV using the configuration currently set up in the component.
Method convert_to_csv
Method convert_to_csv
Method convert_to_csv
Method convert_to_csv
Method convert_to_csv
CSV conversion works from the storage representation, converting the arrays into simple text lists.
Method convert_to_csv
Method convert_to_csv
CSV conversion works from the storage representation, converting the arrays into simple text lists.
Method convert_to_csv
Method convert_to_csv
CSV conversion works from the storage representation, converting the arrays into simple text lists.
Method convert_to_csv
Method convert_to_csv
CVS conversion is mapped to regular type conversion.
Method convert_to_csv
CVS conversion is mapped to regular type conversion.
Method convert_to_csv
Transforms the current objects' state into a CSV string representation. Escaping and other encoding is done by the caller, you just return the string.
Method convert_to_html
The HTML-Version of the image type can take two forms, depending on type configuration:
Method convert_to_html
Method convert_to_html
Method convert_to_html
The HTML-Version of the image type can take two forms, depending on type configuration:
Method convert_to_html
Method convert_to_html
Method convert_to_html
Method convert_to_html
Transforms the current objects' state into HTML representation. This is used for displaying type contents in an automatic fashion.
Method convert_to_html
Renders localized and rounded to specified precision.
Method convert_to_html
Method convert_to_html
Method convert_to_html
Method convert_to_html
The HTML representation returns either the configured texts or a checked / unchecked icon if left on defaults.
Method convert_to_html
Method convert_to_html
Displays the child objects
Method convert_to_storage
Method convert_to_storage
Method convert_to_storage
Method convert_to_storage
Converts Date object to storage representation.
Method convert_to_storage
Method convert_to_storage
Updates the attachment titles.
Method convert_to_storage
Stores the privileges to the database. This call retrieves a temporary object if neccessary.
Method convert_to_storage
Method convert_to_storage
Method convert_to_storage
Method convert_to_storage
The current value is converted into a string before being passed to the caller. Any decimal characters that are not in a form PHP can recognize on parsing will be unified before returning them.
Method convert_to_storage
Updates the mapping table to match the current selection.
Method convert_to_storage
Writes the privilege to the DB unless the privilege member is still null (in which case the inherited default will kick in). In all other cases the type will have already populated storage->object with a temporary object in set_value().
Method convert_to_storage
Method convert_to_storage
Calls base class
Method convert_to_storage
Merges selection and others arrays, the validation cycle ensures that they are right.
Method convert_to_storage
Converts from "operational" format to from storage format. Depending on the $serialized_storage member, the framework will automatically deal with deserializaiton of the information.
Method create
This is a static factory method which lets you dynamically create controller instances.
Method create_object
DM2 creation callback for creating children.
Method create_renderer
Creates a new instance of the renderer specified by $name. It must be a valid renderer
Method create_temporary_object
This function will populate the $object member with a temporary object obtained by the MidCOM temporary object service.
Page create.php
create.php in create.php
Page controller.php
controller.php in controller.php
Page csv.php
csv.php in csv.php
Page captcha.php
captcha.php in captcha.php
Page captcha.php
captcha.php in captcha.php
Page composite.php
composite.php in composite.php
Page captcha.php
captcha.php in captcha.php
Page checkbox.php
checkbox.php in checkbox.php
Page composite.php
composite.php in composite.php
d
top
Variable $datamanager
The datamanager instance which is used for data I/O processing. Set this member using the set_storage() helper function unless you definitly know what you're doing.
Variable $datamanager
The datamanager instance to use for processing. This is set during object construction and will be taken by reference (where it will not be associated with any storage object yet).
Variable $defaults
The defaults to initialize the form manager with. This array is indexed by field names.
Variable $defaults
The defaults to initialize the form manager with. This array is indexed by field names.
Variable $derived_images
The list of derived images to construct.
Variable $derived_images
The list of derived images to construct.
Variable $description
The title of this schema, used to display schemas when
Method delete_all_attachments
This call will unconditionally delete all attachments currently contained by the type.
Method delete_all_objects
This call will unconditionally delete all objects currently contained by the type.
Method delete_attachment
Deletes an existing attachment.
Method delete_image
Deletes the specified image.
Method delete_object
Deletes an existing child object.
Method display_form
This call will render the form.
Method display_form
This call will render the form in AJAX-readable fashion
Method display_form
This function invokes the display_form() hook on the form manager class.
Method display_view
This function displays a quick view of the record, using some simple div based layout, which can be formatted using CSS.
Method display_view
This function displays a quick view of the record, using some simple div based layout, which can be formatted using CSS.
Method display_view
This call will render the contents in AJAX-readable fashion
Page datamanager.php
datamanager.php in datamanager.php
Page date.php
date.php in date.php
Page downloads.php
downloads.php in downloads.php
e
top
Variable $enable_creation
Variable $expand
Add expand link to textbox?
Method execute
Actual callback. Be aware, that QF might call this more then once for a single schema field, since it calls it recursivly and form-element-wise.
f
top
Variable $false_text
The text displayed if the value of the type is false. This defaults to an graphic "not checked" icon. Must be valid for usage in convert_to_html.
Variable $fields
The general field listing, indexed by their name. It contains the full field record which has been completed with all defaults.
Variable $field_order
A simple array holding the fields in the order they should be rendered identified by their name.
Variable $filters
Custom data filter rules. This is a list of arrays. Each array defines a single callback, a field list according to HTML_QuickForm::applyFilter along with a snippet or file location that should be auto-loaded in case the function is missing.
Variable $filter_chain
The filter chain to use to create the "main" image.
Variable $filter_chain
The filter chain to use to create the "main" image.
Variable $form
This is the QuickForm generated out of the schema. This member is set during the initialize call.
Variable $format
The format to use for display.
Variable $formmanager
The form manager instance which is currently in use by this class. This should always be the a single instance, even for multi-page forms. Usually, it is created by the controller class during initialization.
Variable $form_identifier
Unique identifier form a creation instance, used mainly in AJAX mode
Variable $form_identifier
Method finishForm
Called when visiting a form, after processing all form elements Adds required note, form attributes, validation javascript and form content.
Method finishGroup
Called when visiting a group, after processing all group elements
Method freeze
Method freeze
Freezes all form elements accociated with the widget. The default implementation works on the default field name, you don't need to override this function unless you have multiple widgets in the form.
Method freeze
Unfreeze the confirmation widget as well as the main widget.
Method freeze
Freeze the entire group, special handling applies, the formgroup is replaced by a single static element.
Method freeze
Freeze the entire group, special handling applies to skipp all elements which cannot be frozen.
Method freeze
Method freeze
Freezes the Input Element
Method freeze
Freeze the entire group, special handling applies, the formgroup is replaced by a single static element.
Method freeze
Freeze the entire group, special handling applies to skipp all elements which cannot be frozen.
Method freeze
Special form freeze handling.
Page filter.php
filter.php in filter.php
Page formmanager.php
formmanager.php in formmanager.php
g
top
Method get_clicked_button
This is a shortcut function which can be called statically. It allows the calling application to determine the pre-validation return code of the current form.
Method get_content_csv
Little helper function returning an accociative array of all field values converted to CSV using their default convert_to_csv option.
Method get_content_html
Little helper function returning an accociative array of all field values converted to HTML using their default convert_to_html option.
Method get_content_html
Get contents of the form in AJAX-editable format
Method get_content_raw
Little helper function returning an accociative array of all field values converted to their raw storage representation..
Method get_default
The defaults of the widget are mapped to the current selection.
Method get_default
The defaults of the widget are mapped to the current selection.
Method get_default
Method get_default
Returns the default value for this field as required by HTML_Quickform. You may either return a single value for simple types, or an array of form field name / value pairs in case of composite types. A value of null indicates no applicable default.
Method get_default
The default call parses the format string and retrieves the corresponding information from the Date class of the type.
Method get_default
The defaults of the widget are mapped to the current selection.
Method get_default
Method get_default
Method get_default
Method get_default
Method get_default
The default call produces a simple text representation of the current date.
Method get_default
Method get_default
Method get_default
Populates the title fields with their defaults.
Method get_default
Populate the title field.
Method get_default
Populates the title fields with their defaults.
Method get_external_config
Gets an external configuration option referenced by its key. Besides other parts in the datamanager framework, nobody should ever have to touch this information.
Method get_external_config
Gets an external configuration option referenced by its key. Besides other parts in the datamanager framework, nobody should ever have to touch this information.
Method get_header_line
This will yield a line containing all the field descriptions to be used as column headers.
Method get_line
This function will set the storage object to the one passed to this function and will transform it then into a CSV compatible form.
Method get_name_for_key
Returns the name of a loaded group. Since key_exists is always called beforehand, we're sure that it is loaded at this point.
Method get_name_for_key
Returns the full name for a given key. This value is not localized in any way.
Method get_value
Returns the current privilege value, defaulting to INHERIT in case the privilege is yet unset.
Page grouplister.php
grouplister.php in grouplister.php
h
top
Variable $headers
Headers for the rows
Variable $headers
Headers for the rows
Variable $height
Height of the textbox.
Variable $height
The height of the multi-select box, ignored if no multiple selection is allowed.
Variable $hideinput
Wether the input should be shown in the widget, or not.
Method HTML_QuickForm_Renderer_Default
Constructor
i
top
Variable $idfield
Field/property to use as the key/id
Variable $images
The list of images. This is essentially a reordered version of the $attachments_info member: It is multi-dimensional, mapping the image identifier with all images available for that image. The actual images will only have the derived image name (like "thumbnail" as array key.
Method initialize
...
Method initialize
You need to set the schema database before calling this function. Optionally you may set defaults and the schemaname to use as well.
Method initialize
Empty default implementation, this calls won't do much.
Method initialize
Initializes and configures the type.
Method initialize
AJAX controller initialization. Loads required Javascript libraries
Method initialize
Initializes and configures the widget.
Method initialize
...
Method initialize
You need to set the schema database before calling this function. Optionally you may set defaults and the schemaname to use as well.
Method initialize
Empty default implementation, this calls won't do much.
Method initialize
This function fully initializes the class for operation. This is not done during the constructor call, to allow for full reference safety.
Method is_empty
Tries to detect wether the date value entered is empty in terms of the Midgard core. For this, all values are compared to zero, if all tests succeed, the date is considered empty.
Method is_frozen
Method is_frozen
Returns always false
Method is_frozen
Method is_frozen
Checks if and only if either the base object is yet null (new object being created) or the user has privileges permissions on the base object.
Method is_frozen
Checks if the input element is frozen.
Method is_frozen
Checks if the widget is frozen. The default implementation works on the default field name, usually you don't need to override this function unless you have some strange form element logic.
Page interfaces.php
interfaces.php in interfaces.php
Page images.php
images.php in images.php
Page image.php
image.php in image.php
Page images.php
images.php in images.php
Page image.php
image.php in image.php
j
top
Page jsdate.php
jsdate.php in jsdate.php
k
top
Variable $keep_original
Set this to true to keep the original file available as "original".
Variable $keep_original
Set this to true to keep the original file available as "original".
Method key_exists
Checks, wether the given key is known.
Method key_exists
Checks if the group key exists. This checks if it is available by looking at the cache. If the key is not present there even after a loading attempt, the key is wrong.
l
top
Variable $l10n_schema
The primary L10n DB to use for schema translation.
Variable $length
The length of the passphrase.
Variable $local_config
Local configuration to be added to the config snippet.
Method list_all
Returns the list of all groups
Method list_all
Returns the full listing of all available key/value pairs.
Method load
Loads a set of types to the configured storage object. This is done by subclass implementations, where this function serves as a request switch.
Method load_database
Helper function which transforms a raw schema database (either already parsed or based on an URL to a schemadb) into a list of schema class instances.
Method load_schemadb
Loads an schema definitino from disk and creates the corresponding schema class instances.
m
top
Variable $mapping_class_name
Mandatory option. Holds the name of the DBA class used for the mapping code. The class must satisfy the above rules.
Variable $master_fieldname
Mandatory option. Holds the fieldname containing the (GU)ID of the master object in the mapping table.
Variable $master_is_id
Set this to true if you want the ID instead of the GUID to be used for mapping purposes.
Variable $maximum
The upper bound of valid values, set to null to disable checking (default).
Variable $maximum_items
Variable $maxlength
Maximum length of the string encaspulated by this type. 0 means no limit.
Variable $maxlength
Maximum length of the string encaspulated by this type. 0 means no limit.
Variable $maxlength
Maximum length of the string encaspulated by this type. 0 means no limit.
Variable $maxyear
Maximum Year available for selection.
Variable $maxyear
Maximum Year available for selection.
Variable $mce_config_snippet
The MCE configuration snippet to use. Argument must be applicable to use with midcom_get_snippet_content.
Variable $member_fieldname
Mandatory option. Holds the fieldname containing the membership keys in the mapping table.
Variable $member_limit_like
This SQL LIKE combatibel constraint limits the number of valid member keys if set (see class introduction).
Variable $minimum
The lower bound of valid values, set to null to disable checking (default).
Variable $minyear
Minimum Year available for selection.
Variable $minyear
Minimum Year available for selection.
Variable $multiple_storagemode
The storage mode used when multiselect is enabled, see the class' introduction for details.
Page midgard.php
midgard.php in midgard.php
Page mnrelation.php
mnrelation.php in mnrelation.php
Method midcom_helper_datamanager2_baseclasses_filter
Standard constructor, as defined by the schema specification. Pre initializes all members.
Class midcom_helper_datamanager2_baseclasses_filter
Datamanger 2 Form Manager data filter base class.
Class midcom_helper_datamanager2_callback_select_grouplister
DM2 Select Type Callback Toolkit: Midgard Group Lister
Method midcom_helper_datamanager2_callback_select_grouplister
The default constructor reads in the configuration. See above for allowed options.
Method midcom_helper_datamanager2_controller
Initializes the class. The real startup is done by the initialize() call.
Class midcom_helper_datamanager2_controller
Datamanger 2 Data Manager controller base class.
Class midcom_helper_datamanager2_controller_ajax
Datamanger 2 Data Manager AJAX controller class.
Class midcom_helper_datamanager2_controller_create
Datamanger 2 Data Manager object creation controller class.
Class midcom_helper_datamanager2_controller_nullstorage
Datamanger 2 Data Manager null storage controller class.
Class midcom_helper_datamanager2_controller_simple
Datamanger 2 Data Manager simple controller class.
Class midcom_helper_datamanager2_csv
Datamanager 2 CSV Export helper class.
Method midcom_helper_datamanager2_csv
Initializes the class. The real startup is done by the initialize() call.
Method midcom_helper_datamanager2_datamanager
The constructor loads the schema database to use but does nothing else so far.
Class midcom_helper_datamanager2_datamanager
Datamanger 2 Data Manager core class.
Method midcom_helper_datamanager2_formmanager
Initializes the Form manager with a list of types for a given schema.
Class midcom_helper_datamanager2_formmanager
Datamanger 2 Form Manager core class.
Class midcom_helper_datamanager2_formmanager_ajax
Datamanger 2 ajax Form Manager class.
Method midcom_helper_datamanager2_formmanager_ajax
Initializes the Form manager with a list of types for a given schema.
Method midcom_helper_datamanager2_formmanager_paged
Initializes the Form manager with a list of types for a given schema.
Class midcom_helper_datamanager2_formmanager_paged
Datamanger 2 Paged Form Manager class.
Method midcom_helper_datamanager2_interface
Constructor.
Class midcom_helper_datamanager2_interface
Datamanger 2 Component Interface Class. This is a pure code library.
Class midcom_helper_datamanager2_renderer_simple
A concrete renderer for HTML_QuickForm,
Method midcom_helper_datamanager2_schema
Construct a schema, takes a schema snippet URI resolveable through the midcom_get_snippet_content() helper function.
Class midcom_helper_datamanager2_schema
Datamanger 2 Schema class.
Method midcom_helper_datamanager2_storage
Creates the storage interface class, and initializes it to a given data schema.
Class midcom_helper_datamanager2_storage
Datamanger 2 Data storage base class.
Class midcom_helper_datamanager2_storage_midgard
Datamanger 2 Data storage implementation: Pure Midgard object.
Method midcom_helper_datamanager2_storage_midgard
Start up the storage manager and bind it to a given MidgardObject.
Class midcom_helper_datamanager2_storage_null
Datamanger 2 Data storage implementation: NULL storage object.
Method midcom_helper_datamanager2_storage_null
TODO
Method midcom_helper_datamanager2_storage_tmp
Start up the storage manager and bind it to a given temporary object.
Class midcom_helper_datamanager2_storage_tmp
Datamanger 2 Data storage implementation: Temporary storage object.
Method midcom_helper_datamanager2_type
Constructor.
Class midcom_helper_datamanager2_type
Datamanger 2 Data Type base class.
Class midcom_helper_datamanager2_type_blobs
Datamanger 2 Blob management type.
Class midcom_helper_datamanager2_type_boolean
Datamanger 2 Simple boolean datatype.
Class midcom_helper_datamanager2_type_captcha
Datamanger 2 captcha base type. Does not provide any functionality, just an empty base type so that the DM2 Formmanager can link into the system.
Class midcom_helper_datamanager2_type_composite
Datamanager 2 composite object management type.
Class midcom_helper_datamanager2_type_date
Datamanger 2 date datatype. The type is based on the PEAR date types types.
Class midcom_helper_datamanager2_type_image
Datamanger 2 Image type.
Class midcom_helper_datamanager2_type_images
Datamanger 2 Images type.
Class midcom_helper_datamanager2_type_mnrelation
Datamanger 2 m:n membership management type.
Class midcom_helper_datamanager2_type_number
Datamanger 2 Simple number datatype. The type is based on the PHP floating point types, not an arbitary precision number system.
Class midcom_helper_datamanager2_type_parameters
Datamanger 2 parameters type. This allows the editing of all parameters of the storage object.
Class midcom_helper_datamanager2_type_password
Datamanger 2 midgard_person compatible password datatype
Class midcom_helper_datamanager2_type_privilege
Datamanger 2 Simple privilege datatype.
Class midcom_helper_datamanager2_type_privilegeset
Datamanger 2 privilege set datatype.
Class midcom_helper_datamanager2_type_select
Datamanger 2 Simple select type. This allows the selection of one or more values from a given list. It is possible to enable adding "unreferenced" items in a "others" listing, but those are outside the normal processing.
Class midcom_helper_datamanager2_type_table
Datamanger 2 table type.
Class midcom_helper_datamanager2_type_text
Datamanger 2 Simple text datatype. The text value encaspulated by this type is passed as-is to the storage layers, no specialieties done, just a string.
Class midcom_helper_datamanager2_widget
Datamanger 2 Widget base class.
Method midcom_helper_datamanager2_widget
Constructor.
Class midcom_helper_datamanager2_widget_captcha
Datamanger 2 captcha widget
Class midcom_helper_datamanager2_widget_checkbox
Datamanger 2 simple checkbox
Class midcom_helper_datamanager2_widget_composite
Datamanger 2 composite widget
Class midcom_helper_datamanager2_widget_downloads
Datamanger 2 download widget
Class midcom_helper_datamanager2_widget_image
Datamanger 2 simple image widget
Class midcom_helper_datamanager2_widget_images
Datamanger 2 images widget
Class midcom_helper_datamanager2_widget_jsdate
Datamanger 2 JS date widget
Class midcom_helper_datamanager2_widget_password
Datamanger 2 password widget
Class midcom_helper_datamanager2_widget_privilege
Datamanger 2 simple privilege
Class midcom_helper_datamanager2_widget_privilegecheckbox
Datamanger 2 privilege checkbox widget.
Class midcom_helper_datamanager2_widget_radiocheckselect
Datamanger 2 simple checkbox / radiobox select widget.
Class midcom_helper_datamanager2_widget_select
Datamanger 2 simple select widget.
Class midcom_helper_datamanager2_widget_simpledate
Datamanger 2 simple date widget
Class midcom_helper_datamanager2_widget_table
Datamanger 2 simple table widget
Class midcom_helper_datamanager2_widget_text
Datamanger 2 simple text widget
Class midcom_helper_datamanager2_widget_textarea
Datamanger 2 simple textarea widget
Class midcom_helper_datamanager2_widget_tinymce
Datamanger 2 TinyMCE driven textarea widget
Class midcom_helper_datamanager2_widget_universalchooser
Datamanger 2 universal "chooser" widget.
n
top
Variable $name
The name field holds the name of the field the datatype is encaspulating. This maps to the schema's field name. You should never have to change them.
Variable $name
The name of the schema ("identifier").
Variable $name
The name field holds the name of the field the widget is encaspulating. This maps to the schema's field name. You should never have to change them.
Variable $namespace
The namespace of the form. This value is to be considered read only.
Variable $newline
Newline character sequence to use, this defaults to "\r\n".
Page nullstorage.php
nullstorage.php in nullstorage.php
Page null.php
null.php in null.php
Page number.php
number.php in number.php
o
top
Variable $object
This is a reference the storage object used by the subclass implementation.
Variable $objects
All objects covered by this field. The array contains Midgard objects indexed by their identifier within the field.
Variable $operations
The operations to add to the form. This is an simple array of commands, valid entries are 'save', 'cancel', 'next' and 'previous', 'edit' is forbidden, other values are not interpreted by the DM infrastructure.
Variable $options
The options available to the client. You should not acecss this variable directly, as this information may be loaded on demand, depending on the types configuration.
Variable $option_callback
In case the options are returned by a callback, this member holds the name of the class.
Variable $option_callback_arg
The argument to pass to the option callback constructor.
Variable $orders
associative array of ordering info, always added last
Variable $others
This member contains the other key, in case it is set. In case of multiselects, the full list of unknown keys is collected here, in case of single select, this value takes precedence from the standard selection.
Variable $othertext
l10n string id or direct text to use to separate the others input field from the main select. Applies only for types which have allow_other set.
Variable $othertext
l10n string id or direct text to use to separate the others input field from the main select. Applies only for types which have allow_other set.
Variable $output_mode
Sets output formatting. See class introduction.
Method on_submit
This event handler is called if and only if the Formmanager detects an actual form submission (this is tracked using a hidden form member). No Form validation has been done at this point. The event is triggered on all submissions with the exception of the cancel and previous form events.
Method on_submit
The on_submit event handles all file uploads immediately. They are passed through the type at that point. This is required, since we do not have persistant upload file management on the QF side. Deletions take precedence over uploads.
Method on_submit
The on_submit event handles all operations immediately. This includes title updates (all are done regardless of actual updates).
Method on_submit
The on_submit event handles all operations immediately. This includes title updates (all are done regardless of actual updates).
p
top
Variable $parent_key_fieldname
Variable $plusrow
add an empty row at the bottom
Variable $precision
The precision of the type, null means full available precision, while 0 emulates an integer type. See also the PHP round() function's documentation about precision specifiers.
Variable $privilege
The privilege record encaspulated by this type (note that this does not neccecarily is an already persisted privilege).
Variable $privileges
Privileges declarations.
Variable $privilege_name
The name of the privilege to manage (f.x. 'midgard:update')
Page paged.php
paged.php in paged.php
Page parameters.php
parameters.php in parameters.php
Page password.php
password.php in password.php
Page privilegeset.php
privilegeset.php in privilegeset.php
Page privilege.php
privilege.php in privilege.php
Page password.php
password.php in password.php
Page privilegecheckbox.php
privilegecheckbox.php in privilegecheckbox.php
Page privilege.php
privilege.php in privilege.php
Method process_ajax
This function wraps AJAX processing completely. If component wishes to do post-processing after an edit, save or preview state in this call it must set the exit parameter to false.
Method process_ajax
Process AJAX-style creation requests
Method process_form
This funciton wraps the form manager processing. Ifprocessing is successful, (that is, only 'save'). If editing was successful, the form is frozen in case you want to display it again (usually you want to redirect to the view target).
Method process_form
...
Method process_form
This function should process the form data sent to the server. Its behavoir is dependant on the controller used, see the individual class documentations for details.
Method process_form
This funciton wraps the form manager processing. Ifprocessing is successful, (that is, only 'save'). If editing was successful, the form is frozen in case you want to display it again (usually you want to redirect to the view target).
Method process_form
This funciton wraps the form manager processing. If processing is successful and the form is in 'save'ed state, the storage backend is cast to a standard midgard object, any temporary resources are moved to there, and the formdata is saved.
Method process_form
Call this before any output is made. It will process the form results, if applicable, and return an according exit code. This indicates which (if any) submit button was pressed.
Method process_form
This funciton wraps the form manager processing. Ifprocessing is successful, (that is, not 'cancel' or 'edit').
Method process_form
...
r
top
Variable $renderer
This is the renderer that quickform will use.
Variable $rows
A list of rows for the table
Variable $rows
A list of rows for the table
Page radiocheckselect.php
radiocheckselect.php in radiocheckselect.php
Method register_to_session
Registers a schema into the session so it is readable by the imagepopup.
Method renderElement
Renders an element Html Called when visiting an element
Method renderHeader
Called when visiting a header element
Method renderHidden
Renders an hidden element Called when visiting a hidden element
Method renderHtml
Called when visiting a raw HTML/text pseudo-element
Method render_content
When called, this method should display the current data without any editing widget or surrounding braces in plain and simple HTML.
Method render_content
Renders the date using an ISO syntax
Method render_content
Method render_content
Method render_content
Renders the date in the ISO format.
Method render_content
s
top
Variable $schema
This variable holds the schema currently in use, it has been created from the array stored in the $_schemadb member.
Variable $schemadb
The schemadb to handle by this controller. This is a list of midcom_helper_datamanager2_schema instances, indexed by their name. Set this member using the load_schemadb or set_schemadb helpers unless you know what you're doing.
Variable $schemaname
The name of the schema to use. If this is left to null, the first schema from the database is used instead.
Variable $schemaname
The name of the schema to use. If this is left to null, the first schema from the database is used instead.
Variable $searchfields
Fields/properties to search the keyword for, always OR and specified after the constaints above
Variable $selection
A list of the currently selected keys. This is an array even for single select types, in which case the validation limits it to one item. The values array consists only of the object keys, use the resolver function to get the corresponding values.
Variable $separator
Separator to use between fields, this defaults to ",".
Variable $serialized_storage
Set this to true during one of the startup callbacks if you need to have the datastorage (de)serialized automatically during I/O operations.
Variable $show_time
Indicates wether the timestamp should be shown or not.
Variable $show_title
Controls title processing.
Variable $size
The size of the input box.
Variable $storage
This is the storage implementation which is used for operation on the types. It encaspulates the storage target.
Variable $storage
A reference to the storage object that this type is using. Use this for attachment management. The variable may be null until actual processing starts. It may also change during the lifetime of a type. You should therefore be careful.
Variable $storage_type
The storage type to use, see the class introduction for details.
Variable $style_element_name
Page simple.php
simple.php in simple.php
Page simple.php
simple.php in simple.php
Page schema.php
schema.php in schema.php
Page storage.php
storage.php in storage.php
Page select.php
select.php in select.php
Page select.php
select.php in select.php
Page simpledate.php
simpledate.php in simpledate.php
Method save
This function will save the current state of all types to disk. A full validation cycle is done beforehand, if any validation fails, the function aborts and sets the $validation_errors member variable accordingly.
Method setElementTemplate
Sets element template
Method setFormTemplate
Sets form template
Method setGroupElementTemplate
Sets element template for elements within a group
Method setGroupTemplate
Sets template for a group wrapper
Method setHeaderTemplate
Sets header template
Method setRequiredNoteTemplate
Sets the note indicating required fields template
Method set_external_config
Sets an external configuration option. Besides other parts in the datamanager framework, nobody should ever have to touch this information.
Method set_external_config
Sets an external configuration option. Besides other parts in the datamanager framework, nobody should ever have to touch this information.
Method set_fieldname
Simple setter, populates the $_fieldname member.
Method set_form
Set the form reference.
Method set_image
Adds the image to the type. Loads and processes the $tmpname file on disk.
Method set_renderer
Sets the form's renderer based on an existing renderer instance.
Method set_schema
This function activates the given schema. This will drop all existing types and create a new set of them which are in the default state at this point.
Method set_schemadb
Uses an already loaded schema database. If you want to load a schema database from disk, use the load_schemadb method instead.
Method set_storage
Sets the current datamanager instance to the storage object given, which may either be a MidCOM DBA object (which is encaspulated by a midgard datamanger storage instance).
Method set_storage
Small helper which sets the current storage object to a new one. The object is used by-reference.
Method set_storage
This function sets the system to use a specific storage object. You can pass
Method set_value
Wrapper to set the value of this instance type aware: It enforces conversion to a float type and rounds it to the correct precision if applicable. This function should be preferred to regular assignment operations in case you plan to do further work with the types value.
Method set_value
Sets the privileges value. If the privilege record has not yet been created, it creates a new one (getting a temporary object from the DM core if neccessary).
Method startForm
Called when visiting a form, before processing any form elements
Method startGroup
Called when visiting a group, before processing any group elements
Method store
Stores a set of types to the configured storage object. This is done by subclass implementations, where this function serves as a request switch.
Method sync_type_with_widget
Method sync_type_with_widget
When syncing data we clear the capatcha data in the session.
Method sync_type_with_widget
The current selection is compatible to the widget value only for multiselects.
Method sync_type_with_widget
The current selection is compatible to the widget value only for multiselects.
Method sync_type_with_widget
Synchronizes if and only if either the base object is yet null (new object being created) or the user has privileges permissions on the base object.
Method sync_type_with_widget
This function is invoked if the widget should extract the corresponding data from the form results passed in $results. Form validation has already been done before, this function will only be called if and only if the form validation succeeds.
Method sync_type_with_widget
Synchronizes if and only if we have the permissions.
Method sync_type_with_widget
Method sync_type_with_widget
Method sync_type_with_widget
Nothing to do here.
Method sync_type_with_widget
Method sync_type_with_widget
Nothing to do here.
Method sync_type_with_widget
Method sync_type_with_widget
Synchronize the title field
Method sync_type_with_widget
Tells the base date class instance to parse the value from the input field.
Method sync_type_with_widget
Method sync_type_with_widget
The current selection is compatible to the widget value only for multiselects.
t
top
Variable $theme
Define some simple configuration themes without having to create a config file.
Variable $title
The image title entered by the user. Stored in each attachments title field.
Variable $titlefield
Field/property to use for the title in listings
Variable $true_text
The text displayed if the value of the type is true. This defaults to an graphic "checked" icon. Must be valid for usage in convert_to_html.
Variable $types
This is a listing of all types that have been loaded from the storage object. You may manipulate these types and their values at will, and then store them back to the database using the functions available in this class.
Page tmp.php
tmp.php in tmp.php
Page type.php
type.php in type.php
Page table.php
table.php in table.php
Page text.php
text.php in text.php
Page table.php
table.php in table.php
Page textarea.php
textarea.php in textarea.php
Page text.php
text.php in text.php
Page tinymce.php
tinymce.php in tinymce.php
Method toHtml
returns the HTML generated for the form
Method translate_schema_string
Schema translation helper, usable by components from the outside.
u
top
Variable $use_imagepopup
Should the imagepopup button be shown?
Page universalchooser_handler.php
universalchooser_handler.php in universalchooser_handler.php
Page universalchooser.php
universalchooser.php in universalchooser.php
Method unfreeze
Unfreezes all form elements accociated with the widget. The default implementation works on the default field name, you don't need to override this function unless you have multiple widgets in the form.
Method unfreeze
Unfreeze the entire group, special handling applies, the formgroup is replaced by a the full input widget set.
Method unfreeze
Method unfreeze
Unfreeze the entire group, special handling applies, the formgroup is replaced by a the full input widget set.
Method unfreeze
Unfreeze the entire group, special handling applies, the formgroup is replaced by a the full input widget set.
Method unfreeze
Unfreezes the Input Element
Method unfreeze
Unfreeze the entire group, special handling applies, the formgroup is replaced by a the full input widget set.
Method unfreeze
Method unfreeze
Special form freeze handling.
Method update_attachment
Update an existing attachment with a new file (this keeps GUIDs stable).
Method update_attachment_by_handle
Update an existing attachment with a new file (this keeps GUIDs stable).
Method update_attachment_title
Updates the title field of the specified attachment. This will automatically update the attachment info as well.
Method update_image
Updates an existing image.
Method update_image_title
v
top
Variable $validation
Form-wide validation callbacks, executed by QuickForm. This is a list of arrays. Each array defines a single callback, along with a snippet or file location that should be auto-loaded in case the function is missing.
Variable $validation_error
This field contains the reason for the failed validation. The string can be safely assumed to be localized, and is only valid if a validation has failed previously.
Variable $validation_errors
This variable contains an Array of all validation errors that have occured during saving. As outlined in the type, these messages my have inline-html in it and it is assumed to be localized.
Variable $value
The current clear text value of the current password, if available, or null in case of a crypted password. Set this to the new password value if you want to store anything. The password must be non-null and a non-empty string for any storage operation to take place.
Variable $value
The current string encaspulated by this type.
Variable $value
The current string encaspulated by this type. This may be null for undefined values.
Variable $value
The current date encaspulated by this type.
Variable $value
The current string encaspulated by this type.
Method validate
QF Valiation callback which verifies the passcode against the Captcha.
Method validate
Validate the current object state. It will populate $validation_errors accordingly.
Method validate
Main validation interface, currently only calls the main type callback, but this can be extended later by a configurable callback into the component.
Method validate_number
QF Valiation callback used for number types. It checks the number boundaries accordingly.
w
top
Variable $widgets
A list of widgets, indexed by the field names from the schema, thus matching the type listing.
Variable $width
Width of the textbox.
Variable $widths
row widths
Variable $window_mode
Variable $window_mode
Variable $wrap
Wrapping mode of the textbox.
Page widget.php
widget.php in widget.php
a b c d e f g h i j k l m n o p r s t u v w _