Docs For Class atkMlAttribute

Child Class	Description
atkMlNumberAttribute	The atkMlNumberAttribute class represents an multilanguage attribute of a node that can have a numeric value.
atkMlSelectorAttribute	The atkMlSelectorAttribute class represents more the less a dummy attribute, which makes it possible to select languages in a multilanguage form.
atkMlTextAttribute	The atkMlTextAttribute class represents an multilanguage attribute of a node that is a big text field.

[ Top ]

Inherited from parent

Inherited Properties	Inherited Methods
Inherited From atkAttribute atkAttribute::$m_column atkAttribute::$m_cssclasses atkAttribute::$m_dbfieldtype atkAttribute::$m_dependencies atkAttribute::$m_disabledModes atkAttribute::$m_editCallback atkAttribute::$m_flags atkAttribute::$m_forceinsert atkAttribute::$m_forcereload atkAttribute::$m_forceupdate atkAttribute::$m_htmlid atkAttribute::$m_index atkAttribute::$m_initialValue atkAttribute::$m_initial_hidden atkAttribute::$m_jsObservers atkAttribute::$m_label atkAttribute::$m_loadType atkAttribute::$m_maxsize atkAttribute::$m_module atkAttribute::$m_name atkAttribute::$m_onchangecode atkAttribute::$m_onchangehandler_init atkAttribute::$m_order atkAttribute::$m_owner atkAttribute::$m_ownerInstance atkAttribute::$m_postfixlabel atkAttribute::$m_searchmode atkAttribute::$m_searchsize atkAttribute::$m_sections atkAttribute::$m_size atkAttribute::$m_storageType atkAttribute::$m_tabs atkAttribute::$m_viewCallback	Inherited From atkAttribute atkAttribute::atkAttribute() Constructor atkAttribute::addCSSClass() Add a CSS class for this attribute on an HTML form. atkAttribute::addDependee() Add a depended attribute for this attribute, which means the depended attribute will be refreshed (using Ajax) if the value for this attribute changes. atkAttribute::addDependency() Special case of an on-change handler which gets executed server-side and can manipulate the DOM using PHP wrapper methods available in the atkFormModifier class or by outputting JavaScript code directly. atkAttribute::addDisabledMode() Adds a disabled mode flag to the attribute (use DISABLED_VIEW and DISABLED_EDIT flags). atkAttribute::addFlag() Adds a flag to the attribute. atkAttribute::addOnChangeHandler() Add a javascript onchange event handler. atkAttribute::addToEditArray() Adds the attribute's edit / hide HTML code to the edit array. atkAttribute::addToListArrayHeader() Adds the attribute / field to the list header. This includes the column name and search field. atkAttribute::addToListArrayRow() Adds the attribute / field to the list row. And if the row is totalisable also to the total. atkAttribute::addToQuery() Adds this attribute to database queries. atkAttribute::addToSearchformFields() Adds the needed searchbox(es) for this attribute to the fields array. This method should only be called by the atkSearchHandler. atkAttribute::addToViewArray() Adds the attribute's view / hide HTML code to the view array. atkAttribute::db2value() Converts a database value to an internal value. atkAttribute::dbFieldSize() Return the size of the field in the database. atkAttribute::dbFieldType() Return the database field type of the attribute. atkAttribute::delete() The delete method is called by the framework to inform the attribute that a record is deleted. atkAttribute::deleteAllowed() Check if delete of the record is allowed. atkAttribute::display() Returns a displayable string for this value, to be used in HTML pages. atkAttribute::edit() Returns a piece of html code that can be used in a form to edit this attribute's value. atkAttribute::equal() This function is called to compare if two records are considered equal by this attribute. atkAttribute::escapeSQL() Escape string for use in a query. atkAttribute::extendedSort() Retrieves the sort options and sort order. atkAttribute::fetchMeta() Fetch the metadata about this attrib from the table metadata, and process it. atkAttribute::fetchValue() Convert values from an HTML form posting to an internal value for this attribute. atkAttribute::fieldName() Returns the name of the attribute. atkAttribute::formName() Retrieve the name of the attribute in HTML forms. atkAttribute::getAdditionalTabs() Get list of additional tabs. atkAttribute::getAttributeHtmlId() Returns the html identifier of the attribute without setting it Created because getHtmlId would always SET the htmlid while getting it. atkAttribute::getColumn() Get column. atkAttribute::getCSSClassAttribute() Retrieve the attribute for the HTML-tag for this atkAttribute. atkAttribute::getCSSClasses() Retrieve the CSS classes that were registered for this attribute atkAttribute::getDb() Get database instance for this attribute. Will return the owner instance database instance unless the owner instance is not set in which case the default instance will be returned. atkAttribute::getDependencies() Retrieve the dependees for this attribute. atkAttribute::getEdit() Retrieve the HTML code for placing this attribute in an edit page. atkAttribute::getEditCallback() Returns the edit callback (if set). atkAttribute::getError() Check if this attribute has errors in the specified error list. atkAttribute::getFlags() Returns the full set of flags of the attribute. atkAttribute::getForceInsert() Getter for wether or not an attribute is forced to insert atkAttribute::getForceUpdate() Getter for wether or not an attribute is forced to update atkAttribute::getHtmlId() Return the html identifier (id="") of the attribute. (unique within a atkAttribute::getLabel() Get the HTML label of the attribute. atkAttribute::getModule() Get the module that this attribute originated from. atkAttribute::getOrderByStatement() Retrieves the ORDER BY statement for this attribute's node. atkAttribute::getOwnerInstance() Returns the owner instance. atkAttribute::getSearchCondition() Creates a searchcondition for the field, was once part of searchCondition, however, searchcondition() also immediately adds the search condition. atkAttribute::getSearchFieldName() Retrieve the fieldname of the attribute in an atksearch form. atkAttribute::getSearchMode() Retrieve the current set or default searchmode of this attribute atkAttribute::getSearchModeFieldname() Retrieve the searchmode name of the attribute in an atksearch form. atkAttribute::getSearchModes() Retrieve the list of searchmodes supported by the attribute. atkAttribute::getSections() retrieve the tabs and/or sections for this attribute. atkAttribute::getTabs() retrieve the tabs for this attribute. atkAttribute::getToolTip() Retrieve the html/javascript code for showing the tooltip for this attribute. atkAttribute::getView() Retrieve the html code for placing this attribute in a view page. atkAttribute::getViewCallback() Returns the view callback (if set). atkAttribute::hasDisabledMode() Check if the attribute is disabled in some mode (use DISABLED_VIEW and DISABLED_EDIT flags). atkAttribute::hasFlag() Check if the attribute has a certain flag. atkAttribute::hasStore() This function is used to check whether a attribute has a store function or not. atkAttribute::hide() Returns a piece of html code for hiding this attribute in an HTML form, while still posting its value. (<input type="hidden">) atkAttribute::init() This function is called right after the attribute is added to the node. atkAttribute::initDependencies() Initialize and calls the dependencies. atkAttribute::initialValue() Initial value. Returns the initial value for this attribute which will be used in the add form etc. atkAttribute::isEmpty() Check if a record has an empty value for this attribute. atkAttribute::isInitialHidden() check whether initially hidden or not atkAttribute::isNotNullInDb() Checks if this attribute is really not null in the database. atkAttribute::isPosted() Is there a value posted for this attribute? atkAttribute::label() Return the label of the attribute. atkAttribute::listHeaderSortOrder() Retrieve the sortorder for the listheader based on the atkColumnConfig atkAttribute::loadType() Determine the load type of this attribute. atkAttribute::maxInputSize() Determine the maximum length an input field may be. atkAttribute::needsInsert() This function is called by the framework to determine if the attribute needs to be saved to the database in an addDb call. atkAttribute::needsReload() This function is called by the framework to determine if the attribute needs to be updated from the db regardless of the attribute being present in the postvars/session atkAttribute::needsUpdate() This function is called by the framework to determine if the attribute needs to be saved to the database in an updateDb call. atkAttribute::observeJS() Observe the given JavaScript event and execute the given JavaScript statements when the event occurs. atkAttribute::parseStringValue() Convert a String representation into an internal value. atkAttribute::partial() Handle a partial request for this attribute, different attributes support different partials. atkAttribute::partial_dependencies() Call dependencies for this attribute and output JavaScript. atkAttribute::partial_refresh() Partial method to refresh the add/edit field for this attribute. atkAttribute::postInit() This function is called at the end of the node's init method. atkAttribute::preAddToEditArray() Prepare for edit. Is called before all attributes are added to the edit array and allows for last minute manipulations based on the record but also manipulations on the record itself. atkAttribute::preAddToViewArray() Prepare for view. Is called before all attributes are added to the view array and allows for last minute manipulations based on the record but also manipulations on the record itself. atkAttribute::registerJavaScriptObservers() Register JavaScript event handlers. atkAttribute::registerKeyListener() Register keyboard navigation for this attribute. atkAttribute::removeDisabledMode() Removes a disabled mode from the attribute. atkAttribute::removeFlag() Removes a flag from the attribute. atkAttribute::search() Returns a piece of html code that can be used to get search terms input from the user. atkAttribute::searchCondition() Creates a search condition for a given search value, and adds it to the query that will be used for performing the actual search. atkAttribute::searchMode() Returns piece of html which is used for setting/selecting the search mode for this attribute. atkAttribute::setAttribSize() Set the size(s) of the attribute atkAttribute::setAttributeSearchmode() Sets the searchmode for an attribute This will cause attributes that respect this to use the attributes searchmode for that particulair attribute instead of the general searchmode. atkAttribute::setColumn() Set column. atkAttribute::setDisabledModes() Sets the disabled mode flag of the attribute atkAttribute::setEditCallback() Sets the edit callback. atkAttribute::setFlags() Sets the flags of the attribute atkAttribute::setForceInsert() Used to force an attribute to update with every addDb() call atkAttribute::setForceReload() Used to force an attribute to update from the db regardless of the atkAttribute::setForceUpdate() Used to force an attribute to update with every updateDb() call atkAttribute::setInitialHidden() Set whether initially hidden or not. A field is "hidden" by adding the class atkAttrRowHidden. atkAttribute::setInitialValue() Set initial value for this attribute. atkAttribute::setLabel() Set the label of the attribute atkAttribute::setLoadType() Sets the load type. atkAttribute::setOwnerInstance() Sets the owner instance. atkAttribute::setPostFixLabel() Set the label of the attribute atkAttribute::setSections() Put the attribute on one or more tabs and/or sections. atkAttribute::setStorageType() Sets the storage type. atkAttribute::setTabs() Put the attribute on one or more tabs. atkAttribute::setViewCallback() Sets the view callback. atkAttribute::showOnTab() Check if the attribute wants to be shown on a certain tab. atkAttribute::smartSearchCondition() Creates a smart search condition for a given search value, and adds it to the query that will be used for performing the actual search. atkAttribute::sortOptions() Retrieves the sort options for this attribute which is used in recordlists and search actions. atkAttribute::sortOrder() Sets the sortorder options for this attribute which is used in recordlists and search actions. atkAttribute::storageType() Determine the storage type of this attribute. atkAttribute::sum() Calculate the sum of 2 records. atkAttribute::text() Translate using the owner instance's module and type. atkAttribute::validate() Checks if a value is valid. atkAttribute::value2db() Converts the internal attribute value to one that is understood by the database. atkAttribute::_callDependencies() Calls the dependency callbacks for this attribute. atkAttribute::_renderChangeHandler() Renders the onchange code on the page. atkAttribute::__toString() String representation for this attribute (PHP5 only).

