Docs For Class atkDateTimeAttribute

Home

Documentation home

Atk index

Docs For Class atkDateTimeAttribute [ package: atk ]

Class: atkDateTimeAttribute

Source Location: /attributes/class.atkdatetimeattribute.inc

Class atkDateTimeAttribute

Class Overview

The atkDateTimeAttribute class can be used for date and time entry.

It corresponds to a DATETIME field in the database.

Located in /attributes/class.atkdatetimeattribute.inc [line 34]

Wiki documentation

atkAttribute
   |
   --atkDateTimeAttribute

Author(s):

Sandy Pleyte <sandy@achievo.org>

Information Tags:

Properties

Methods

[ Top ]

Descendants

Child Class	Description
atkUpdateStampAttribute	Attribute for keeping track of last-modification times.

[ Top ]

Inherited from parent

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

Inherited Properties

Inherited Methods

Inherited From atkAttribute

atkAttribute::$m_column

atkAttribute::$m_cssclasses

atkAttribute::$m_dbfieldtype

atkAttribute::$m_dependees

atkAttribute::$m_disabledModes

atkAttribute::$m_flags

atkAttribute::$m_forceinsert

atkAttribute::$m_forceupdate

atkAttribute::$m_htmlid

atkAttribute::$m_index

atkAttribute::$m_initialValue

atkAttribute::$m_initial_hidden

atkAttribute::$m_label

atkAttribute::$m_loadType

atkAttribute::$m_manual_paint

atkAttribute::$m_maxsize

atkAttribute::$m_module

atkAttribute::$m_name

atkAttribute::$m_onchangecode

atkAttribute::$m_onchangehandler_init

atkAttribute::$m_order

atkAttribute::$m_owner

atkAttribute::$m_ownerInstance

atkAttribute::$m_searchmode

atkAttribute::$m_searchsize

atkAttribute::$m_sections

atkAttribute::$m_size

atkAttribute::$m_storageType

atkAttribute::$m_tabs

Inherited From atkAttribute

atkAttribute::atkAttribute()

Constructor

atkAttribute::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.

atkAttribute::addDisabledMode()

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

atkAttribute::addFlag()

Adds a flag to the attribute.

atkAttribute::addOnChangeHandler()

Add a javascript onchange event handler.

atkAttribute::addToEditArray()

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

atkAttribute::addToListArrayHeader()

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

atkAttribute::addToListArrayRow()

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

atkAttribute::addToQuery()

Adds this attribute to database queries.

atkAttribute::addToSearchformFields()

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

atkAttribute::addToViewArray()

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

atkAttribute::db2value()

Converts a database value to an internal value.

atkAttribute::dbFieldSize()

Return the size of the field in the database.

atkAttribute::dbFieldType()

Return the database field type of the attribute.

atkAttribute::delete()

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

atkAttribute::deleteAllowed()

Check if delete of the record is allowed.

atkAttribute::display()

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

atkAttribute::edit()

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

atkAttribute::equal()

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

atkAttribute::escapeSQL()

Escape string for use in a query.

atkAttribute::extendedSort()

Retrieves the sort options and sort order.

atkAttribute::fetchMeta()

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

atkAttribute::fetchValue()

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

atkAttribute::fieldName()

Returns the name of the attribute.

atkAttribute::formName()

Retrieve the name of the attribute in HTML forms.

atkAttribute::getAdditionalTabs()

Get list of additional tabs.

atkAttribute::getAttributeHtmlId()

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

atkAttribute::getColumn()

Get column.

atkAttribute::getCSSClassAttribute()

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

atkAttribute::getCSSClasses()

Retrieve the CSS classes that were registered for this attribute

atkAttribute::getDb()

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

atkAttribute::getDependees()

Retrieve the dependees for this attribute.

atkAttribute::getEdit()

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

atkAttribute::getError()

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

atkAttribute::getFlags()

Returns the full set of flags of the attribute.

atkAttribute::getForceInsert()

Getter for wether or not an attribute is forced to insert

atkAttribute::getForceUpdate()

Getter for wether or not an attribute is forced to update

atkAttribute::getHtmlId()

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

atkAttribute::getLabel()

Get the HTML label of the attribute.

atkAttribute::getModule()

Get the module that this attribute originated from.

atkAttribute::getOrderByStatement()

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

atkAttribute::getOwnerInstance()

Returns the owner instance.

