Docs For Class atkAttribute

Child Class	Description
atkAggregatedColumn	The atkAggregatedColumn aggregates multiple attributes to one colunm in list view. The attribute displays and sorts according to the $template parameter and searches in fields, indicated in $searchfields array parameter.
atkBoolAttribute	The atkBoolAttribute class represents an attribute of a node that can either be true or false.
atkCalculatorAttribute	a simple but flexible value calculator.
atkCaptchaAttribute	With the atkCaptchaAttribute class you can easily add a captcha to a forum or guestbook.
atkColorPickerAttribute	The atkColorPickerAttribute class represents an attribute of an atkNode.
atkDateAttribute	The atkDateAttribute class offers a date widget for date fields.
atkDateTimeAttribute	The atkDateTimeAttribute class can be used for date and time entry.
atkDummyAttribute	With the atkDummyAttribute class you can place comments between other attributes.
atkDurationAttribute	The atkDurationAttribute is an attribute for entering a length of time.
atkEmailAttribute	Attribute for editing email fields.
atkExpressionAttribute	With the atkExpressionAttribute class you can select arbitrary SQL expressions like subqueries etc. It's not possible to save values using this attribute.
atkFieldSet	A fieldset can be used to combine multiple attributes to a single attribute in edit/view mode.
atkFileAttribute	With this you can upload, select and remove files in a given directory.
atkFormatAttribute	The atkFormatAttribute can be used to edit a formatted string.
atkFuzzySearchAttribute	The atkFuzzySearchAttribute class represents an attribute of a node that has a field where you can enter certain keywords to search for on another node.
atkIpAttribute	The atkIpAttribute can be used to let the user enter IP(v4) addresses.
atkListAttribute	The atkListAttribute class represents an attribute of a node that has a selectbox to select from predefined values.
atkMlAttribute	The atkMlAttribute class represents an multilanguage attribute of an atkNode.
atkMlWrapper	Wrapper for turning any attribute into a multilanguage enabled attribute.
atkNumberAttribute	The atkNumberAttribute can be used for numeric values.
atkParserAttribute	The atkParserAttribute can be used to create links or texts that contain values, by supplying a template as parameter.
atkPasswordAttribute	The atkPasswordAttribute class represents an attribute of a node
atkProfileAttribute	The atkProfileAttribute is an attribute to edit a security profile.
atkRadioDetailsAttribute	Displays radio buttons with options to choose from just like the atkRadioAttribute but allows you to use other attributes for detail selections once certain options are selected.
atkTabbedPane	atkTabbedPane place regular attribute to the additional tabbed pane
atkTextAttribute	The atkTextAttribute class represents an attribute of a node that is a big text field.
atkTimeAttribute	The atkTimeAttribute class represents an attribute of a node that has a selectbox to select from predefined time values.
atkUrlAttribute	The atkUrlAttribute class represents a field containing URLs.
atkFilter	Abstract base class for atkFilters.
atkRelation	The atkRelation class defines a relation to another node.

[ Top ]

Property Summary

string	$m_column	Column.
sttsy	$m_cssclasses	The css classes of the attribute
String	$m_dbfieldtype	The database fieldtype.
Array	$m_dependees	Variable to store depended attributes.
int	$m_disabledModes	Attribute to store disabled modes.
int	$m_flags	The attribute flags (see above)
bool	$m_forceinsert	Wether to force an insert of the attribute
bool	$m_forceupdate	Wether to force an update of the attribute
String	$m_htmlid	The id of the attribute in the HTML
int	$m_index	Index of the attribute within its node.
mixed	$m_initialValue	Initial value.
bool	$m_initial_hidden	Whether to hide initially or not
String	$m_label	The label of the attribute.
int	$m_loadType	Load type.
mixed	$m_manual_paint	Manually painted attribute. Will not be rendered. If this is set to true, you are responsible for calling the attribute's edit() method to paint it on screen.
int	$m_maxsize	The maximum size the attribute's value may have in the database.
String	$m_module	The module of the attribute (if empty, the module from the owner node should be assumed).
String	$m_name	The name of the attribute
Array	$m_onchangecode	Array for containing onchange javascript code
String	$m_onchangehandler_init	Variable to store initialisation javascript code in for the changehandler.
int	$m_order	The order of the attribute within its node.
String	$m_owner	The name of the atkNode that owns this attribute (set by atknode)
atkNode	$m_ownerInstance	Instance of the atkNode that owns this attribute
String	$m_searchmode	The searchmode for this attribute
int	$m_searchsize	The size the attribute's search input field.
mixed	$m_sections	The section(s) on which the attribute lives.
int	$m_size	The size the attribute's field.
int	$m_storageType	Storage type.
mixed	$m_tabs	The tab(s) on which the attribute lives.

[ Top ]

Method Summary