Inherited Properties

Inherited Methods

Inherited From atkAttribute

atkAttribute::$m_column

atkAttribute::$m_cssclasses

atkAttribute::$m_dbfieldtype

atkAttribute::$m_dependencies

atkAttribute::$m_disabledModes

atkAttribute::$m_editCallback

atkAttribute::$m_flags

atkAttribute::$m_forceinsert

atkAttribute::$m_forcereload

atkAttribute::$m_forceupdate

atkAttribute::$m_htmlid

atkAttribute::$m_index

atkAttribute::$m_initialValue

atkAttribute::$m_initial_hidden

atkAttribute::$m_jsObservers

atkAttribute::$m_label

atkAttribute::$m_loadType

atkAttribute::$m_maxsize

atkAttribute::$m_module

atkAttribute::$m_name

atkAttribute::$m_onchangecode

atkAttribute::$m_onchangehandler_init

atkAttribute::$m_order

atkAttribute::$m_owner

atkAttribute::$m_ownerInstance

atkAttribute::$m_postfixlabel

atkAttribute::$m_searchmode

atkAttribute::$m_searchsize

atkAttribute::$m_sections

atkAttribute::$m_size

atkAttribute::$m_storageType

atkAttribute::$m_tabs

atkAttribute::$m_viewCallback