atkAttribute::getRefreshCall()

Returns a JavaScript call for refreshing this attribute.

atkAttribute::getSearchCondition()

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

atkAttribute::getSearchFieldName()

Retrieve the fieldname of the attribute in an atksearch form.

atkAttribute::getSearchMode()

Retrieve the current set or default searchmode of this attribute

atkAttribute::getSearchModeFieldname()

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

atkAttribute::getSearchModes()

Retrieve the list of searchmodes supported by the attribute.

atkAttribute::getSections()

retrieve the tabs and/or sections for this attribute.

atkAttribute::getTabs()

retrieve the tabs for this attribute.

atkAttribute::getToolTip()

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

atkAttribute::getView()

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

atkAttribute::hasDisabledMode()

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

atkAttribute::hasFlag()

Check if the attribute has a certain flag.

atkAttribute::hasStore()

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

atkAttribute::hide()

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

atkAttribute::init()

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

atkAttribute::initialValue()

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

atkAttribute::isDepending()

Check whether this attribute depends on other attributes.

atkAttribute::isEmpty()

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

atkAttribute::isInitialHidden()

check whether initially hidden or not

atkAttribute::isManualPaint()

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

atkAttribute::isNotNullInDb()

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

atkAttribute::isPosted()

Is there a value posted for this attribute?

atkAttribute::label()

Return the label of the attribute.

atkAttribute::listHeaderSortOrder()

Retrieve the sortorder for the listheader based on the atkColumnConfig

atkAttribute::loadType()

Determine the load type of this attribute.

atkAttribute::maxInputSize()

Determine the maximum length an input field may be.

atkAttribute::needsInsert()

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

atkAttribute::needsUpdate()

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

atkAttribute::parseStringValue()

Convert a String representation into an internal value.

atkAttribute::partial()

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

atkAttribute::partial_refresh()

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

atkAttribute::postInit()

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

atkAttribute::registerKeyListener()

Register keyboard navigation for this attribute.

atkAttribute::removeDisabledMode()

Removes a disabled mode from the attribute.

atkAttribute::removeFlag()

Removes a flag from the attribute.

atkAttribute::search()

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

atkAttribute::searchCondition()

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

atkAttribute::searchMode()

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

atkAttribute::setAttribSize()

Set the size(s) of the attribute

atkAttribute::setAttributeSearchmode()

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

atkAttribute::setColumn()

Set column.

atkAttribute::setDisabledModes()

Sets the disabled mode flag of the attribute

atkAttribute::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

atkAttribute::setInitialHidden()

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

atkAttribute::setInitialValue()

Set initial value for this attribute.

atkAttribute::setLabel()

Set the label of the attribute

atkAttribute::setLoadType()

Sets the load type.

atkAttribute::setManualPaint()

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

atkAttribute::setOwnerInstance()

Sets the owner instance.

atkAttribute::setSections()

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

atkAttribute::setStorageType()

Sets the storage type.

atkAttribute::setTabs()

Put the attribute on one or more tabs.

atkAttribute::showOnTab()

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

atkAttribute::smartSearchCondition()

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

atkAttribute::sortOptions()

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

atkAttribute::sortOrder()

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

atkAttribute::storageType()

Determine the storage type of this attribute.

atkAttribute::sum()

Calculate the sum of 2 records.

atkAttribute::text()

Translate using the owner instance's module and type.

atkAttribute::validate()

Checks if a value is valid.

atkAttribute::value2db()

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

atkAttribute::_registerDependees()

Register change handlers for dependees.

atkAttribute::_renderChangeHandler()

Renders the onchange code on the page.

atkAttribute::__toString()

String representation for this attribute (PHP5 only).

[ Top ]

Property Summary

mixed	$m_date
mixed	$m_time
mixed	$m_timezoneAttribute
mixed	$m_utcOffset

[ Top ]

Method Summary