atkAttribute	atkAttribute()	Constructor
void	addCSSClass()	Add a CSS class for this attribute on an HTML form.
atkAttribute	addDependee()	Indicate that another attribute depends on this attribute, and that if this attribute is updated, the dependent attribute needs to be updated as well.
void	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.
void	addToEditArray()	Adds the attribute's edit / hide HTML code to the edit array.
void	addToListArrayHeader()	Adds the attribute / field to the list header. This includes the column name and search field.
void	addToListArrayRow()	Adds the attribute / field to the list row. And if the row is totalisable also to the total.
void	addToQuery()	Adds this attribute to database queries.
void	addToSearchformFields()	Adds the needed searchbox(es) for this attribute to the fields array. This method should only be called by the atkSearchHandler.
void	addToViewArray()	Adds the attribute's view / hide HTML code to the view array.
mixed	db2value()	Converts a database value to an internal value.
int	dbFieldSize()	Return the size of the field in the database.
String	dbFieldType()	Return the database field type of the attribute.
boolean	delete()	The delete method is called by the framework to inform the attribute that a record is deleted.
boolean	deleteAllowed()	Check if delete of the record is allowed.
String	display()	Returns a displayable string for this value, to be used in HTML pages.
String	edit()	Returns a piece of html code that can be used in a form to edit this attribute's value.
boolean	equal()	This function is called to compare if two records are considered equal by this attribute.
String	escapeSQL()	Escape string for use in a query.
String	extendedSort()	Retrieves the sort options and sort order.
void	fetchMeta()	Fetch the metadata about this attrib from the table metadata, and process it.
String	fetchValue()	Convert values from an HTML form posting to an internal value for this attribute.
String	fieldName()	Returns the name of the attribute.
String	formName()	Retrieve the name of the attribute in HTML forms.
array	getAdditionalTabs()	Get list of additional tabs.
String	getAttributeHtmlId()	Returns the html identifier of the attribute without setting it Created because getHtmlId would always SET the htmlid while getting it.
string	getColumn()	Get column.
String	getCSSClassAttribute()	Retrieve the attribute for the HTML-tag for this atkAttribute.
Array	getCSSClasses()	Retrieve the CSS classes that were registered for this attribute
atkDb	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.
Array	getDependees()	Retrieve the dependees for this attribute.
String	getEdit()	Retrieve the HTML code for placing this attribute in an edit page.
boolean	getError()	Check if this attribute has errors in the specified error list.
int	getFlags()	Returns the full set of flags of the attribute.
bool	getForceInsert()	Getter for wether or not an attribute is forced to insert
bool	getForceUpdate()	Getter for wether or not an attribute is forced to update
String	getHtmlId()	Return the html identifier (id="") of the attribute. (unique within a
String	getLabel()	Get the HTML label of the attribute.
String	getModule()	Get the module that this attribute originated from.
String	getOrderByStatement()	Retrieves the ORDER BY statement for this attribute's node.
atkNode	&getOwnerInstance()	Returns the owner instance.
String	getRefreshCall()	Returns a JavaScript call for refreshing this attribute.
String	getSearchCondition()	Creates a searchcondition for the field, was once part of searchCondition, however, searchcondition() also immediately adds the search condition.
String	getSearchFieldName()	Retrieve the fieldname of the attribute in an atksearch form.
String	getSearchMode()	Retrieve the current set or default searchmode of this attribute
String	getSearchModeFieldname()	Retrieve the searchmode name of the attribute in an atksearch form.
array	getSearchModes()	Retrieve the list of searchmodes supported by the attribute.
array	getSections()	retrieve the tabs and/or sections for this attribute.
array	getTabs()	retrieve the tabs for this attribute.
String	getToolTip()	Retrieve the html/javascript code for showing the tooltip for this attribute.
String	getView()	Retrieve the html code for placing this attribute in a view page.
boolean	hasDisabledMode()	Check if the attribute is disabled in some mode (use DISABLED_VIEW and DISABLED_EDIT flags).
boolean	hasFlag()	Check if the attribute has a certain flag.
boolean	hasStore()	This function is used to check whether a attribute has a store function or not.
String	hide()	Returns a piece of html code for hiding this attribute in an HTML form, while still posting its value. (<input type="hidden">)
void	init()	This function is called right after the attribute is added to the node.
mixed	initialValue()	Initial value. Returns the initial value for this attribute which will be used in the add form etc.
boolean	isDepending()	Check whether this attribute depends on other attributes.
boolean	isEmpty()	Check if a record has an empty value for this attribute.
initially	isInitialHidden()	check whether initially hidden or not
bool	isManualPaint()	Check wether this attribute should be manually painted (call the edit method) or not.
boolean	isNotNullInDb()	Checks if this attribute is really not null in the database.
boolean	isPosted()	Is there a value posted for this attribute?
String	label()	Return the label of the attribute.
String	listHeaderSortOrder()	Retrieve the sortorder for the listheader based on the atkColumnConfig
int	loadType()	Determine the load type of this attribute.
int	maxInputSize()	Determine the maximum length an input field may be.
boolean	needsInsert()	This function is called by the framework to determine if the attribute needs to be saved to the database in an addDb call.
boolean	needsUpdate()	This function is called by the framework to determine if the attribute needs to be saved to the database in an updateDb call.
mixed	parseStringValue()	Convert a String representation into an internal value.
String	partial()	Handle a partial request for this attribute, different attributes support different partials.
String	partial_refresh()	Partial method to refresh the add/edit field for this attribute.
void	postInit()	This function is called at the end of the node's init method.
void	registerKeyListener()	Register keyboard navigation for this attribute.
void	removeDisabledMode()	Removes a disabled mode from the attribute.
atkAttribute	removeFlag()	Removes a flag from the attribute.
String	search()	Returns a piece of html code that can be used to get search terms input from the user.
void	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.
string	searchMode()	Returns piece of html which is used for setting/selecting the search mode for this attribute.
void	setAttribSize()	Set the size(s) of the attribute
void	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.
void	setColumn()	Set column.
void	setDisabledModes()	Sets the disabled mode flag of the attribute
void	setFlags()	Sets the flags of the attribute
atkAttribute	setForceInsert()	Used to force an attribute to update with every addDb() call
atkAttribute	setForceUpdate()	Used to force an attribute to update with every updateDb() call
void	setInitialHidden()	Set whether initially hidden or not. A field is "hidden" by adding the class atkAttrRowHidden.
void	setInitialValue()	Set initial value for this attribute.
atkAttribute	setLabel()	Set the label of the attribute
void	setLoadType()	Sets the load type.
void	setManualPaint()	Set wether the edit() method of this attribute should be called by the framework, or if the edit method is called manually.
void	setOwnerInstance()	Sets the owner instance.
void	setSections()	Put the attribute on one or more tabs and/or sections.
void	setStorageType()	Sets the storage type.
void	setTabs()	Put the attribute on one or more tabs.
boolean	showOnTab()	Check if the attribute wants to be shown on a certain tab.
void	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.
String	sortOptions()	Retrieves the sort options for this attribute which is used in recordlists and search actions.
String	sortOrder()	Sets the sortorder options for this attribute which is used in recordlists and search actions.
int	storageType()	Determine the storage type of this attribute.
array	sum()	Calculate the sum of 2 records.
String	text()	Translate using the owner instance's module and type.
void	validate()	Checks if a value is valid.
String	value2db()	Converts the internal attribute value to one that is understood by the database.
void	_registerDependees()	Register change handlers for dependees.
void	_renderChangeHandler()	Renders the onchange code on the page.
string	__toString()	String representation for this attribute (PHP5 only).

[ Top ]

Properties

string $m_column [line 583]

Column.

API Tags:

Access:

private

[ Top ]

sttsy $m_cssclasses = array() [line 476]

The css classes of the attribute

API Tags:

Access:

private

[ Top ]

String $m_dbfieldtype = "" [line 434]

The database fieldtype.

API Tags:

Access:

private

[ Top ]

Array $m_dependees = array() [line 531]

Variable to store depended attributes.

API Tags:

Access:

private

[ Top ]

int $m_disabledModes = 0 [line 538]

Attribute to store disabled modes.

API Tags:

Access:

private

[ Top ]

int $m_flags = 0 [line 383]

The attribute flags (see above)

API Tags:

Access:

private

[ Top ]

bool $m_forceinsert = false [line 502]

Wether to force an insert of the attribute

API Tags:

Access:

private

[ Top ]

bool $m_forceupdate = false [line 509]

Wether to force an update of the attribute

API Tags:

Access:

private

[ Top ]

String $m_htmlid [line 469]

The id of the attribute in the HTML

API Tags:

Access:

private

[ Top ]

int $m_index = 0 [line 448]

Index of the attribute within its node.

API Tags:

Access:

private

[ Top ]

mixed $m_initialValue = NULL [line 570]

Initial value.

API Tags:

See:	atkAttribute::setInitialValue()
Access:	private

[ Top ]

bool $m_initial_hidden = false [line 545]

Whether to hide initially or not

API Tags:

Access:

private

[ Top ]

String $m_label = "" [line 483]

The label of the attribute.

API Tags:

Access:

private

[ Top ]

int $m_loadType = array() [line 562]

Load type.

API Tags:

See:	atkAttribute::setLoadType()
Access:	private

[ Top ]

mixed $m_manual_paint = false [line 576]

Manually painted attribute. Will not be rendered. If this is set to true, you are responsible for calling the attribute's edit() method to paint it on screen.

[ Top ]

int $m_maxsize = 0 [line 427]

The maximum size the attribute's value may have in the database.

API Tags:

Access:

private

[ Top ]

String $m_module = "" [line 399]

The module of the attribute (if empty, the module from the owner node should be assumed).

API Tags:

Access:

private

[ Top ]

String $m_name [line 376]

The name of the attribute

API Tags:

Access:

private

[ Top ]

Array $m_onchangecode = array() [line 516]

Array for containing onchange javascript code

API Tags:

Access:

private

Redefined in descendants as:

atkDateAttribute::$m_onchangecode

[ Top ]

String $m_onchangehandler_init = "" [line 524]

Variable to store initialisation javascript code in for the changehandler.

API Tags:

Access:

private

Redefined in descendants as:

[ Top ]

int $m_order = 0 [line 441]

The order of the attribute within its node.

API Tags:

Access:

private

[ Top ]

String $m_owner = "" [line 390]

The name of the atkNode that owns this attribute (set by atknode)

API Tags:

Access:

private

[ Top ]

atkNode $m_ownerInstance = "" [line 406]

Instance of the atkNode that owns this attribute

API Tags:

Access:

private

[ Top ]

String $m_searchmode = "" [line 495]

The searchmode for this attribute

This var exists so that you can assign searchmodes to specific attributes instead of having a general searchmode for the entire search. This can be any one of the supported modes, as returned by the attribute's getSearchModes() method.

API Tags:

Access:

private

[ Top ]

int $m_searchsize = 0 [line 420]

The size the attribute's search input field.

API Tags:

Access:

private

[ Top ]

mixed $m_sections = "*" [line 462]

The section(s) on which the attribute lives.

API Tags:

Access:

private

[ Top ]

int $m_size = 0 [line 413]

The size the attribute's field.

API Tags:

Access:

private

Redefined in descendants as:

atkNumberAttribute::$m_size

[ Top ]

int $m_storageType = array() [line 553]

Storage type.

API Tags:

See:	atkAttribute::setStorageType()
Access:	private

[ Top ]

mixed $m_tabs = "*" [line 455]

The tab(s) on which the attribute lives.

API Tags:

Access:

private

[ Top ]

Methods

Constructor atkAttribute [line 607]

atkAttribute atkAttribute(
String
$name, [int
$flags = 0], [mixed
$size = 0] 
)

Constructor

Example: $this->add(new atkAttribute("name",AF_OBLIGATORY, 30));

Note: If you want to use the db/ddl utility class to automatically generate the table, the $size parameter must be set, for it will use the size specified here to determine the field length. (Derived classes might have reasonable default values, but the standard atkAttribute doesn't.)

Parameters:

String	$name:	Name of the attribute (unique within a node, and for most attributes, corresponds to a field in the database.
int	$flags:	Flags for the attribute.
mixed	$size:	The size(s) of the attribute. See the $size parameter of the setAttribSize() method for more information on the possible values of this parameter.

[ Top ]

addCSSClass [line 2721]

void addCSSClass(
String
$classname 
)

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

Parameters:

String

$classname:

The name of a class.

[ Top ]

addDependee [line 2613]

atkAttribute addDependee(
String
$attribName 
)

Indicate that another attribute depends on this attribute, and that if this attribute is updated, the dependent attribute needs to be updated as well.

(This is mostly relevant to Ajax calls.)

Parameters:

String

$attribName:

The attribute you wish to update.

API Tags:

Return:	Returns the current instance of the attribute
See:	atkAttribute::_registerDependees()

[ Top ]

addDisabledMode [line 721]

void addDisabledMode(
int
$flag 
)

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

Parameters:

int

$flag:

The flag to add to the attribute

[ Top ]

addFlag [line 666]

atkAttribute addFlag(
int
$flag 
)

Adds a flag to the attribute.

Note that adding flags at any time after the constructor might not always work. There are flags that are processed only at constructor time.

Parameters:

int

$flag:

The flag to add to the attribute

API Tags:

Return:

The instance of this atkAttribute

Redefined in descendants as:

atkBoolAttribute::addFlag() : Adds the AF_OBLIGATORY flag to the attribute.
atkDateAttribute::addFlag() : Override add flag so that we can set the initial value.
atkManyToOneRelation::addFlag() : Adds a flag to the manyToOne relation Note that adding flags at any time after the constructor might not always work. There are flags that are processed only at constructor time.
atkOneToManyRelation::addFlag()

[ Top ]

addOnChangeHandler [line 931]

atkAttribute addOnChangeHandler(
string
$jscode 
)

Add a javascript onchange event handler.

Parameters:

string

$jscode:

A block of valid javascript code.

API Tags:

Return:

Returns the instance of this attribute.

Redefined in descendants as:

atkDateAttribute::addOnChangeHandler() : Add a javascript onchange event handler.

[ Top ]

addToEditArray [line 1049]

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.

This is a framework method, it should never be called directly.

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:

Redefined in descendants as:

atkMlAttribute::addToEditArray() : Adds the attribute's edit / hide HTML code to the edit array.
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.
atkMlWrapper::addToEditArray() : Adds the attribute's edit / hide HTML code to the edit array.
atkManyToOneRelation::addToEditArray() : Adds the attribute's edit / hide HTML code to the edit array.
atkOneToOneRelation::addToEditArray() : Adds the attribute's edit / hide HTML code to the edit array.

[ Top ]

addToListArrayHeader [line 1307]

void addToListArrayHeader(
String
$action, 
&$arr, String
$fieldprefix, int
$flags, array
$atksearch, 
&$columnConfig, [atkDataGrid
$grid = null], array
$arr, atkColumnConfig
$columnConfig 
)

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

Framework method. It should not be necessary to call this method directly.

Parameters:

String	$action:	the action that is being performed on the node
array	$arr:	reference to the the recordlist array
String	$fieldprefix:	the fieldprefix
int	$flags:	the recordlist flags
array	$atksearch:	the current ATK search list (if not empty)
atkColumnConfig	$columnConfig:	Column configuration object
atkDataGrid	$grid:	The atkDataGrid this attribute lives on.
	&$arr:
	&$columnConfig:

API Tags:

See:

atkNode::listArray

Redefined in descendants as:

atkAggregatedColumn::addToListArrayHeader() : Adds the attribute / field to the list header. This includes the column name and search field.
atkManyToOneRelation::addToListArrayHeader() : Adds the attribute / field to the list header. This includes the column name and search field.
atkOneToOneRelation::addToListArrayHeader() : Adds the attribute / field to the list header. This includes the column name and search field.
atkSecureRelation::addToListArrayHeader() : Adds the attribute / field to the list header. This includes the column name and search field.

[ Top ]

addToListArrayRow [line 1353]

void addToListArrayRow(
String
$action, 
&$arr, int
$nr, String
$fieldprefix, int
$flags, [
$edit = false], array
$arr 
)

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

Framework method. It should not be necessary to call this method directly.

Parameters:

String	$action:	the action that is being performed on the node
array	$arr:	reference to the the recordlist array
int	$nr:	the current row number
String	$fieldprefix:	the fieldprefix
int	$flags:	the recordlist flags
	&$arr:
	$edit:

API Tags:

See:

atkNode::listArray

Redefined in descendants as:

atkManyToOneRelation::addToListArrayRow() : Adds the attribute / field to the list row. And if the row is totalisable also to the total.
atkOneToOneRelation::addToListArrayRow() : Adds the attribute / field to the list row. And if the row is totalisable also to the total.

[ Top ]

addToQuery [line 1667]

void addToQuery(

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

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.

Framework method. It should not be necessary to call this method directly. Derived attributes that consist of more than a single simple database field (like relations for example), may have to reimplement this method.

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:
	&$rec:

Redefined in descendants as:

atkAggregatedColumn::addToQuery() : Adds this attribute to database queries.
atkDateAttribute::addToQuery() : Adds this attribute to database queries.
atkDateTimeAttribute::addToQuery() : Adds this attribute to database queries.
atkDummyAttribute::addToQuery() : Adds this attribute to database queries.
atkExpressionAttribute::addToQuery() : Adds this attribute to database queries.
atkFuzzySearchAttribute::addToQuery() : Dummy method to prevent loading/storing of data.
atkTagAttribute::addToQuery() : Dummy implementation
atkMlAttribute::addToQuery() : Adds this attribute to database queries.
atkMlSelectorAttribute::addToQuery() : No function, but is necessary
atkMlWrapper::addToQuery() : Adds this attribute to database queries.
atkParserAttribute::addToQuery() : No function, but is neccesary
atkTextAttribute::addToQuery() : Adds this attribute to database queries.
atkTimeAttribute::addToQuery() : Adds this attribute to database queries.
atkFilter::addToQuery() : Adds this attribute to database queries.
atkDistinctFilter::addToQuery() : add the distinct statement to the query
atkGroupByFilter::addToQuery() : add the group by statement to the query
atkManyToManyRelation::addToQuery() : Dummy function (we don't add ourselves to the query)
atkManyToOneRelation::addToQuery() : Adds this attribute to database queries.
atkUpdatedByAttribute::addToQuery() : This method is overriden to make sure that upon each save, the current user is retrieved.
atkOneToOneRelation::addToQuery() : Adds this attribute to database queries.
atkSecureRelation::addToQuery() : This function in the atkOneToOneRelation store the record of the parentnode in the DB with the reference key of the other table.

[ Top ]

addToSearchformFields [line 2321]

void addToSearchformFields(

&$fields, 
&$node, 
&$record, [array
$fieldprefix = ""], [array
$currentSearchMode = array()], array
$fields, atkNode
$node, array
$record 
)

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

Parameters:

array	$fields:	The array containing fields to use in the extended search
atkNode	$node:	The node where the field is in
array	$record:	A record containing default values to put into the search fields.
array	$fieldprefix:	search / mode field prefix
array	$currentSearchMode:	current search mode
	&$fields:
	&$node:
	&$record:

Redefined in descendants as:

atkManyToOneRelation::addToSearchformFields() : Adds the needed searchbox(es) for this attribute to the fields array. This method should only be called by the atkSearchHandler.
atkOneToOneRelation::addToSearchformFields() : Overridden method; in the integrated version, we should let the destination attributes hook themselves into the fieldlist instead of hooking the relation in it.

[ Top ]

addToViewArray [line 1017]

void addToViewArray(
String
$mode, 
&$arr, 
&$defaults, array
$arr, array
$defaults 
)

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

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

This is a framework method, it should never be called directly.

Parameters:

String	$mode:	the mode ("view")
array	$arr:	pointer to the view array
array	$defaults:	pointer to the default values array
	&$arr:
	&$defaults:

Redefined in descendants as:

atkOneToOneRelation::addToViewArray() : Adds the attribute's view / hide HTML code to the view array.

[ Top ]

db2value [line 824]

mixed db2value(
array
$rec 
)

Converts a database value to an internal value.

For the regular atkAttribute Derived attributes may reimplement this for their own conversion. (In which case, the return type might be 'mixed')

This is the exact opposite of the value2db method.

Parameters:

array

$rec:

The database record that holds this attribute's value

API Tags:

Return:

The internal value

Redefined in descendants as:

atkDateAttribute::db2value() : Convert database value to date array
atkDateTimeAttribute::db2value() : Convert database value to datetime array
atkDummyAttribute::db2value() : Convert the database value to an internally used value Since dummyattrbiutes are not stored in the database this function returns NULL
atkFileAttribute::db2value() : Convert value to string
atkMultipleFileAttribute::db2value() : Convert value to string
atkIpAttribute::db2value() : Converts a database value to an internal value.
atkMultiSelectAttribute::db2value() : Converts a database value to an internal value.
atkFlagAttribute::db2value() : Converts a database value to an internal value.
atkMlAttribute::db2value() : Removes slashes from the strings
atkMlWrapper::db2value() : Converts a database value to an internal value.
atkPasswordAttribute::db2value() : Removes slashes from the string and save to array
atkTabbedPane::db2value() : No function, but is neccesary
atkTextAttribute::db2value() : Removes slashes from the string
atkFileWriterAttribute::db2value() : Converts a database value to an internal value.
atkTimeAttribute::db2value() : Convert database value to time array
atkManyToOneRelation::db2value() : Converts DataBase value to normal value
atkOneToOneRelation::db2value() : Converts the internal attribute value to one that is understood by the database.

[ Top ]

dbFieldSize [line 1997]

int dbFieldSize(
)

Return the size of the field in the database.

If 0 is returned, the size is unknown. In this case, the return value should not be used to create table columns.

Ofcourse, the size does not make sense for every field type. So only interpret the result if a size has meaning for the field type of this attribute. (For example, if the database field is of type 'date', the size has no meaning)

Note that derived attributes might set a dot separated size, for example to store decimal numbers. The number after the dot should be interpreted as the number of decimals.

API Tags:

Return:

The database field size

Redefined in descendants as:

atkFuzzySearchAttribute::dbFieldSize() : Dummy method to prevent loading/storing of data.
atkTagAttribute::dbFieldSize() : Dummy implementation
atkIpAttribute::dbFieldSize() : Return the size of the field in the database.
atkMlWrapper::dbFieldSize() : Return the size of the field in the database.
atkNumberAttribute::dbFieldSize() : Return the size of the field in the database.
atkManyToOneRelation::dbFieldSize() : Return the size of the field in the database.

[ Top ]

dbFieldType [line 1971]

String dbFieldType(
)

Return the database field type of the attribute.

Note that the type returned is a 'generic' type. Each database vendor might have his own types, therefor, the type should be converted to a database specific type using $db->fieldType().

If the type was read from the table metadata, that value will be used. Else, the attribute will analyze its flags to guess what type it should be. If AF_AUTO_INCREMENT is set, the field is probaly "number". If not, it's probably "string".

Note: Derived attributes should override this method if they use other field types than string or number. If the derived attribute is one that can not be stored in the database, an empty string should be returned.

API Tags:

Return:

The 'generic' type of the database field for this attribute.

Redefined in descendants as:

atkAggregatedColumn::dbFieldType() : Return the database field type of the attribute.
atkBoolAttribute::dbFieldType() : Return the database field type of the attribute.
atkColorPickerAttribute::dbFieldType() : Return the database field type of the attribute.
atkDateAttribute::dbFieldType() : Return the database field type of the attribute.
atkDateTimeAttribute::dbFieldType() : Return the database field type of the attribute.
atkDummyAttribute::dbFieldType() : Return the database field type of the attribute.
atkDurationAttribute::dbFieldType() : Return the database field type of the attribute.
atkEmailAttribute::dbFieldType() : Called by the framework to determine the database field datatype.
atkExpressionAttribute::dbFieldType() : We don't know our field type plus we can't be stored anyways.
atkFileAttribute::dbFieldType() : Return the database field type of the attribute.
atkMultipleFileAttribute::dbFieldType() : Return the database field type of the attribute.
atkFuzzySearchAttribute::dbFieldType() : Dummy method to prevent loading/storing of data.
atkTagAttribute::dbFieldType() : Dummy implementation
atkIpAttribute::dbFieldType() : Return the database field type of the attribute.
atkListAttribute::dbFieldType() : Return the database field type of the attribute.
atkMultiSelectAttribute::dbFieldType() : Return the database field type of the attribute.
atkFlagAttribute::dbFieldType() : Return the database field type of the attribute.
atkMlSelectorAttribute::dbFieldType() : Dummy imp
atkMlWrapper::dbFieldType() : Return the database field type of the attribute.
atkNumberAttribute::dbFieldType() : Return the database field type of the attribute.
atkParserAttribute::dbFieldType() : Dummy implementation
atkProfileAttribute::dbFieldType() : Return the database field type of the attribute.
atkTabbedPane::dbFieldType() : Return the database field type of the attribute.
atkTextAttribute::dbFieldType() : Return the database field type of the attribute.
atkTimeAttribute::dbFieldType() : Return the database field type of the attribute.
atkRelation::dbFieldType() : Since most relations do not store anything in a field, the default fieldtype for relations is "". Exceptions (like the many2oone relation, which stores a foreign key) can implement their own dbFieldType().
atkManyToOneRelation::dbFieldType() : Return the database field type of the attribute.

[ Top ]

delete [line 1703]

boolean delete(
array
$record 
)

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

The regular atkAttribute has no implementation for this method, but derived attributes may override this, to take care of cleanups, cascade deletes etc. Note, that the framework only calls this method if the attribute has the AF_CASCADE_DELETE flag.

Parameters:

array

$record:

The record that is deleted.

API Tags:

Return:

true if cleanup was successful, false otherwise.

Redefined in descendants as:

atkFileAttribute::delete() : Deletes file from HD
atkManyToManyRelation::delete() : delete relational records..
atkOneToManyRelation::delete() : The delete method is called by the framework to inform the attribute that the master record is deleted.
atkOneToOneRelation::delete() : The delete method is called by the framework to inform the attribute that the master record is deleted.

[ Top ]

deleteAllowed [line 2286]

boolean deleteAllowed(
)

Check if delete of the record is allowed.

This method is called by the framework to check if the attribute allows the record to be deleted. The default implementation always returns true, but derived attributes may implement their own logic to prevent deletion of the record.

API Tags:

Return:

True if delete is allowed, false if not.

Redefined in descendants as:

atkOneToManyRelation::deleteAllowed() : Are we allowed to delete a record?

[ Top ]

display [line 1595]

String display(
array
$record, [String
$mode = ""] 
)

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

The regular atkAttribute uses PHP's nl2br() and htmlspecialchars() methods to prepare a value for display, unless $mode is "cvs".

Parameters:

array	$record:	The record that holds the value for this attribute
String	$mode:	The display mode ("view" for viewpages, or "list" for displaying in recordlists, "edit" for displaying in editscreens, "add" for displaying in add screens. "csv" for csv files. Applications can use additional modes.

API Tags:

Return:

HTML String

Redefined in descendants as:

atkAggregatedColumn::display() : The display function for this attribute
atkBoolAttribute::display() : Returns a displayable string for this value.
atkCalculatorAttribute::display() : Returns a displayable string for this value, to be used in HTML pages.
atkDateAttribute::display() : Function display's the date
atkDateTimeAttribute::display() : Display's html version of Record
atkDummyAttribute::display() : Display a record Here it will only return the text.
atkDocumentAttribute::display() : Gets the display code for the document selector in the specified mode
atkRowCounter::display() : Returns a number corresponding to the row count per record.
atkDurationAttribute::display() : This function displays the time
atkEmailAttribute::display() : Returns a displayable string for this value.
atkFieldSet::display() : Display fieldset.
atkFileAttribute::display() : Display values
atkMultipleFileAttribute::display() : Display values
atkTagAttribute::display() : Returns a displayable string for this value, to be used in HTML pages.
atkListAttribute::display() : Display's text version of Record
atkMultiSelectAttribute::display() : Returns a displayable string for this value, to be used in HTML pages.
atkMlAttribute::display() : Returns a displayable string for this value.
atkMlHtmlAttribute::display() : Returns a displayable string for this value.
atkMlWrapper::display() : Returns a displayable string for this value, to be used in HTML pages.
atkNumberAttribute::display() : Returns a displayable string for this value, to be used in HTML pages.
atkCurrencyAttribute::display() : overrides the display function to put the currencysymbol in front of the input field
atkWeekdayAttribute::display() : Returns a displayable string for this value, to be used in HTML pages.
atkParserAttribute::display() : Parses a record
atkPasswordAttribute::display() : We don't display the password
atkProfileAttribute::display() : Display rights.
atkRadioDetailsAttribute::display() : Display.
atkTabbedPane::display() : Display a tabbed pane with attributes
atkFckAttribute::display() : Returns a displayable string for this value, to be used in HTML pages
atkHtmlAttribute::display() : Returns a displayable string for this value.
atkWysiwygAttribute::display() : Returns a displayable string for this value, to be used in HTML pages.
atkTimeAttribute::display() : Display's text version of Record
atkUrlAttribute::display() : Returns a displayable string for this value, to be used in HTML pages.
atkRelation::display() : Return a displayable string for a record.
atkManyToManyRelation::display() : Returns a displayable string for this value.
atkExtendableShuttleRelation::display() : Display the value of this relation
atkManyToOneRelation::display() : Returns a displayable string for this value.
atkMatrixRelation::display() : Empty display function
atkOneToManyRelation::display() : Returns a displayable string for this value, to be used in HTML pages.
atkOneToOneRelation::display() : Returns a displayable string for this value, to be used in HTML pages.

[ Top ]

edit [line 897]

String 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.

Parameters:

array	$record:	The record that holds the value for this attribute.
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:

A piece of htmlcode for editing this attribute

Redefined in descendants as:

atkBoolAttribute::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.
atkCaptchaAttribute::edit() : Edit record Here it will only return the text, no edit box.
atkColorPickerAttribute::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.
atkDateAttribute::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.
atkDateTimeAttribute::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.
atkDummyAttribute::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.
atkDocumentAttribute::edit() : Gets the display code for the document selector in the specified mode
atkLiveTextPreview::edit() : Edit record Thie method will display a live preview.
atkToolbar::edit() : Returns a piece of html code that can be used to represent this attribute in an HTML form.
atkDurationAttribute::edit() : Returns a piece of html code that can be used in a form to edit this
atkFieldSet::edit() : Edit fieldset.
atkFileAttribute::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.
atkMultipleFileAttribute::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.
atkFormatAttribute::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.
atkFuzzySearchAttribute::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.
atkTagAttribute::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.
atkIpAttribute::edit() : Returns form fields to edit the ip address.
atkListAttribute::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.
atkCountryAttribute::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.
atkMultiSelectAttribute::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.
atkRadioAttribute::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.
atkStateAttribute::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.
atkMlAttribute::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).
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.
atkNumberAttribute::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.
atkCurrencyAttribute::edit() : overrides the edit function to put the currencysymbol in front of the input field
atkWeekdayAttribute::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.
atkParserAttribute::edit() : Parses a record
atkPasswordAttribute::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.
atkProfileAttribute::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.
atkRadioDetailsAttribute::edit() : Edit.
atkTabbedPane::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.
atkTextAttribute::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.
atkFckAttribute::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.
atkWysiwygAttribute::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.
atkTimeAttribute::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.
atkManyToManyRelation::edit() : Dummy function
atkExtendableShuttleRelation::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.
atkManyBoolRelation::edit() : Return a piece of html code to edit the attribute
atkManyToManyListRelation::edit() : Return a piece of html code to edit the attribute.
atkManyToManySelectRelation::edit() : Return a piece of html code to edit the attribute.
atkShuttleRelation::edit() : Return a piece of html code to edit the attribute
atkManyToOneRelation::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.
atkManyToOneTreeRelation::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.
atkMatrixRelation::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.
atkOneToManyRelation::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.
atkOneToOneRelation::edit() : Returns a piece of html code that can be used in a form to edit this attribute's value.

[ Top ]

equal [line 1797]

boolean equal(
array
$recA, array
$recB 
)

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

The regular atkAttribute performs a simple string match; derived classes may override this method to perform more complex comparisons.

Parameters:

array	$recA:	The first record holding a value for this attribute.
array	$recB:	The second record holding a value for the attribute.

API Tags:

Return:

True if the attribute considers the records equal, false if not.

Redefined in descendants as:

atkManyToOneRelation::equal() : Check if two records have the same value for this attribute

[ Top ]

escapeSQL [line 2545]

String escapeSQL(
string
$value, [boolean
$wildcards = false] 
)

Escape string for use in a query.

Parameters:

string	$value:	value to escape
boolean	$wildcards:	escape wildcards too?

API Tags:

Return:

The escaped value.

[ Top ]

extendedSort [line 2383]

String extendedSort(

&$columnConfig, [String
$fieldprefix = ''], [atkDataGrid
$grid = null], atkColumnConfig
$columnConfig 
)

Retrieves the sort options and sort order.

Parameters:

atkColumnConfig	$columnConfig:	The config that contains options for extended sorting and grouping to a recordlist.
String	$fieldprefix:	The prefix of the attribute
atkDataGrid	$grid:	The grid that this attribute lives on.
	&$columnConfig:

API Tags:

Return:

HTML

[ Top ]

fetchMeta [line 1741]

void fetchMeta(
array
$metadata 
)

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

Lengths for the edit and searchboxes, and maximum lengths are retrieved from the table metadata by this method.

Parameters:

array

$metadata:

The table metadata from the table for this attribute.

Redefined in descendants as:

atkDateTimeAttribute::fetchMeta() : Fetch the metadata about this attrib from the table metadata, and process it.
atkFuzzySearchAttribute::fetchMeta() : Dummy method to prevent loading/storing of data.
atkTagAttribute::fetchMeta() : Dummy implementation
atkMlAttribute::fetchMeta() : Fetch the metadata about this attrib from the table metadata
atkMlWrapper::fetchMeta() : Fetch the metadata about this attrib from the table metadata, and process it.
atkNumberAttribute::fetchMeta() : Apply database metadata for setting the attribute size.
atkTextAttribute::fetchMeta() : Fetch the metadata about this attrib from the table metadata, and process it.
atkOneToOneRelation::fetchMeta() : Initialize this destinations attribute sizes.

[ Top ]

fetchValue [line 879]

String fetchValue(
array
$postvars 
)

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

For the regular atkAttribute, this means getting the field with the same name as the attribute from the html posting.

Parameters:

array

$postvars:

The array with html posted values ($_POST, for example) that holds this attribute's value.

API Tags:

Return:

The internal value

Redefined in descendants as:

atkBoolAttribute::fetchValue() : Convert values from an HTML form posting to an internal value for this attribute.
atkDateAttribute::fetchValue() : Return the HTTP post values for this attribute
atkDateTimeAttribute::fetchValue() : Convert values from an HTML form posting to an internal value for this attribute.
atkDurationAttribute::fetchValue() : Fetch values
atkFileAttribute::fetchValue() : Get filename out of Array
atkFormatAttribute::fetchValue() : Convert values from an HTML form posting to an internal value for this attribute.
atkTagAttribute::fetchValue() : Fetch value.
atkIpAttribute::fetchValue() : Fetch value.
atkFlagAttribute::fetchValue() : Convert values from an HTML form posting to an internal value for this attribute.
atkMlAttribute::fetchValue() : Fetch values
atkMlWrapper::fetchValue() : Convert values from an HTML form posting to an internal value for this attribute.
atkNumberAttribute::fetchValue() : Convert values from an HTML form posting to an internal value for this attribute.
atkWeekdayAttribute::fetchValue() : Convert values from an HTML form posting to an internal value for this attribute.
atkPasswordAttribute::fetchValue() : Overwriting the fetchValue to ensure all passwords are hashed
atkProfileAttribute::fetchValue() : Convert values from an HTML form posting to an internal value for this attribute.
atkWysiwygAttribute::fetchValue() : overide the fetchValue function to perform some content cleaning
atkTimeAttribute::fetchValue() : Convert values from an HTML form posting to an internal value for this attribute.
atkManyToManyRelation::fetchValue() : Fetch value. If nothing selected, return empty array instead of nothing.
atkExtendableShuttleRelation::fetchValue() : Fetch value for this relation based on the postvars
atkManyToOneRelation::fetchValue() : Fetch value out of record
atkOneToOneRelation::fetchValue() : Convert values from an HTML form posting to an internal value for this attribute.

[ Top ]

fieldName [line 765]

String fieldName(
)

Returns the name of the attribute.

For most attributes, this corresponds to the name of the field in the database. For some attributes though (like one2many relations), the name is a mere identifier within a node. This method always returns the attribute name, despite the 'field' prefix of the method.

API Tags:

Return:

fieldname

[ Top ]

formName [line 776]

String formName(
)

Retrieve the name of the attribute in HTML forms.

API Tags:

Return:	Name of the attribute in HTML forms
Deprecated:	HTML formname and fieldname are equal, use fieldName instead.

[ Top ]

getAdditionalTabs [line 2238]

array getAdditionalTabs(
String
$action 
)

Get list of additional tabs.

Attributes can add new tabs to tabbed screens. This method will be called to retrieve the tabs. The regular atkAttribute has no implementation for this method. Derived attributes may override this.

Parameters:

String

$action:

The action for which additional tabs should be loaded.

API Tags:

Return:

The list of tabs to add to the screen.

Redefined in descendants as:

atkOneToOneRelation::getAdditionalTabs() : Get list of additional tabs.

[ Top ]

getAttributeHtmlId [line 999]

String getAttributeHtmlId(
)

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

API Tags:

Return:

The HTML id of this attribute

[ Top ]

getColumn [line 1155]

string getColumn(
)

Get column.

API Tags:

Return:	column name
Access:	public

[ Top ]

getCSSClassAttribute [line 2732]

String getCSSClassAttribute(
[mixed
$additionalclasses = array()] 
)

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

Parameters:

mixed

$additionalclasses:

A string or an array with classnames.

API Tags:

Return:

HTML The attributes classname(s)

[ Top ]

getCSSClasses [line 2711]

Array getCSSClasses(
)

Retrieve the CSS classes that were registered for this attribute

API Tags:

Return:

A list of css classes

[ Top ]

getDb [line 2526]

atkDb 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.

API Tags:

Return:

database instance

[ Top ]

getDependees [line 2625]

Array getDependees(
)

Retrieve the dependees for this attribute.

API Tags:

Return:	Returns the list of dependees.
See:	atkAttribute::_registerDependees()

[ Top ]

getEdit [line 1246]

String getEdit(
String
$mode, 
&$defaults, String
$fieldprefix, array
$defaults 
)

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

The difference with the edit() method is that the edit() method just generates the HTML code for editing the attribute, while the getEdit() method is 'smart', and implements a hide/readonly policy based on flags and/or custom override methodes in the node. (<attributename>_edit() and <attributename>_display() methods)

Framework method, it should not be necessary to call this method directly.

Parameters:

String	$mode:	The edit mode ("add" or "edit")
array	$defaults:	The record holding the values for this attribute
String	$fieldprefix:	The fieldprefix to put in front of the name of any html form element for this attribute.
	&$defaults:

API Tags:

Return:

the HTML code for this attribute that can be used in an editpage.

Redefined in descendants as:

atkManyToOneRelation::getEdit() : Retrieve the html code for placing this attribute in an edit page.

[ Top ]

getError [line 1280]

boolean getError(
array
$errors 
)

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

Parameters:

array

$errors:

The error list is one that is stored in the "atkerror" section of a record, for example generated by validate() methods.

[ Top ]

getFlags [line 653]

int getFlags(
)

Returns the full set of flags of the attribute.

API Tags:

Return:

The full set of flags

[ Top ]

getForceInsert [line 1817]

bool getForceInsert(
)

Getter for wether or not an attribute is forced to insert

API Tags:

Return:

Wether or not an attribute is forced to insert

[ Top ]

getForceUpdate [line 1837]

bool getForceUpdate(
)

Getter for wether or not an attribute is forced to update

API Tags:

Return:

Wether or not an attribute is forced to update

[ Top ]

getHtmlId [line 988]

String getHtmlId(
String
$fieldprefix 
)

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

page)

Parameters:

String

$fieldprefix:

The fieldprefix to put in front of the name of any html form element for this attribute.

API Tags:

Return:

the HTML identifier.

[ Top ]

getLabel [line 2075]

String getLabel(
[array
$record = array()], [string
$mode = ''] 
)

Get the HTML label of the attribute.

The difference with the label() method is that the label method always returns the HTML label, while the getLabel() method is 'smart', by taking the AF_NOLABEL and AF_BLANKLABEL flags into account.

Parameters:

array	$record:	The record holding the value for this attribute.
string	$mode:	The mode ("add", "edit" or "view")

API Tags:

Return:

The HTML compatible label for this attribute, or an empty string if the label should be blank, or NULL if no label at all should be displayed.

Redefined in descendants as:

atkBoolAttribute::getLabel() : Get the HTML label of the attribute.

[ Top ]

getModule [line 2049]

String getModule(
)

Get the module that this attribute originated from.

By default, this is the module of the owning node of this attribute. However, if the attribute was added using a modifier from a different module, then the module that added the attribute is returned.

API Tags:

Return:

The name of the module of this attribute

[ Top ]

getOrderByStatement [line 2495]

String getOrderByStatement(
[Array
$extra = ''], [String
$table = ''], [String
$direction = 'ASC'] 
)

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

Derived attributes may override this functionality to implement other ordering statements using the given parameters.

Parameters:

Array	$extra:	A list of attribute names to add to the order by statement
String	$table:	The table name (if not given uses the owner node's table name)
String	$direction:	Sorting direction (ASC or DESC)

API Tags:

Return:

The ORDER BY statement for this attribute

Redefined in descendants as:

atkExpressionAttribute::getOrderByStatement() : Returns the order by statement for this attribute.
atkMlWrapper::getOrderByStatement() : Get the order by statment for this attribute
atkNumberAttribute::getOrderByStatement() : Retrieves the ORDER BY statement for this attribute's node.
atkManyToOneRelation::getOrderByStatement() : Retrieves the ORDER BY statement for the relation.

[ Top ]

getOwnerInstance [line 624]

atkNode &getOwnerInstance(
)

Returns the owner instance.

API Tags:

Return:

owner instance

[ Top ]

getRefreshCall [line 2641]

String getRefreshCall(
[String
$mode = 'edit'], [String
$fieldprefix = ''], [bool
$focusFirstFormEl = false], [bool
$registerScript = true] 
)

Returns a JavaScript call for refreshing this attribute.

Parameters:

String	$mode:	add/edit mode
String	$fieldprefix:	The prefix for this attribute in an HTML form
bool	$focusFirstFormEl:	???
bool	$registerScript:	Does the javascript for this attribute need to be registered.

API Tags:

Return:	javascript Returns the javascript call to refresh this attribute.
Access:	protected

Information Tags:

Todo:

add documentation for $focusFirstFormEl.

[ Top ]

getSearchCondition [line 1542]

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.

Redefined in descendants as:

atkAggregatedColumn::getSearchCondition() : Creates a searchcondition for the field, was once part of searchCondition, however, searchcondition() also immediately adds the search condition.
atkBoolAttribute::getSearchCondition() : Creates a searchcondition for the field
atkDateAttribute::getSearchCondition() : Creates a searchcondition for the field, was once part of searchCondition, however, searchcondition() also immediately adds the search condition.
atkExpressionAttribute::getSearchCondition() : Creates a search condition for this attribute.
atkFuzzySearchAttribute::getSearchCondition() : Dummy method to prevent loading/storing of data.
atkTagAttribute::getSearchCondition() : Dummy implementation
atkListAttribute::getSearchCondition() : Creates a searchcondition for the field, was once part of searchCondition, however, searchcondition() also immediately adds the search condition.
atkMultiSelectAttribute::getSearchCondition()
atkFlagAttribute::getSearchCondition() : Creates a searchcondition for the field, was once part of searchCondition, however, searchcondition() also immediately adds the search condition.
atkMlAttribute::getSearchCondition() : Creates a searchcondition for the field, was once part of searchCondition, however, searchcondition() also immediately adds the search condition.
atkMlWrapper::getSearchCondition() : Creates a searchcondition for the field, was once part of searchCondition, however, searchcondition() also immediately adds the search condition.
atkNumberAttribute::getSearchCondition() : Creates a searchcondition for the field, was once part of searchCondition, however, searchcondition() also immediately adds the search condition.
atkTimeAttribute::getSearchCondition() : Creates a searchcondition for the field, was once part of searchCondition, however, searchcondition() also immediately adds the search condition.
atkManyToOneRelation::getSearchCondition() : Creates a searchcondition for the field, was once part of searchCondition, however, searchcondition() also immediately adds the search condition.
atkOneToManyRelation::getSearchCondition() : Creates a searchcondition for the field, was once part of searchCondition, however, searchcondition() also immediately adds the search condition.
atkOneToOneRelation::getSearchCondition() : Creates a searchcondition for the field, was once part of searchCondition, however, searchcondition() also immediately adds the search condition.
atkSecureRelation::getSearchCondition() : Creates a searchcondition for the field, was once part of searchCondition, however, searchcondition() also immediately adds the search condition.

[ Top ]

getSearchFieldName [line 2357]

String getSearchFieldName(
String
$prefix 
)

Retrieve the fieldname of the attribute in an atksearch form.

Parameters:

String

$prefix:

The prefix

API Tags:

Return:

Name of the attribute in an atksearch

[ Top ]

getSearchMode [line 1470]

String getSearchMode(
[boolean
$extended = false] 
)

Retrieve the current set or default searchmode of this attribute

Parameters:

boolean

$extended:

Whether extended search is being used

API Tags:

Return:

the default searchmode for this attribute.

[ Top ]

getSearchModeFieldname [line 2368]

String getSearchModeFieldname(
String
$prefix 
)

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

Parameters:

String

$prefix:

The prefix

API Tags:

Return:

Name of the attribute in an atksearch

[ Top ]

getSearchModes [line 1894]

array getSearchModes(
)

Retrieve the list of searchmodes supported by the attribute.

Note that not all modes may be supported by the database driver. Compare this list to the one returned by the databasedriver, to determine which searchmodes may be used.

API Tags:

Return:

List of supported searchmodes

Redefined in descendants as:

atkAggregatedColumn::getSearchModes() : Retrieve the list of searchmodes supported by the attribute.
atkBoolAttribute::getSearchModes() : Retrieve the list of searchmodes supported by the attribute.
atkColorPickerAttribute::getSearchModes() : Retrieve the list of searchmodes supported by the attribute.
atkDateAttribute::getSearchModes() : Retrieve the list of searchmodes supported by the attribute.
atkDateTimeAttribute::getSearchModes() : Retrieve the list of searchmodes supported by the attribute.
atkUpdateStampAttribute::getSearchModes() : Retrieve the list of searchmodes supported by the attribute.
atkDummyAttribute::getSearchModes() : Retrieve the list of searchmodes supported by the attribute.
atkDurationAttribute::getSearchModes() : Retrieve the list of searchmodes supported by the attribute.
atkExpressionAttribute::getSearchModes() : Returns the search modes.
atkFileAttribute::getSearchModes() : Retrieve the list of searchmodes which are supported.
atkFuzzySearchAttribute::getSearchModes() : Dummy method to prevent loading/storing of data.
atkTagAttribute::getSearchModes() : Dummy implementation
atkListAttribute::getSearchModes() : Retrieve the list of searchmodes supported by the attribute.
atkMultiSelectAttribute::getSearchModes() : Retrieve the list of searchmodes supported by the attribute.
atkFlagAttribute::getSearchModes() : Retrieve the list of searchmodes supported by the attribute.
atkNumberAttribute::getSearchModes() : Retrieve the list of searchmodes supported by the attribute.
atkPasswordAttribute::getSearchModes() : There can not be searched for passwords!
atkProfileAttribute::getSearchModes() : Retrieve the list of searchmodes supported by the attribute.
atkFileWriterAttribute::getSearchModes() : This attribute does not support any search modes
atkTimeAttribute::getSearchModes() : Retrieve the list of searchmodes supported by the attribute.
atkRelation::getSearchModes() : Retrieve the searchmodes supported by the relation.
atkManyToOneRelation::getSearchModes() : Retrieve the list of searchmodes supported by the attribute.
atkOneToManyRelation::getSearchModes() : Retrieve the list of searchmodes supported by the attribute.

[ Top ]

getSections [line 1145]

array getSections(
)

retrieve the tabs and/or sections for this attribute.

[ Top ]

getTabs [line 1114]

array getTabs(
[string
$mode = ""] 
)

retrieve the tabs for this attribute.

Parameters:

string

$mode:

[ Top ]

getToolTip [line 1205]

String getToolTip(
)

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

API Tags:

Return:

HTML

[ Top ]

getView [line 1186]

String getView(
String
$mode, 
&$defaults, array
$defaults 
)

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

Method is 'smart' and can be overridden in the node using the <attributename>_display() methods.

Framework method, it should not be necessary to call this method directly.

Parameters:

String	$mode:	The mode ("view")
array	$defaults:	The record holding the values for this attribute
	&$defaults:

API Tags:

Return:

the HTML code for this attribute that can be used in a viewpage.

[ Top ]

hasDisabledMode [line 730]

boolean hasDisabledMode(
int
$flag 
)

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

Parameters:

int

$flag:

The flag you want to check

[ Top ]

hasFlag [line 644]

boolean hasFlag(
int
$flag 
)

Check if the attribute has a certain flag.

Parameters:

int

$flag:

The flag you want to check

[ Top ]

hasStore [line 2096]

boolean hasStore(
string
$mode 
)

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

It can be overridden to determine when to use store() and when not to use it.

Parameters:

string

$mode:

The storage mode ("add", "update" or null for all)

API Tags:

Return:	true if it has a store method or false if it hasn't.
Deprecated:	Use storageType($mode) instead, which has more detailed information about storage.

[ Top ]

hide [line 967]

String hide(
[array
$record = ""], [String
$fieldprefix = ""] 
)

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

Parameters:

array	$record:	The record that holds the value for this attribute
String	$fieldprefix:	The fieldprefix to put in front of the name of any html form element for this attribute.

API Tags:

Return:

A piece of htmlcode with hidden form elements that post this attribute's value without showing it.

Redefined in descendants as:

atkBoolAttribute::hide() : Returns a piece of html code for hiding this attribute in an HTML form, while still posting its value. (<input type="hidden">)
atkDateAttribute::hide() : Returns a piece of html code that can be used in a form to display hidden values for this attribute.
atkDateTimeAttribute::hide() : Returns a piece of html code for hiding this attribute in an HTML form, while still posting its value. (<input type="hidden">)
atkUpdateStampAttribute::hide() : Returns a piece of html code for hiding this attribute in an HTML form, while still posting its value. (<input type="hidden">)
atkDurationAttribute::hide() : Returns a piece of html code for hiding this attribute in an HTML form, while still posting its value. (<input type="hidden">)
atkFileAttribute::hide() : Returns a piece of html code that can be used in a form to display hidden values for this attribute.
atkFuzzySearchAttribute::hide() : Dummy method to prevent loading/storing of data.
atkTagAttribute::hide() : Dummy implementation
atkMultiSelectAttribute::hide() : Returns a piece of html code for hiding this attribute in an HTML form, while still posting its value. (<input type="hidden">)
atkFlagAttribute::hide() : Returns a piece of html code for hiding this attribute in an HTML form, while still posting its value. (<input type="hidden">)
atkMlAttribute::hide() : Returns a piece of html code that can be used in a form to display hidden values for this attribute.
atkMlSelectorAttribute::hide() : Returns a piece of html code that can be used in a form to display hidden values for this attribute.
atkMlWrapper::hide() : Returns a piece of html code for hiding this attribute in an HTML form, while still posting its value. (<input type="hidden">)
atkPasswordAttribute::hide() : Returns a piece of html code that can be used in a form to display hidden values for this attribute.
atkProfileAttribute::hide() : Returns a piece of html code for hiding this attribute in an HTML form, while still posting its value. (<input type="hidden">)
atkTabbedPane::hide() : No function, but is necessary
atkTimeAttribute::hide() : Returns a piece of html code that can be used in a form to display hidden values for this attribute.
atkManyToManyRelation::hide() : Returns a piece of html code for hiding this attribute in an HTML form, while still posting its value. (<input type="hidden">)
atkManyToOneRelation::hide() : Returns a piece of html code for hiding this attribute in an HTML form, while still posting its value. (<input type="hidden">)
atkOneToManyRelation::hide() : Returns a piece of html code for hiding this attribute in an HTML form.
atkOneToOneRelation::hide() : Returns a piece of html code for hiding this attribute in an HTML form, while still posting its values. (<input type="hidden">)

[ Top ]

init [line 1770]

void init(
)

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

The regular atkAttribute has no implementation for this method, but derived attributes may override this method to perform custom initialization.

Redefined in descendants as:

atkDateTimeAttribute::init() : Init this attribute
atkMlWrapper::init() : Initialize the attribute
atkManyToManySelectRelation::init() : Initialize.

[ Top ]

initialValue [line 863]

mixed initialValue(
)

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

API Tags:

Return:

initial value for this attribute

Redefined in descendants as:

atkUpdateStampAttribute::initialValue() : Override the initial value
atkProfileAttribute::initialValue() : Initially use an empty rights array.
atkShuttleRelation::initialValue() : Initial value. Returns the initial value for this attribute which will be used in the add form etc.
atkUpdatedByAttribute::initialValue() : This method is overriden to make sure that when a form is posted ('save' button), the current record is refreshed so the output on screen is accurate.
atkOneToOneRelation::initialValue() : Set the initial values of this attribute

[ Top ]

isDepending [line 2694]

boolean isDepending(
)

Check whether this attribute depends on other attributes.

API Tags:

Return:

whether the attribute depends on other attribute(s)

[ Top ]

isEmpty [line 786]

boolean isEmpty(
array
$record 
)

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

Parameters:

array

$record:

The record that holds this attribute's value.

Redefined in descendants as:

atkBoolAttribute::isEmpty() : Is empty?
atkDurationAttribute::isEmpty() : Check if a record has an empty value for this attribute.
atkFileAttribute::isEmpty() : Check if the attribute is empty..
atkFormatAttribute::isEmpty() : Check if a record has an empty value for this attribute.
atkMultiSelectAttribute::isEmpty() : Check if a record has an empty value for this attribute.
atkMlAttribute::isEmpty() : Check if the attribute is empty for all languages
atkMlWrapper::isEmpty() : Check if a record has an empty value for this attribute.
atkPasswordAttribute::isEmpty() : Check if the attribute is empty
atkFckAttribute::isEmpty() : Check if a record has an empty value for this attribute.
atkRelation::isEmpty() : Check if the relation is empty
atkManyToManyRelation::isEmpty() : Check if the attribute is empty
atkMatrixRelation::isEmpty() : Check if the relation is empty
atkOneToManyRelation::isEmpty() : Override isEmpty function - in a oneToMany relation we should check if the relation contains any records. When there aren't any, the relation is empty, otherwise it isn't
atkOneToOneRelation::isEmpty() : Check if a record has an empty value for this attribute.

[ Top ]

isInitialHidden [line 2755]

initially isInitialHidden(
array
$record 
)

check whether initially hidden or not

Parameters:

array

$record:

the record

API Tags:

Return:

hidden

[ Top ]

isManualPaint [line 2778]

bool isManualPaint(
)

Check wether this attribute should be manually painted (call the edit method) or not.

API Tags:

Return:

Manually painted?

[ Top ]

isNotNullInDb [line 1633]

boolean isNotNullInDb(
)

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

This method does not look at the AF_OBLIGATORY flag, it only checks in the database if the attribute's column is really not null.

API Tags:

Return:

attribute's database column not null?

[ Top ]

isPosted [line 839]

boolean isPosted(
array
$postvars 
)

Is there a value posted for this attribute?

Parameters:

array

$postvars:

API Tags:

Return:

posted?

[ Top ]

label [line 2023]

String label(
[array
$record = array()] 
)

Return the label of the attribute.

The regular atkAttribute does not make use of the $record parameter; The label is based on the attribute name, but is automatically translated. Derived attributes may override this behavior.

Parameters:

array

$record:

The record holding the value for this attribute.

API Tags:

Return:

HTML compatible label for this attribute

Redefined in descendants as:

atkBoolAttribute::label() : Return the label of the field.

[ Top ]

listHeaderSortOrder [line 2471]

String listHeaderSortOrder(

&$columnConfig, atkColumnConfig
$columnConfig 
)

Retrieve the sortorder for the listheader based on the atkColumnConfig

Parameters:

atkColumnConfig	$columnConfig:	The config that contains options for extended sorting and grouping to a recordlist.
	&$columnConfig:

API Tags:

Return:

Returns sort order ASC or DESC

Redefined in descendants as:

atkManyToOneRelation::listHeaderSortOrder() : Retrieve the sortorder for the listheader based on the atkColumnConfig

[ Top ]

loadType [line 2204]

int loadType(
String
$mode, [boolean
$searching = false] 
)

Determine the load type of this attribute.

With this method, the attribute tells the framework whether it wants to be loaded in the main query (addToQuery) or whether the attribute has its own load() implementation. The regular atkAttribute checks if a load() method is present, and returns POSTLOAD in this case, or ADDTOQUERY otherwise. Derived attributes may override this behavior.

Framework method. It should not be necesary to call this method directly.

Parameters:

String	$mode:	The type of load (view,admin,edit etc)
boolean	$searching:	???

API Tags:

Return:

Bitmask containing information about load requirements. Note that since it is a bitmask, multiple load types could be returned at once. POSTLOAD - load() method must be called, after the master record is loaded. PRELOAD - load() must be called, before the master record is loaded. ADDTOQUERY - addtoquery() must be called, so the attribute can nest itself in the master query. NOLOAD - nor load(), nor addtoquery() should be called (attribute can not be loaded from the database)

Information Tags:

Todo:

add documentation about the searching argument. What does it do?

Redefined in descendants as:

atkCalculatorAttribute::loadType() : Make sure the value is loaded *after* the main record is loaded.
atkCaptchaAttribute::loadType() : Make sure the value is not loaded.
atkMlWrapper::loadType() : Determine the load type of this attribute.
atkTabbedPane::loadType() : Determine the load type of this attribute.
atkManyToOneRelation::loadType() : Determine the load type of this attribute.
atkOneToOneRelation::loadType() : Determine the load type of this attribute.
atkSecureRelation::loadType() : Determine the load type of this attribute.

[ Top ]

maxInputSize [line 2221]

int maxInputSize(
)

Determine the maximum length an input field may be.

Redefined in descendants as:

atkTagAttribute::maxInputSize() : Determine the maximum length an input field may be.

[ Top ]

needsInsert [line 1855]

boolean needsInsert(
array
$record 
)

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

The regular atkAttribute returns false if the value is empty, or if AF_HIDE is set; true in other cases. Exception: when AF_AUTO_INCREMENT is set, the method always returns true. Derived attributes may override this behavior.

Parameters:

array

$record:

The record that is going to be saved

API Tags:

Return:

True if this attribute should participate in the add query; false if not.

Redefined in descendants as:

atkUpdatedByAttribute::needsInsert() : needsInsert always returns true for this attribute.

[ Top ]

needsUpdate [line 1880]

boolean needsUpdate(
array
$record 
)

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

The regular atkAttribute returns false if AF_READONLY_EDIT or AF_HIDE_EDIT are set, but derived attributes may override this behavior.

Parameters:

array

$record:

The record that is going to be saved.

API Tags:

Return:

True if this attribute should participate in the update query; false if not.

Redefined in descendants as:

atkCreateStampAttribute::needsUpdate() : This function is called by the framework to determine if the attribute needs to be saved to the database in an updateDb call.
atkPasswordAttribute::needsUpdate() : Due to the new storeType functions password field is not allways saved from within the password attrib
atkUpdatedByAttribute::needsUpdate() : needsUpdate always returns true for this attribute.
atkCreatedByAttribute::needsUpdate() : needsUpdate always returns false for this attribute.
atkOneToOneRelation::needsUpdate() : Needs update?

[ Top ]

parseStringValue [line 2304]

mixed parseStringValue(
String
$stringvalue 
)

Convert a String representation into an internal value.

Used by CSV imports and the like, to convert string values to internal values. This is somewhat similar to db2value, but this method should, when derived in other attributes, act 'smart' and treat the value as a user string. The default implementation returns the string unmodified, but derived classes may override this method to alter that behaviour.

Parameters:

String

$stringvalue:

The value to parse.

API Tags:

Return:

Internal value

Redefined in descendants as:

atkBoolAttribute::parseStringValue() : Convert a String representation into an internal value.
atkDateAttribute::parseStringValue() : Convert a String representation into an internal value.
atkDateTimeAttribute::parseStringValue() : Parse the string to convert a datetime string to an array
atkListAttribute::parseStringValue() : Convert a String representation into an internal value.

[ Top ]

partial [line 2560]

String partial(
String
$partial, String
$mode 
)

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

Parameters:

String	$partial:	The name of the partial (i.e. refresh)
String	$mode:	The current add/edit mode

API Tags:

Return:

HTML Returns the result of the call to the partial handling method

[ Top ]

partial_refresh [line 2578]

String partial_refresh(
String
$mode 
)

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

Parameters:

String

$mode:

add/edit mode

API Tags:

Return:

HTML the output needed to refresh the attribute.

[ Top ]

postInit [line 1781]

void postInit(
)

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

The regular atkAttribute has no implementation for this method, but derived attributes may override this method to perform custom initialization.

Redefined in descendants as:

atkDateTimeAttribute::postInit() : If a timezone attribute is set, make sure it's always loaded.
atkFieldSet::postInit() : Make sure we disable the normal rendering for attributes that are part of this fieldset.
atkRadioDetailsAttribute::postInit() : Hide attributes that are used for the details because we are going to render them inline.
atkTabbedPane::postInit() : Post init function

[ Top ]

registerKeyListener [line 2256]

void registerKeyListener(
String
$id, [int
$navkeys = KB_CTRLCURSOR] 
)

This method is called by the attribute itself to register the keyboard navigation, usually from its edit() method. The regular atkAttribute calls this method once for its default text input box. Derived classes may call this for any input box or control they have.

Parameters:

String	$id:	The unique HTML id of the form element to which navigation is added.
int	$navkeys:	The mask indicating which keys to support for navigation.

[ Top ]

removeDisabledMode [line 751]

void removeDisabledMode(
int
$flag 
)

Removes a disabled mode from the attribute.

Parameters:

int

$flag:

The flag to remove from the attribute

[ Top ]

removeFlag [line 703]

atkAttribute removeFlag(
int
$flag 
)

Removes a flag from the attribute.

Note that removing flags at any time after the constructor might not always work. There are flags that have already been processed at constructor time, so removing them will be futile.

Parameters:

int

$flag:

The flag to remove from the attribute

API Tags:

Return:

The instance of this atkAttribute

[ Top ]

search [line 1402]

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

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

The framework calls this method to display the searchbox in the search bar of the recordlist, and to display a more extensive search in the 'extended' search screen. The regular atkAttributes returns a simple text input box for entering a keyword to search for.

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:	A piece of html-code
Access:	public

Information Tags:

Todo:

find a better way to search on onetomanys that does not require something evil in atkAttribute

Redefined in descendants as:

atkBoolAttribute::search() : Returns a piece of html code that can be used in a form to search for values
atkDateAttribute::search() : Returns a piece of html code that can be used in a form to search values.
atkDateTimeAttribute::search() : Returns a piece of html code that can be used to get search terms input from the user.
atkDummyAttribute::search() : Returns a piece of html code that can be used to get search terms input from the user.
atkDurationAttribute::search() : Returns a piece of html code that can be used in a form to search values.
atkExpressionAttribute::search() : Returns a piece of html code that can be used to search for an attribute's value.
atkFuzzySearchAttribute::search() : Dummy method to prevent loading/storing of data.
atkTagAttribute::search() : Dummy implementation
atkListAttribute::search() : Returns a piece of html code that can be used to get search terms input from the user.
atkMlAttribute::search() : Returns a piece of html code that can be used to search the attribute.
atkMlSelectorAttribute::search() : Search language selector
atkNumberAttribute::search() : Returns a piece of html code that can be used to search for an attribute's value.
atkParserAttribute::search() : VOID implementation.. parserAttribute has no data associated with it, so you can't search it.
atkPasswordAttribute::search() : We don't support searching for passwords!
atkTimeAttribute::search() : Returns a piece of html code that can be used in a form to search values
atkManyToManyRelation::search() : Returns a piece of html code that can be used in a form to search
atkManyToOneRelation::search() : Returns a piece of html code that can be used to get search terms input from the user.
atkManyToOneTreeRelation::search() : Returns a piece of html code that can be used in a form to search

[ Top ]

searchCondition [line 1519]

void searchCondition(

&$query, String
$table, mixed
$value, String
$searchmode, [string
$fieldaliasprefix = ''], atkQuery
$query 
)

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

Parameters:

atkQuery	$query:	The query to which the condition will be added.
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.
string	$fieldaliasprefix:	optional prefix for the fieldalias in the table
	&$query:

Redefined in descendants as:

atkAggregatedColumn::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.
atkDateTimeAttribute::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.
atkFuzzySearchAttribute::searchCondition() : Dummy method to prevent loading/storing of data.
atkTagAttribute::searchCondition() : Dummy implementation
atkManyToManyRelation::searchCondition() : Creates an search condition for a given search value
atkOneToManyRelation::searchCondition() : Adds a search condition for a given search value
atkSecureRelation::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.

[ Top ]

searchMode [line 1431]

string searchMode(
[boolean
$extended = false], [string
$fieldprefix = ''] 
)

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

It will show a pulldown if using extended search and multiple searchmodes are supported otherwise the default searchmode is selected.

Parameters:

boolean	$extended:	using extended search?
string	$fieldprefix:	optional fieldprefix

API Tags:

Return:	html which is used for selecting searchmode
Access:	public

[ Top ]

setAttribSize [line 1927]

void setAttribSize(
mixed
$size 
)

Set the size(s) of the attribute

Parameters:

mixed

$size:

The max. number of characters that can be entered. If not specified, or set to 0, the max. size is automatically retrieved from the table metadata.

By default, the size of the edit box is the same as the maximum number of chars that can be entered (as long as it fits on screen). You can however pass an array of 2 or 3 numbers instead of a single number. In this case, the array is interpreted as follows:

$size[0] - The maximum size that can be entered
$size[1] - The size of the input box in add/edit forms
$size[2] - The size of the search box

If $size[2] is not specified, $size[1] will be used instead. If $size[1] is not specified, or the passed value is not an array, all 3 sizes will default to the first value.

Note: The sizes that are actually used depend both on the specified size and the size of the field in the database. Usually, these are the same. In the case they differ, the smallest of the 2 will be used.

[ Top ]

setAttributeSearchmode [line 1576]

void setAttributeSearchmode(
String
$searchmode 
)

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.

Parameters:

String

$searchmode:

The searchmode we want to set on the attribute

[ Top ]

setColumn [line 1165]

void setColumn(
string
$name 
)

Set column.

Parameters:

string

$name:

column name

API Tags:

Access:

public

[ Top ]

setDisabledModes [line 742]

void setDisabledModes(
[int
$flags = 0] 
)

Sets the disabled mode flag of the attribute

Note that if you assign nothing or 0, this will remove all the flags from the attribute. You can assign multiple flags by using the pipe symbol. Setting the flags will overwrite all previous flag-settings.

Parameters:

int

$flags:

The flags to be set to the attribute.

[ Top ]

setFlags [line 688]

void setFlags(
[int
$flags = 0] 
)

Sets the flags of the attribute

Parameters:

int

$flags:

The flags to be set to the attribute.

[ Top ]

setForceInsert [line 1807]

atkAttribute setForceInsert(
bool
$force 
)

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

Parameters:

bool

$force:

Wether or not to force the attribute to insert

API Tags:

Return:

Returns the instance of this attribute

[ Top ]

setForceUpdate [line 1827]

atkAttribute setForceUpdate(
bool
$force 
)

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

Parameters:

bool

$force:

Wether or not to force the attribute to update

API Tags:

Return:

Returns the instance of this attribute

[ Top ]

setInitialHidden [line 2743]

void setInitialHidden(
boolean
$bool 
)

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

Parameters:

boolean

$bool:

Initially hidden?

[ Top ]

setInitialValue [line 852]

void setInitialValue(
mixed
$value 
)

Set initial value for this attribute.

NOTE: the initial value only works if there is no initial_values override in the node or if the override properly calls parent::initial_values!

Parameters:

mixed

$value:

initial value

Redefined in descendants as:

atkShuttleRelation::setInitialValue() : AtkShuttleRelation expect or an array whith primary keys of the destionation node or a single value that contains the primary key of the destination node.

[ Top ]

setLabel [line 2034]

atkAttribute setLabel(
string
$label 
)

Set the label of the attribute

Parameters:

string

$label:

API Tags:

Return:

The instance of this atkAttribute

[ Top ]

setLoadType [line 2169]

void setLoadType(
int
$type, [string
$mode = null] 
)

Sets the load type.

Parameters:

int	$type:	Bitmask containg information about load requirements.
string	$mode:	The load mode ("view", "admin" etc. or null for all)

API Tags:

See:

atkAttribute::loadType()

[ Top ]

setManualPaint [line 2767]

void setManualPaint(
bool
$bool 
)

Set wether the edit() method of this attribute should be called by the framework, or if the edit method is called manually.

Parameters:

bool

$bool:

TRUE if it is called manually, FALSE if ATK should call it.

[ Top ]

setOwnerInstance [line 634]

void setOwnerInstance(

&$instance, atkNode
$instance 
)

Sets the owner instance.

Parameters:

atkNode	$instance:
	&$instance:

[ Top ]

setSections [line 1128]

void setSections(
array
$sections 
)

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

Example:

$attribute->setSections(array('tab.section','tab.othersection));

Parameters:

array

$sections:

An array of tabs and/or sections on which the attribute should be displayed.

[ Top ]

setStorageType [line 2113]

void setStorageType(
int
$type, [string
$mode = null] 
)

Sets the storage type.

Parameters:

int	$type:	Bitmask containg information about storage requirements.
string	$mode:	The storage mode ("add", "update" or null for all)

API Tags:

See:

atkAttribute::storageType()

[ Top ]

setTabs [line 1095]

void setTabs(
array
$tabs 
)

Put the attribute on one or more tabs.

Parameters:

array

$tabs:

An array of tabs on which the attribute should be displayed.

[ Top ]

showOnTab [line 2271]

boolean showOnTab(
String
$tab 
)

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

Parameters:

String

$tab:

The name of the tab to check.

Redefined in descendants as:

atkOneToOneRelation::showOnTab() : Check if the attribute wants to be shown on a certain tab.

[ Top ]

smartSearchCondition [line 1493]

void smartSearchCondition(
Integer
$id, Integer
$nr, Array
$path, 
&$query, String
$ownerAlias, Mixed
$value, String
$mode, atkQuery
$query 
)

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.

Parameters:

Integer	$id:	The unique smart search criterium identifier.
Integer	$nr:	The element number in the path.
Array	$path:	The remaining attribute path.
atkQuery	$query:	The query to which the condition will be added.
String	$ownerAlias:	The owner table alias to use.
Mixed	$value:	The value the user has entered in the searchbox.
String	$mode:	The searchmode to use.
	&$query:

Redefined in descendants as:

atkManyToOneRelation::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.
atkOneToManyRelation::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.

[ Top ]

sortOptions [line 2400]

String sortOptions(

&$columnConfig, [String
$fieldprefix = ''], [atkDataGrid
$grid = null], atkColumnConfig
$columnConfig 
)

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

Parameters:

atkColumnConfig	$columnConfig:	The config that contains options for extended sorting and grouping to a recordlist.
String	$fieldprefix:	The prefix of the attribute
atkDataGrid	$grid:	The grid that this attribute lives on.
	&$columnConfig:

API Tags:

Return:

HTML

[ Top ]

sortOrder [line 2430]

String sortOrder(

&$columnConfig, [String
$fieldprefix = ''], [atkDataGrid
$grid = null], atkColumnConfig
$columnConfig 
)

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

Parameters:

atkColumnConfig	$columnConfig:	The config that contains options for extended sorting and grouping to a recordlist.
String	$fieldprefix:	The prefix of the attribute on HTML forms
atkDataGrid	$grid:	The grid that this attribute lives on.
	&$columnConfig:

API Tags:

Return:

HTML

[ Top ]

storageType [line 2145]

int storageType(
[String
$mode = null] 
)

Determine the storage type of this attribute.

With this method, the attribute tells the framework whether it wants to be stored in the main query (addToQuery) or whether the attribute has its own store() implementation. The regular atkAttribute checks if a store() method is present, and returns POSTSTORE in this case, or ADDTOQUERY otherwise. Derived attributes may override this behavior.

Framework method. It should not be necesary to call this method directly.

Parameters:

String

$mode:

The type of storage ("add" or "update")

API Tags:

Return:

Bitmask containing information about storage requirements. Note that since it is a bitmask, multiple storage types could be returned at once. POSTSTORE - store() method must be called, after the master record is saved. PRESTORE - store() must be called, before the master record is saved. ADDTOQUERY - addtoquery() must be called, so the attribute can nest itself in the master query. NOSTORE - nor store(), nor addtoquery() should be called (attribute can not be stored in the database)

Redefined in descendants as:

atkCalculatorAttribute::storageType() : Make sure the value is not stored. (always calculated on the fly)
atkCaptchaAttribute::storageType() : Make sure the value is not stored. (always calculated on the fly)
atkExpressionAttribute::storageType() : No storage.
atkMlWrapper::storageType() : Determine the storage type of this attribute.
atkTabbedPane::storageType() : Determine the storage type of this attribute.
atkOneToOneRelation::storageType() : Determine the storage type of this attribute.

[ Top ]

sum [line 1724]

array sum(
array
$rec1, array
$rec2, [String
$fieldprefix = ""] 
)

Calculate the sum of 2 records.

This is called by the framework for the auto-totalling feature. Two records are passed, and a record is returned. The reason that the params are entire records instead of plain values, is that derived classes or custom attributes may need information from other attributes too.

Parameters:

array	$rec1:	The first record
array	$rec2:	The second record
String	$fieldprefix:	The prefix that values in $rec1 and $rec2 have

API Tags:

Return:

A record containing the sum of $rec1 and $rec2

[ Top ]

text [line 2511]

String text(
String
$string 
)

Translate using the owner instance's module and type.

Parameters:

String

$string:

The string to be translated

API Tags:

Return:

The translated string.

[ Top ]

validate [line 1622]

void validate(

&$record, String
$mode, array
$record 
)

Checks if a value is valid.

The regular atkAttribute has no specific validation. Derived attributes may override this method to perform custom validation. Note that obligatory and unique fields are checked by the atkNodeValidator, and not by the validate() method itself.

Parameters:

array	$record:	The record that holds the value for this attribute. If an error occurs, the error will be stored in the 'atkerror' field of the record.
String	$mode:	The mode for which should be validated ("add" or "update")
	&$record:

Redefined in descendants as:

atkCaptchaAttribute::validate() : Validate the value fo this attribute
atkColorPickerAttribute::validate() : Checks if a value is valid.
atkDateAttribute::validate() : Validate's dates
atkDateTimeAttribute::validate() : Validate the value of this attribute
atkEmailAttribute::validate() : Validates email address through regular expression and dns check
atkFileAttribute::validate() : Checks if the file has a valid filetype.
atkFormatAttribute::validate() : Validate if all elements match the format specifier.
atkFuzzySearchAttribute::validate() : Checks if a value is valid.
atkTagAttribute::validate() : Validate the input based on the current mode.
atkIpAttribute::validate() : Checks if the value is a valid IP address
atkMlNumberAttribute::validate() : Validates if value is numeric
atkMlWrapper::validate() : Checks if a value is valid.
atkNumberAttribute::validate() : Validates if value is numeric
atkPasswordAttribute::validate() : Validates the supplied passwords
atkTimeAttribute::validate() : Checks if a value is valid.
atkUrlAttribute::validate() : Checks if a value is valid.
atkRelation::validate() : Validation method. Empty implementation. Derived classes may override this function.
atkManyToOneRelation::validate() : Validate if the record we are referring to really exists.
atkMatrixRelation::validate() : Validate this relation
atkOneToOneRelation::validate() : Checks if a value is valid.

[ Top ]

value2db [line 803]

String value2db(
array
$rec 
)

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

For the regular atkAttribute, this means escaping things like quotes and slashes. Derived attributes may reimplement this for their own conversion. This is the exact opposite of the db2value method.

Parameters:

array

$rec:

The record that holds this attribute's value.

API Tags:

Return:

The database compatible value

Redefined in descendants as:

atkBoolAttribute::value2db() : Get the value if it exits, otherwise return 0
atkDateAttribute::value2db() : Convert date array to database value
atkDateTimeAttribute::value2db() : Converts the internal attribute value to one that is understood by the database.
atkUpdateStampAttribute::value2db() : Value to DB.
atkFileAttribute::value2db() : Convert value to record for database
atkMultipleFileAttribute::value2db() : Convert value to record for database
atkIpAttribute::value2db() : Converts the internal attribute value to one that is understood by the database.
atkMultiSelectAttribute::value2db() : Converts the internal attribute value to one that is understood by the database.
atkFlagAttribute::value2db() : Converts the internal attribute value to one that is understood by the database.
atkMlAttribute::value2db() : Converts the internal attribute value to one that is understood by the database.
atkNumberAttribute::value2db() : Converts the internal attribute value to one that is understood by the database.
atkPasswordAttribute::value2db() : Add's slashes to the string for the database
atkTextAttribute::value2db() : Add's slashes to the string for the database
atkFckAttribute::value2db() : Converts the internal attribute value to one that is understood by the database.
atkFileWriterAttribute::value2db() : Converts the internal attribute value to one that is understood by the database.
atkTimeAttribute::value2db() : Converts the internal attribute value to one that is understood by the database.
atkManyToOneRelation::value2db() : Convert value to DataBase value
atkUpdatedByAttribute::value2db() : Converts the internal attribute value to one that is understood by the database.
atkOneToOneRelation::value2db() : Convert the internal value to the database value

[ Top ]

_registerDependees [line 2663]

void _registerDependees(
[String
$mode = ""], [String
$fieldprefix = ""] 
)

A dependee is a different attribute (mostly part of the same node) that needs to be refreshed through an AJAX call if the value of this attribute changes.

Parameters:

String	$mode:	add/edit mode
String	$fieldprefix:	The prefix for this attribute in an HTML form

API Tags:

Access:

private

[ Top ]

_renderChangeHandler [line 943]

void _renderChangeHandler(
String
$fieldprefix 
)

Renders the onchange code on the page.

Parameters:

String

$fieldprefix:

The prefix to the field

API Tags:

Access:

private

Redefined in descendants as:

atkShuttleRelation::_renderChangeHandler() : Renders the onchange code on the page.

[ Top ]

__toString [line 2785]

string __toString(
)

String representation for this attribute (PHP5 only).

API Tags:

Return:

attribute name prefixed with node type

[ Top ]