Inherited From atkAttribute

atkAttribute::atkAttribute()

Constructor

atkAttribute::addCSSClass()

Add a CSS class for this attribute on an HTML form.

atkAttribute::addDependee()

Add a depended attribute for this attribute, which means the depended attribute will be refreshed (using Ajax) if the value for this attribute changes.

atkAttribute::addDependency()

Special case of an on-change handler which gets executed server-side and can manipulate the DOM using PHP wrapper methods available in the atkFormModifier class or by outputting JavaScript code directly.

atkAttribute::addDisabledMode()

Adds a disabled mode flag to the attribute (use DISABLED_VIEW and DISABLED_EDIT flags).

atkAttribute::addFlag()

Adds a flag to the attribute.

atkAttribute::addOnChangeHandler()

Add a javascript onchange event handler.

atkAttribute::addToEditArray()

Adds the attribute's edit / hide HTML code to the edit array.

atkAttribute::addToListArrayHeader()

Adds the attribute / field to the list header. This includes the column name and search field.

atkAttribute::addToListArrayRow()

Adds the attribute / field to the list row. And if the row is totalisable also to the total.

atkAttribute::addToQuery()

Adds this attribute to database queries.

atkAttribute::addToSearchformFields()

Adds the needed searchbox(es) for this attribute to the fields array. This method should only be called by the atkSearchHandler.