atkDateTimeAttribute	atkDateTimeAttribute()	Constructor
void	addToQuery()	Adds this attribute to database queries.
int	arrayToDateTime()	Converts a date array to a timestamp year, month, day are obligatory !!
array	datetimeArray()	Converts a date/time string (YYYYMMDDHHMISS) to an array with 5 fields (day, month, year, hours, minutes, seconds).
array	db2value()	Convert database value to datetime array
String	dbFieldType()	Return the database field type of the attribute.
text	display()	Display's html version of Record
String	edit()	Returns a piece of html code that can be used in a form to edit this attribute's value.
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.
int\|array	fromUTC()	Convert the given UTC ATK date/time array to a date/time array in a certain timezone.
array	getSearchModes()	Retrieve the list of searchmodes supported by the attribute.
string	getTimezoneAttribute()	Returns the timezone attribute name.
int	getUTCOffset()	Returns the UTC offset if set.
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()	Init this attribute
array	parseStringValue()	Parse the string to convert a datetime string to an array
void	postInit()	If a timezone attribute is set, make sure it's always loaded.
void	resetUTCOffset()	Resets the UTC offset.
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.
void	setDateMax()	Set the maximum date that may be select (0 means unlimited).
void	setDateMin()	Set the minimum date that may be select (0 means unlimited).
void	setTimezoneAttribute()	Sets the timezone attribute. This can also be a timezone attribute retrieved from a atkManyToOneRelation. If so then please use the dot notation.
void	setUTCOffset()	Sets the UTF offset in seconds.
int\|array	toUTC()	Convert the given ATK date/time array to a UTC date/time array.
void	validate()	Validate the value of this attribute
String	value2db()	Converts the internal attribute value to one that is understood by the database.
int	_getUTCOffset()	Returns the UTC offset in seconds. If the UTC offset is set explicitly

[ Top ]

Properties

mixed $m_date = "" [line 37]

[ Top ]

mixed $m_time = "" [line 36]

[ Top ]

mixed $m_timezoneAttribute = null [line 40]

[ Top ]

mixed $m_utcOffset = null [line 39]

[ Top ]

Methods

Constructor atkDateTimeAttribute [line 86]

atkDateTimeAttribute atkDateTimeAttribute(
string
$name, [string|int
$default_date = ""], [string
$default_time = ""], [int
$flags = 0] 
)

Constructor

Parameters:

string	$name:	Name of the attribute
string\|int	$default_date:	start date
string	$default_time:	start time
int	$flags:	Flags for this attribute

Information Tags:

Todo:

I don't know who added the default_date and default_time parameters, but at least the atkDateAttribute doesn't support a default date. if you want to set a default date you should use initial_values anyways so I think the default_date / default_time parameters should be removed. But can we keep this backwards compatible somehow? At least now we are certain it doesn't work. ;) (PCV)

[ Top ]

addToQuery [line 360]

