Class: atkMetaNode
Source Location: /class.atkmetanode.inc
Class atkMetaNode
Inherited from parent
|
Inherited From atkNode
-
atkNode::$m_action
-
-
atkNode::$m_actionListeners
-
-
atkNode::$m_attribIndexList
-
-
atkNode::$m_attribList
-
-
atkNode::$m_attribsizesset
-
-
atkNode::$m_attributeTabs
-
-
atkNode::$m_cascadingAttribs
-
-
atkNode::$m_db
-
-
atkNode::$m_defaultColumn
-
-
atkNode::$m_defaultlanguage
-
-
atkNode::$m_default_expanded_sections
-
-
atkNode::$m_default_order
-
-
atkNode::$m_default_tab
-
-
atkNode::$m_descHandler
-
-
atkNode::$m_descTemplate
-
-
atkNode::$m_editableListAttributes
-
-
atkNode::$m_edit_fieldprefix
-
-
atkNode::$m_extended_search_action
-
-
atkNode::$m_feedback
-
-
atkNode::$m_filledTabs
-
-
atkNode::$m_filters
-
-
atkNode::$m_flags
-
-
atkNode::$m_fuzzyFilters
-
-
atkNode::$m_handler
-
-
atkNode::$m_index
-
-
atkNode::$m_initialised
-
-
atkNode::$m_listExcludes
-
-
atkNode::$m_lngfield
-
-
atkNode::$m_lock
-
-
atkNode::$m_lockMode
-
-
atkNode::$m_modifier
-
-
atkNode::$m_module
-
-
atkNode::$m_mraSelectionMode
-
-
atkNode::$m_numbering
-
-
atkNode::$m_page
-
-
atkNode::$m_partial
-
-
atkNode::$m_postvars
-
-
atkNode::$m_primaryKey
-
-
atkNode::$m_priority_actions
-
-
atkNode::$m_priority_max
-
-
atkNode::$m_priority_min
-
-
atkNode::$m_relations
-
-
atkNode::$m_search_action
-
-
atkNode::$m_sectionList
-
-
atkNode::$m_securityAlias
-
-
atkNode::$m_securityImplied
-
-
atkNode::$m_securityMap
-
-
atkNode::$m_seq
-
-
atkNode::$m_statusbarDone
-
-
atkNode::$m_table
-
-
atkNode::$m_tabList
-
-
atkNode::$m_triggerListeners
-
-
atkNode::$m_type
-
-
atkNode::$m_uniqueFieldSets
-
-
atkNode::$m_unsecuredActions
-
-
atkNode::$m_validate_class
-
-
atkNode::$m_viewExcludes
-
|
Inherited From atkNode
-
atkNode::atkNode()
-
Constructor.
-
atkNode::actionTitle()
-
Generate a title for a certain action on a certain action.
-
atkNode::add()
-
Add an atkAttribute (or one of its derivatives) to the node.
-
atkNode::addAllowedAction()
-
Disable privilege checking for an action.
-
atkNode::addDb()
-
Save a new record to the database.
-
atkNode::addDefaultExpandedSections()
-
Add sections that must be expanded by default.
-
atkNode::addFieldSet()
-
Add fieldset.
-
atkNode::addFilter()
-
Add a recordset filter.
-
atkNode::addFlag()
-
Add a flag to the node.
-
atkNode::addListener()
-
Add an atkActionListener to the node.
-
atkNode::addSecurityMap()
-
Set the security of one or more actions action the same as other actions.
-
atkNode::addStyle()
-
Add a stylesheet to the page.
-
atkNode::addToQuery()
-
Add this node to an existing query.
-
atkNode::addUniqueFieldset()
-
Add a unique field set.
-
atkNode::allowed()
-
This function determines if the user has the privilege to perform a certain action on the node.
-
atkNode::applySearchCriteria()
-
Apply the given search criteria to the given query object.
-
atkNode::applySmartSearchCriteria()
-
Apply the given smart search criteria to the given query object.
-
atkNode::atkNodeType()
-
Get the full atknodetype of this node (module.nodetype notation). This is sometimes referred to as the node name (or nodename) or node string.
-
atkNode::attribSort()
-
This function resorts the attribIndexList.
-
atkNode::attrib_cmp()
-
Small compare function for sorting attribs on order field
-
atkNode::buildTabs()
-
Builds a list of tabs.
-
atkNode::callHandler()
-
Invoke the handler for an action.
-
atkNode::changeMapping()
-
change the securitymap that already exist. Where actions are mapped on $oldmapped change it by $newmapped
-
atkNode::checkAttributeSecurity()
-
Check attribute security.
-
atkNode::checkEmptyTabs()
-
Remove tabs without attribs from the tablist
-
atkNode::checkTabRights()
-
Check if the user has the rights to access existing tabs and removes tabs from the list that may not be accessed
-
atkNode::confirmAction()
-
Function returns a page in which the user is asked if he really wants to perform a certain action.
-
atkNode::confirmActionText()
-
Determine the confirmation message.
-
atkNode::copyDb()
-
Copy a record in the database.
-
atkNode::countDb()
-
Count the number of records in the database that a call to selectDb would return.
-
atkNode::createPageBuilder()
-
Returns a new page builder instance.
-
atkNode::defaultActions()
-
Retrieve an array with the default actions for a certain mode.
-
atkNode::deleteDb()
-
Delete record(s) from the database.
-
atkNode::descriptor()
-
Determine a descriptor of a record.
-
atkNode::descriptorFields()
-
Retrieve the list of attributes that are used in the descriptor definition.
-
atkNode::dispatch()
-
This is the wrapper method for all http requests on a node.
-
atkNode::editArray()
-
Function outputs an array with edit fields. For each field the array contains the name, edit HTML code etc. (name, html, obligatory, error, label)
-
atkNode::edit_values()
-
Retrieve new values for an existing record.
-
atkNode::escapeSQL()
-
Escape SQL string, uses the node's database to do the escaping.
-
atkNode::executeTrigger()
-
Executes a trigger on a add,update or delete action
-
atkNode::feedbackUrl()
-
Determine the url for the feedbackpage.
-
atkNode::fetchByPk()
-
Returns a record (array) as identified by a primary key (usually an "id" column), including applicable relations.
-
atkNode::filledInForm()
-
Checks if the user has filled in something: return true if he has, otherwise return false
-
atkNode::genericPage()
-
Render a generic page, with a box, title, stacktrace etc.
-
atkNode::getActiveSections()
-
Get the active sections.
-
atkNode::getActiveTab()
-
Returns the currently active tab.
-
atkNode::getAttribute()
-
Get an attribute by name.
-
atkNode::getAttributeNames()
-
Returns a list of attribute names.
-
atkNode::getAttributeOrder()
-
Gets the attribute order.
-
atkNode::getAttributes()
-
Gets all the attributes.
-
atkNode::getColumnConfig()
-
Get the column configuration object
-
atkNode::getDb()
-
Get the database connection for this node.
-
atkNode::getDefaultActionParams()
-
Determine the default form parameters for an action template.
-
atkNode::getDefaultColumn()
-
Returns the default column name.
-
atkNode::getDescriptorHandler()
-
Get descriptor handler.
-
atkNode::getDescriptorTemplate()
-
Returns the descriptor template for this node.
-
atkNode::getEditFieldPrefix()
-
Get the edit fieldprefix to use
-
atkNode::getExtendedSearchAction()
-
Get extended search action.
-
atkNode::getFlags()
-
Returns the node flags.
-
atkNode::getFormButtons()
-
Returns the form buttons for a certain page.
-
atkNode::getHandler()
-
Get the atkActionHandler object for a certain action.
-
atkNode::getHelp()
-
Retrieve help link for the current node.
-
atkNode::getLockMode()
-
Returns the lock mode.
-
atkNode::getLockStatusIcon()
-
Get img tag for lock icon.
-
atkNode::getModule()
-
Returns the module for this node.
-
atkNode::getMRASelectionMode()
-
Returns the multi-record-action selection mode.
-
atkNode::getNumbering()
-
Gets the numbering of the attributes
-
atkNode::getOrder()
-
Get default sort order for the node.
-
atkNode::getPage()
-
Get the page instance of the page on which the node can render output.
-
atkNode::getSearchCondition()
-
Get search condition for this node.
-
atkNode::getSearchMode()
-
Get the current searchmode.
-
atkNode::getSections()
-
Retrieve the sections for the active tab.
-
atkNode::getSecurityAlias()
-
Returns the node's security alias (if set).
-
atkNode::getTabFromSection()
-
Strip section part from a section and return the tab.
-
atkNode::getTable()
-
Returns the table name for this node.
-
atkNode::getTabs()
-
Get a list of tabs for a certain action.
-
atkNode::getTabsFromSections()
-
Retrieve the tabnames from the sections string (tab.section).
-
atkNode::getTemplate()
-
Get the template to use for a certain action.
-
atkNode::getType()
-
Returns the type of this node. (This is *not* the full ATK node type; see atkNodeType() for the full node type.)
-
atkNode::getUi()
-
Get the ui instance for drawing and templating purposes.
-
atkNode::groupFieldsBySection()
-
Group fields by section.
-
atkNode::hasFlag()
-
Checks if the node has a certain flag set.
-
atkNode::helpUrl()
-
Get the help url for this node.
-
atkNode::hideForm()
-
Function outputs a form with all values hidden.
-
atkNode::init()
-
This function initialises certain elements of the node.
-
atkNode::initial_values()
-
Retrieve the initial values for a new record.
-
atkNode::injectSections()
-
Add sections to the edit/view fields array.
-
atkNode::isAllowedQueryList()
-
Checks if the attribute is needed in a select query
-
atkNode::isPartial()
-
Is partial request?
-
atkNode::lockPage()
-
Generate a box displaying a message that the current record is locked.
-
atkNode::modifyRecord()
-
Update a record with variables from a form posting.
-
atkNode::notify()
-
Notify all listeners of the occurance of a certain action.
-
atkNode::postAdd()
-
Function that is called by the framework, right after a new record has been saved to the database.
-
atkNode::postDel()
-
Deprecated function that is called by the framework, right after a record has been deleted.
-
atkNode::postDelete()
-
Function that is called by the framework, right after a record has been deleted.
-
atkNode::postUpdate()
-
Function that is called by the framework, right after an existing record has been updated in the database.
-
atkNode::preAdd()
-
Function that is called by the framework, just before a new record will be saved to the database.
-
atkNode::preAddToEditArray()
-
The preAddToEditArray method is called from within the editArray
-
atkNode::preCopy()
-
Function that is called by the framework, right before a copied record is stored to the database.
-
atkNode::preDelete()
-
Function that is called by the framework, right before a record will be deleted. Should this method return false the deleting will halt.
-
atkNode::preNotify()
-
Notify all listeners in advance of the occurance of a certain action.
-
atkNode::preUpdate()
-
Function that is called by the framework, just before an existing record will be saved to the database.
-
atkNode::primaryKey()
-
Returns the primary key sql expression of a record.
-
atkNode::primaryKeyField()
-
Retrieve the name of the primary key attribute.
-
atkNode::primaryKeyTpl()
-
Returns a primary key template.
-
atkNode::recordActions()
-
Function that is called for each record in a recordlist, to determine what actions may be performed on the record.
-
atkNode::redirect()
-
Redirect the browser to a different location.
-
atkNode::remove()
-
Remove an attribute.
-
atkNode::removeDefaultExpandedSections()
-
Remove sections that must be expanded by default.
-
atkNode::removeFilter()
-
Search and remove a recordset filter.
-
atkNode::removeFlag()
-
Removes a flag from the node.
-
atkNode::renderActionPage()
-
Render a generic action.
-
atkNode::resolveColumn()
-
Resolve column for sections.
-
atkNode::resolveNodeTypeAndAction()
-
Resolves a possible node / action alias for the given node / action.
-
atkNode::resolveSection()
-
Resolve section. If a section is only prefixed by a dot this means we need to add the default tab before the dot.
-
atkNode::resolveSections()
-
Resolve sections.
-
atkNode::resolveSectionsTabsOrder()
-
Resolve sections, tabs and the order based on the given argument to the attribute add method.
-
atkNode::searchDb()
-
Search all records for the occurance of a certain expression.
-
atkNode::securityKey()
-
Retrieve the security key of an action.
-
atkNode::select()
-
Retrieve records from the database using a handy helper class. PHP5 only.
-
atkNode::selectDb()
-
Retrieve records from the database.
-
atkNode::setAttribSizes()
-
This function reads meta information from the database and initialises its attributes with the metadata.
-
atkNode::setAttributeOrder()
-
Sets an attributes order
-
atkNode::setDb()
-
Sets the database connection.
-
atkNode::setDefaultColumn()
-
Set default column name.
-
atkNode::setDefaultTab()
-
Set default tab being displayed in view/add/edit mode.
-
atkNode::setDescriptorHandler()
-
Set descriptor handler.
-
atkNode::setDescriptorTemplate()
-
Sets the descriptor template for this node.
-
atkNode::setEditableListAttributes()
-
Sets the editable list attributes. If you supply this method with one or more string arguments, all arguments are collected in an array. Else the first parameter will be used.
-
atkNode::setEditFieldPrefix()
-
Set the edit fieldprefix to use in atk
-
atkNode::setExtendedSearchAction()
-
Set extended search action.
-
atkNode::setFeedback()
-
Use this function to enable feedback for one or more actions.
-
atkNode::setFlags()
-
Set node flags.
-
atkNode::setIndex()
-
Create an alphabetical index.
-
atkNode::setLockMode()
-
Sets the lock mode.
-
atkNode::setMRASelectionMode()
-
Sets the multi-record-action selection mode. Can either be MRA_MULTI_SELECT (default), MRA_SINGLE_SELECT or MRA_NO_SELECT.
-
atkNode::setNumbering()
-
Sets numbering of the attributes to begin with the number that was passed to it, or defaults to 1.
-
atkNode::setOrder()
-
Set default sort order for the node.
-
atkNode::setPriorityActions()
-
Sets the possible multi-record-priority actions.
-
atkNode::setPriorityRange()
-
Sets the priority range, for multi-record-priority actions.
-
atkNode::setSearchAction()
-
Sets the search action.
-
atkNode::setSecurityAlias()
-
Set the security alias of a node.
-
atkNode::setTabIndex()
-
Set tab index
-
atkNode::setTable()
-
Set the table that the node should use.
-
atkNode::statusbar()
-
Display a statusbar with a stacktrace and a help button.
-
atkNode::tabulate()
-
Place a set of tabs around content.
-
atkNode::text()
-
Translate using this node's module and type.
-
atkNode::trackChangesIfNeeded()
-
Called by updateDb to load the original record inside the record if the NF_TRACK_CHANGES flag is set.
-
atkNode::updateDb()
-
Update a record in the database.
-
atkNode::updateRecord()
-
Parse a set of url vars into a valid record structure.
-
atkNode::validate()
-
Validates a record.
-
atkNode::validateFilter()
-
Validates if a filter is valid for this node.
-
atkNode::viewArray()
-
Function outputs an array with view fields. For each field the array contains the name, view HTML code etc.
-
atkNode::_addListeners()
-
Add the listeners for the current node
-
atkNode::_storeAttributes()
-
Call the store() method on a list of attributes.
-
atkNode::__toString()
-
String representation for this node (PHP5 only).
|
Method Summary
| mixed |
getMetaOption() |
Returns the value for the meta option with the given name. |
| boolean |
_constructFromCache() |
Constructs the meta node from the cache if this node is cachable and the node structure has been cached. |
Methods
Old-style constructor for backwards-compatibility.
API Tags:
Constructor.
This constructor accepts a variety of parameters in different order. To make this possible (and for supporting passing parameters by reference) the constructor accepts an array which may contain the following fields:
- type node type
- table table name
- sequence sequence name
- db/database database name or instance
- policy meta policy, the meta policy to use ((sub-)class atkMetaPolicy instance)
- grammar meta grammar, the meta grammar to use ((sub-)class atkMetaGrammar instance)
- compiler meta compiler, the meta compiler to use ((sub-)class atkMetaCompiler instance)
- handler meta handler, handler which needs to be called instead of the default meta method
- flags node flags
- descriptor descriptor template for this node
- order (default) order to sort fields
- index create indexed navigation on a attribute/fieldname
- filter filter
- securityAlias security alias for this node
- securityMap security map for this node (will be added to the existing security map!)
- cacheable control whatever this meta node is cacheable (by default if the meta method is
defined static or there is no meta method defined the meta node is cacheable)
All of these variables can also be specified by creating a class variable with the same name. If you do so for flags, and have to use multiple flags, use an array of flags.
Parameters:
|
array |
$options: |
meta node options |
API Tags:
mixed getMetaOption(
string
$name, [mixed
$default = null]
)
|
|
Returns the value for the meta option with the given name.
Parameters:
|
string |
$name: |
meta option name |
|
mixed |
$default: |
fallback value |
API Tags:
| Return: | meta option value |
| Access: | public |
Is the node structure cacheable?
API Tags:
| Return: | cacheable? |
| Access: | public |
Post meta.
This method is called just after the node is constructed from the cache or using the meta policy and allows you to do some node initialization which cannot be done by the meta policy.
API Tags:
boolean _constructFromCache(
)
|
|
Constructs the meta node from the cache if this node is cachable and the node structure has been cached.
API Tags:
| Return: | is the node constructed from the cache? |
| Access: | private |
void _constructFromPolicy(
)
|
|
Constructs the meta node using the meta policy.
API Tags:
Create policy.
API Tags:
| Return: | policy |
| Access: | protected |