atkAttribute::addToViewArray()

Adds the attribute's view / hide HTML code to the view array.

atkAttribute::db2value()

Converts a database value to an internal value.

atkAttribute::dbFieldSize()

Return the size of the field in the database.

atkAttribute::dbFieldType()

Return the database field type of the attribute.

atkAttribute::delete()

The delete method is called by the framework to inform the attribute that a record is deleted.

atkAttribute::deleteAllowed()

Check if delete of the record is allowed.

atkAttribute::display()

Returns a displayable string for this value, to be used in HTML pages.

atkAttribute::edit()

Returns a piece of html code that can be used in a form to edit this attribute's value.

atkAttribute::equal()

This function is called to compare if two records are considered equal by this attribute.

atkAttribute::escapeSQL()

Escape string for use in a query.

atkAttribute::extendedSort()

Retrieves the sort options and sort order.

atkAttribute::fetchMeta()

Fetch the metadata about this attrib from the table metadata, and process it.

atkAttribute::fetchValue()

Convert values from an HTML form posting to an internal value for this attribute.

atkAttribute::fieldName()

Returns the name of the attribute.

atkAttribute::formName()

Retrieve the name of the attribute in HTML forms.

atkAttribute::getAdditionalTabs()

Get list of additional tabs.

atkAttribute::getAttributeHtmlId()

Returns the html identifier of the attribute without setting it Created because getHtmlId would always SET the htmlid while getting it.

atkAttribute::getColumn()

Get column.

atkAttribute::getCSSClassAttribute()

Retrieve the attribute for the HTML-tag for this atkAttribute.

atkAttribute::getCSSClasses()

Retrieve the CSS classes that were registered for this attribute

atkAttribute::getDb()

Get database instance for this attribute. Will return the owner instance database instance unless the owner instance is not set in which case the default instance will be returned.

atkAttribute::getDependencies()

Retrieve the dependees for this attribute.

atkAttribute::getEdit()

Retrieve the HTML code for placing this attribute in an edit page.

atkAttribute::getEditCallback()

Returns the edit callback (if set).

atkAttribute::getError()

Check if this attribute has errors in the specified error list.

atkAttribute::getFlags()

Returns the full set of flags of the attribute.

atkAttribute::getForceInsert()

Getter for wether or not an attribute is forced to insert

atkAttribute::getForceUpdate()