void addToQuery(

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

Adds this attribute to database queries.

Parameters:

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

Redefinition of:

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

[ Top ]

arrayToDateTime [line 50]

int arrayToDateTime(
array
$dateArray 
)

Converts a date array to a timestamp year, month, day are obligatory !!

Parameters:

array

$dateArray:

Date Array

API Tags:

Return:

Timestamp

[ Top ]

datetimeArray [line 174]

array datetimeArray(
[string
$datetime = NULL] 
)

Converts a date/time string (YYYYMMDDHHMISS) to an array with 5 fields (day, month, year, hours, minutes, seconds).

Defaults to current date/time.

Parameters:

string

$datetime:

the time string

API Tags:

Return:

with 6 fields (day, month, year, hours, minutes, seconds)

[ Top ]

db2value [line 306]

array db2value(
array
$rec 
)

Convert database value to datetime array

Parameters:

array

$rec:

database record with date field

API Tags:

Return:

with 3 fields (hours:minutes:seconds)

Redefinition of:

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

[ Top ]

dbFieldType [line 464]

String dbFieldType(
)

Return the database field type of the attribute.

API Tags:

Return:

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

Redefinition of:

atkAttribute::dbFieldType(): Return the database field type of the attribute.

[ Top ]

display [line 221]

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

Display's html version of Record

Parameters:

array	$record:	The record
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:

string of $record

Redefinition of:

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

[ Top ]

edit [line 264]

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

Redefinition of:

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

[ Top ]

fetchMeta [line 205]

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.

Redefinition of:

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

[ Top ]

fetchValue [line 242]

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

Redefinition of:

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

[ Top ]

fromUTC [line 621]

int|array fromUTC(
mixed
$value, 
&$record, array
$record 
)

Convert the given UTC ATK date/time array to a date/time array in a certain timezone.

Parameters:

mixed	$value:	UNIX timestamp or ATK date/time array
array	$record:	record
	&$record:

API Tags:

Return:

UNIX timestamp or ATK date/time array (depending on input)

[ Top ]

getSearchModes [line 453]

array getSearchModes(
)

Retrieve the list of searchmodes supported by the attribute.

API Tags:

Return:

List of supported searchmodes

Redefinition of:

atkAttribute::getSearchModes(): Retrieve the list of searchmodes supported by the attribute.

Redefined in descendants as:

atkUpdateStampAttribute::getSearchModes() : Retrieve the list of searchmodes supported by the attribute.

[ Top ]

getTimezoneAttribute [line 502]

string getTimezoneAttribute(
)

Returns the timezone attribute name.

API Tags:

Return:

timezone attribute name

[ Top ]

getUTCOffset [line 530]

int getUTCOffset(
)

Returns the UTC offset if set.

API Tags:

Return:

UTC offset in seconds if set.

[ Top ]

hide [line 440]

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.

Redefinition of:

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

Redefined in descendants as:

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

[ Top ]

init [line 187]

void init(
)

Init this attribute

Redefinition of:

atkAttribute::init(): This function is called right after the attribute is added to the node.

[ Top ]

parseStringValue [line 476]

array parseStringValue(
string
$stringvalue 
)

Parse the string to convert a datetime string to an array

Parameters:

string

$stringvalue:

API Tags:

Return:

with date and time information

Redefinition of:

atkAttribute::parseStringValue(): Convert a String representation into an internal value.

[ Top ]

postInit [line 634]

void postInit(
)

If a timezone attribute is set, make sure it's always loaded.

Redefinition of:

atkAttribute::postInit(): This function is called at the end of the node's init method.

[ Top ]

resetUTCOffset [line 520]

void resetUTCOffset(
)

Resets the UTC offset.

[ Top ]

search [line 407]

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

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

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

Redefinition of:

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

[ Top ]

searchCondition [line 425]

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:

Redefinition of:

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

[ Top ]

setDateMax [line 137]

void setDateMax(
[mixed
$max = 0] 
)

Set the maximum date that may be select (0 means unlimited).

It can be set in 3 formats:

Unix timestamp.
String (parsed by strtotime)
Array (with year,month,day,hour,min,sec)

Parameters:

mixed

$max:

The maximum date that may be selected.

[ Top ]

setDateMin [line 123]

void setDateMin(
[mixed
$min = 0] 
)

Set the minimum date that may be select (0 means unlimited).

It can be set in 3 formats:

Unix timestamp.
String (parsed by strtotime)
Array (with year,month,day,hour,min,sec)

Parameters:

mixed

$min:

The minimum date that may be selected.

[ Top ]

setTimezoneAttribute [line 492]

void setTimezoneAttribute(
string
$attrName 
)

Sets the timezone attribute. This can also be a timezone attribute retrieved from a atkManyToOneRelation. If so then please use the dot notation.

Parameters:

string

$attrName:

attribute name

[ Top ]

setUTCOffset [line 512]

void setUTCOffset(
int
$offset 
)

Sets the UTF offset in seconds.

Parameters:

int

$offset:

UTC offset in seconds

[ Top ]

toUTC [line 604]

int|array toUTC(
mixed
$value, 
&$record, array
$record 
)

Convert the given ATK date/time array to a UTC date/time array.

Parameters:

mixed	$value:	UNIX timestamp or ATK date/time array
array	$record:	record
	&$record:

API Tags:

Return:

UNIX timestamp or ATK date/time array (depending on input)

[ Top ]

validate [line 151]

void validate(

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

Validate the value of this attribute

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:

Redefinition of:

atkAttribute::validate(): Checks if a value is valid.

[ Top ]

value2db [line 278]

String value2db(
array
$rec 
)

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

Parameters:

array

$rec:

The record that holds this attribute's value.

API Tags:

Return:

The database compatible value

Redefinition of:

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

Redefined in descendants as:

atkUpdateStampAttribute::value2db() : Value to DB.

[ Top ]

_getUTCOffset [line 546]

int _getUTCOffset(

&$record, [string
$stamp = null], array
$record 
)

Returns the UTC offset in seconds. If the UTC offset is set explicitly

using the setUTCOffset method this offset is returned. Else if a timezone attribute is set the offset is determined by looking at the timezone using the given timezone attribute. If no offset and no attribute are set an offset of 0 is returned.

Parameters:

array	$record:	record
string	$stamp:	timestamp
	&$record:

API Tags:

Return:

UTC offset in seconds

[ Top ]