Getter for wether or not an attribute is forced to update

atkAttribute::getHtmlId()

Return the html identifier (id="") of the attribute. (unique within a

atkAttribute::getLabel()

Get the HTML label of the attribute.

atkAttribute::getModule()

Get the module that this attribute originated from.

atkAttribute::getOrderByStatement()

Retrieves the ORDER BY statement for this attribute's node.

atkAttribute::getOwnerInstance()

Returns the owner instance.

atkAttribute::getSearchCondition()

Creates a searchcondition for the field, was once part of searchCondition, however, searchcondition() also immediately adds the search condition.

atkAttribute::getSearchFieldName()

Retrieve the fieldname of the attribute in an atksearch form.

atkAttribute::getSearchMode()

Retrieve the current set or default searchmode of this attribute

atkAttribute::getSearchModeFieldname()

Retrieve the searchmode name of the attribute in an atksearch form.

atkAttribute::getSearchModes()

Retrieve the list of searchmodes supported by the attribute.

atkAttribute::getSections()

retrieve the tabs and/or sections for this attribute.

atkAttribute::getTabs()

retrieve the tabs for this attribute.

atkAttribute::getToolTip()

Retrieve the html/javascript code for showing the tooltip for this attribute.

atkAttribute::getView()

Retrieve the html code for placing this attribute in a view page.

atkAttribute::getViewCallback()

Returns the view callback (if set).

atkAttribute::hasDisabledMode()

Check if the attribute is disabled in some mode (use DISABLED_VIEW and DISABLED_EDIT flags).

atkAttribute::hasFlag()

Check if the attribute has a certain flag.

atkAttribute::hasStore()

This function is used to check whether a attribute has a store function or not.

atkAttribute::hide()

Returns a piece of html code for hiding this attribute in an HTML form, while still posting its value. (<input type="hidden">)

atkAttribute::init()

This function is called right after the attribute is added to the node.

atkAttribute::initDependencies()

Initialize and calls the dependencies.

atkAttribute::initialValue()

Initial value. Returns the initial value for this attribute which will be used in the add form etc.

atkAttribute::isEmpty()

Check if a record has an empty value for this attribute.

atkAttribute::isInitialHidden()

check whether initially hidden or not

atkAttribute::isNotNullInDb()

Checks if this attribute is really not null in the database.

atkAttribute::isPosted()

Is there a value posted for this attribute?

atkAttribute::label()

Return the label of the attribute.

atkAttribute::listHeaderSortOrder()

Retrieve the sortorder for the listheader based on the atkColumnConfig

atkAttribute::loadType()

Determine the load type of this attribute.

atkAttribute::maxInputSize()

Determine the maximum length an input field may be.

atkAttribute::needsInsert()

This function is called by the framework to determine if the attribute needs to be saved to the database in an addDb call.

atkAttribute::needsReload()

This function is called by the framework to determine if the attribute needs to be updated from the db regardless of the attribute being present in the postvars/session

atkAttribute::needsUpdate()

This function is called by the framework to determine if the attribute needs to be saved to the database in an updateDb call.

atkAttribute::observeJS()

Observe the given JavaScript event and execute the given JavaScript statements when the event occurs.

atkAttribute::parseStringValue()

Convert a String representation into an internal value.

atkAttribute::partial()

Handle a partial request for this attribute, different attributes support different partials.

atkAttribute::partial_dependencies()

Call dependencies for this attribute and output JavaScript.

atkAttribute::partial_refresh()

Partial method to refresh the add/edit field for this attribute.

atkAttribute::postInit()

This function is called at the end of the node's init method.

atkAttribute::preAddToEditArray()

Prepare for edit. Is called before all attributes are added to the edit array and allows for last minute manipulations based on the record but also manipulations on the record itself.

atkAttribute::preAddToViewArray()

Prepare for view. Is called before all attributes are added to the view array and allows for last minute manipulations based on the record but also manipulations on the record itself.

atkAttribute::registerJavaScriptObservers()

Register JavaScript event handlers.

atkAttribute::registerKeyListener()

Register keyboard navigation for this attribute.

atkAttribute::removeDisabledMode()

Removes a disabled mode from the attribute.

atkAttribute::removeFlag()

Removes a flag from the attribute.

atkAttribute::search()

Returns a piece of html code that can be used to get search terms input from the user.

atkAttribute::searchCondition()

Creates a search condition for a given search value, and adds it to the query that will be used for performing the actual search.

atkAttribute::searchMode()

Returns piece of html which is used for setting/selecting the search mode for this attribute.

atkAttribute::setAttribSize()

Set the size(s) of the attribute

atkAttribute::setAttributeSearchmode()

Sets the searchmode for an attribute This will cause attributes that respect this to use the attributes searchmode for that particulair attribute instead of the general searchmode.

atkAttribute::setColumn()

Set column.

atkAttribute::setDisabledModes()

Sets the disabled mode flag of the attribute

atkAttribute::setEditCallback()

Sets the edit callback.

atkAttribute::setFlags()

Sets the flags of the attribute

atkAttribute::setForceInsert()

Used to force an attribute to update with every addDb() call

atkAttribute::setForceReload()

Used to force an attribute to update from the db regardless of the

atkAttribute::setForceUpdate()

Used to force an attribute to update with every updateDb() call

atkAttribute::setInitialHidden()

Set whether initially hidden or not. A field is "hidden" by adding the class atkAttrRowHidden.

atkAttribute::setInitialValue()

Set initial value for this attribute.

atkAttribute::setLabel()

Set the label of the attribute

atkAttribute::setLoadType()

Sets the load type.

atkAttribute::setOwnerInstance()

Sets the owner instance.

atkAttribute::setPostFixLabel()

Set the label of the attribute

atkAttribute::setSections()

Put the attribute on one or more tabs and/or sections.

atkAttribute::setStorageType()

Sets the storage type.

atkAttribute::setTabs()

Put the attribute on one or more tabs.

atkAttribute::setViewCallback()

Sets the view callback.

atkAttribute::showOnTab()

Check if the attribute wants to be shown on a certain tab.

atkAttribute::smartSearchCondition()

Creates a smart search condition for a given search value, and adds it to the query that will be used for performing the actual search.

atkAttribute::sortOptions()

Retrieves the sort options for this attribute which is used in recordlists and search actions.

atkAttribute::sortOrder()

Sets the sortorder options for this attribute which is used in recordlists and search actions.

atkAttribute::storageType()

Determine the storage type of this attribute.

atkAttribute::sum()

Calculate the sum of 2 records.

atkAttribute::text()

Translate using the owner instance's module and type.

atkAttribute::validate()

Checks if a value is valid.

atkAttribute::value2db()

Converts the internal attribute value to one that is understood by the database.

atkAttribute::_callDependencies()

Calls the dependency callbacks for this attribute.

atkAttribute::_renderChangeHandler()

Renders the onchange code on the page.

atkAttribute::__toString()

String representation for this attribute (PHP5 only).

[ Top ]

Property Summary

mixed	$m_edited
mixed	$m_language
mixed	$m_languages
mixed	$m_mlattribute

[ Top ]

Method Summary

atkMlAttribute	atkMlAttribute()	Constructor
void	addToEditArray()	Adds the attribute's edit / hide HTML code to the edit array.
void	addToQuery()	Adds this attribute to database queries.
array	db2value()	Removes slashes from the strings
string	display()	Returns a displayable string for this value.
piece	edit()	Returns a piece of html code that can be used in a form to edit this attribute's value (one box which can be used for all the languages).
void	fetchMeta()	Fetch the metadata about this attrib from the table metadata
array	fetchValue()	Fetch values
array	getLanguages()	Return the possible languages
String	getSearchCondition()	Creates a searchcondition for the field, was once part of searchCondition, however, searchcondition() also immediately adds the search condition.
the	getValue()	Get the value of this attribute for the given language
Piece	hide()	Returns a piece of html code that can be used in a form to display hidden values for this attribute.
boolean	isEmpty()	Check if the attribute is empty for all languages
boolean	isMlNode()	Is the node an multilanguage node?
piece	search()	Returns a piece of html code that can be used to search the attribute.
String	value2db()	Converts the internal attribute value to one that is understood by the database.

[ Top ]

Properties

mixed $m_edited = false [line 30]

[ Top ]

mixed $m_language = "" [line 28]

[ Top ]

mixed $m_languages = array() [line 31]

[ Top ]

mixed $m_mlattribute = TRUE [line 29]

[ Top ]

Methods

Constructor atkMlAttribute [line 39]

atkMlAttribute atkMlAttribute(
string
$name, [int
$flags = 0], [int
$size = 0] 
)

Constructor

Parameters:

string	$name:	name of the attribute
int	$flags:	flags for the attribute
int	$size:	The size of the attribute

[ Top ]

addToEditArray [line 127]

void addToEditArray(
String
$mode, 
&$arr, 
&$defaults, 
&$error, String
$fieldprefix, array
$arr, array
$defaults, array
$error 
)

Adds the attribute's edit / hide HTML code to the edit array.

This method is called by the node if it wants the data needed to create an edit form.

Parameters:

String	$mode:	the edit mode ("add" or "edit")
array	$arr:	pointer to the edit array
array	$defaults:	pointer to the default values array
array	$error:	pointer to the error array
String	$fieldprefix:	the fieldprefix
	&$arr:
	&$defaults:
	&$error:

Redefinition of:

atkAttribute::addToEditArray(): Adds the attribute's edit / hide HTML code to the edit array.

Redefined in descendants as:

atkMlSelectorAttribute::addToEditArray() : Adds the attribute's edit / hide HTML code to the edit array.
atkMlTextAttribute::addToEditArray() : Adds the attribute's edit / hide HTML code to the edit array.
atkMlFckAttribute::addToEditArray() : Adds the attribute's edit / hide HTML code to the edit array.

[ Top ]

addToQuery [line 335]

void addToQuery(

&$query, [String
$tablename = ""], [String
$fieldaliasprefix = ""], Array
$rec, int
$level, String
$mode, atkQuery
$query 
)

Adds this attribute to database queries.

Database queries (select, insert and update) are passed to this method so the attribute can 'hook' itself into the query.

Parameters:

atkQuery	$query:	The SQL query object
String	$tablename:	The name of the table of this attribute
String	$fieldaliasprefix:	Prefix to use in front of the alias in the query.
Array	$rec:	The record that contains the value of this attribute.
int	$level:	Recursion level if relations point to eachother, an endless loop could occur if they keep loading eachothers data. The $level is used to detect this loop. If overriden in a derived class, any subcall to an addToQuery method should pass the $level+1.
String	$mode:	Indicates what kind of query is being processing: This can be any action performed on a node (edit, add, etc) Mind you that "add" and "update" are the actions that store something in the database, whereas the rest are probably select queries.
	&$query:

Redefinition of:

atkAttribute::addToQuery(): Adds this attribute to database queries.

Redefined in descendants as:

atkMlSelectorAttribute::addToQuery() : No function, but is necessary

[ Top ]

db2value [line 257]

array db2value(
array
$rec 
)

Removes slashes from the strings

Parameters:

array

$rec:

array with values

API Tags:

Return:

with string without slashes

Redefinition of:

atkAttribute::db2value(): Converts a database value to an internal value.

[ Top ]

display [line 205]

string display(
array
$record 
)

Returns a displayable string for this value.

We always display the first language only.

Parameters:

array

$record:

array with values

API Tags:

Return:

ready for displaying

Redefinition of:

atkAttribute::display(): Returns a displayable string for this value, to be used in HTML pages.

Redefined in descendants as:

atkMlHtmlAttribute::display() : Returns a displayable string for this value.

[ Top ]

edit [line 89]

piece edit(
[array
$record = ""], [string
$fieldprefix = ""], [string
$mode = ""] 
)

Returns a piece of html code that can be used in a form to edit this attribute's value (one box which can be used for all the languages).

Parameters:

array	$record:	array with values
string	$fieldprefix:	The fieldprefix to put in front of the name of any html form element for this attribute.
string	$mode:	The mode we're in ('add' or 'edit')

API Tags:

Return:

of html code

Redefinition of:

atkAttribute::edit(): Returns a piece of html code that can be used in a form to edit this attribute's value.

Redefined in descendants as:

atkMlSelectorAttribute::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.
atkMlTextAttribute::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.
atkMlFckAttribute::edit() : Returns the piece of HTML that can be used to edit the field's value. In this particular occassion we will include the FCK library and setup the right parameters for this particular set of editors.

[ Top ]

fetchMeta [line 369]

void fetchMeta(
array
$metadata 
)

Fetch the metadata about this attrib from the table metadata

Parameters:

array

$metadata:

The table metadata from the table for this attribute.

Redefinition of:

atkAttribute::fetchMeta(): Fetch the metadata about this attrib from the table metadata, and process it.

[ Top ]

fetchValue [line 295]

array fetchValue(
array
$rec 
)

Fetch values

Parameters:

array

$rec:

array with values

API Tags:

Return:

with values

Redefinition of:

atkAttribute::fetchValue(): Convert values from an HTML form posting to an internal value for this attribute.

[ Top ]

getLanguages [line 75]

array getLanguages(
)

Return the possible languages

API Tags:

Return:

with supported languages

[ Top ]

getSearchCondition [line 392]

String getSearchCondition(

&$query, String
$table, mixed
$value, String
$searchmode, atkQuery
$query 
)

Creates a searchcondition for the field, was once part of searchCondition, however, searchcondition() also immediately adds the search condition.

Parameters:

atkQuery	$query:	The query object where the search condition should be placed on
String	$table:	The name of the table in which this attribute is stored
mixed	$value:	The value the user has entered in the searchbox
String	$searchmode:	The searchmode to use. This can be any one of the supported modes, as returned by this attribute's getSearchModes() method.
	&$query:

API Tags:

Return:

The searchcondition to use.

Redefinition of:

atkAttribute::getSearchCondition(): Creates a searchcondition for the field, was once part of searchCondition, however, searchcondition() also immediately adds the search condition.

[ Top ]

getValue [line 54]

the getValue(
array
$rec, [string
$language = ""] 
)

Get the value of this attribute for the given language

Parameters:

array	$rec:	The record
string	$language:	The language

API Tags:

Return:

value of this attribute for the given languager

[ Top ]

hide [line 224]

Piece hide(
[array
$record = ""] 
)

Returns a piece of html code that can be used in a form to display hidden values for this attribute.

Parameters:

array

$record:

Array with values

API Tags:

Return:

of htmlcode

Redefinition of:

atkAttribute::hide(): Returns a piece of html code for hiding this attribute in an HTML form, while still posting its value. (<input type="hidden">)

Redefined in descendants as:

atkMlSelectorAttribute::hide() : Returns a piece of html code that can be used in a form to display hidden values for this attribute.

[ Top ]

isEmpty [line 188]

boolean isEmpty(
array
$record 
)

Check if the attribute is empty for all languages

Parameters:

array

$record:

Current record

API Tags:

Return:

true if it's empty

Redefinition of:

atkAttribute::isEmpty(): Check if a record has an empty value for this attribute.

[ Top ]

isMlNode [line 65]

boolean isMlNode(
)

Is the node an multilanguage node?

[ Top ]

search [line 168]

piece search(
[array
$record = ""], [boolean
$extended = false], [string
$fieldprefix = ""] 
)

Returns a piece of html code that can be used to search the attribute.

We will use the default language for this!

Parameters:

array	$record:	array with values
boolean	$extended:	if set to false, a simple search input is returned for use in the searchbar of the recordlist. If set to true, a more extended search may be returned for the 'extended' search page. The atkAttribute does not make a difference for $extended is true, but derived attributes may reimplement this.
string	$fieldprefix:	The fieldprefix of this attribute's HTML element.

API Tags:

Return:

of htmlcode

Redefinition of:

atkAttribute::search(): Returns a piece of html code that can be used to get search terms input from the user.

Redefined in descendants as:

atkMlSelectorAttribute::search() : Search language selector

[ Top ]

value2db [line 243]

String value2db(
array
$rec 
)

Converts the internal attribute value to one that is understood by the database.

Parameters:

array

$rec:

The record that holds this attribute's value.

API Tags:

Return:

The database compatible value

Redefinition of:

atkAttribute::value2db(): Converts the internal attribute value to one that is understood by the database.

Redefined in descendants as:

atkMlFckAttribute::value2db() : Converts the internal attribute value to one that is understood by the database.

[ Top ]