Docs For Class atkNumberAttribute

Home

Documentation home

Atk index

Docs For Class atkNumberAttribute [ package: atk ]

Class: atkNumberAttribute

Source Location: /attributes/class.atknumberattribute.inc

Class atkNumberAttribute

Class Overview

The atkNumberAttribute can be used for numeric values.

Located in /attributes/class.atknumberattribute.inc [line 27]

Wiki documentation

atkAttribute
   |
   --atkNumberAttribute

Author(s):

Ivo Jansch <ivo@achievo.org>

Information Tags:

Properties

Methods

[ Top ]

Descendants

Child Class	Description
atkCurrencyAttribute	The atkCurrencyAttribute can be used for money values.
atkWeekdayAttribute	Attribute for selection the days of the week.

[ Top ]

Inherited from parent

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

Inherited Properties

Inherited Methods

Inherited From atkAttribute

atkAttribute::$m_column

atkAttribute::$m_cssclasses

atkAttribute::$m_dbfieldtype

atkAttribute::$m_dependencies

atkAttribute::$m_disabledModes

atkAttribute::$m_editCallback

atkAttribute::$m_flags

atkAttribute::$m_forceinsert

atkAttribute::$m_forcereload

atkAttribute::$m_forceupdate

atkAttribute::$m_htmlid

atkAttribute::$m_index

atkAttribute::$m_initialValue

atkAttribute::$m_initial_hidden

atkAttribute::$m_jsObservers

atkAttribute::$m_label

atkAttribute::$m_loadType

atkAttribute::$m_maxsize

atkAttribute::$m_module

atkAttribute::$m_name

atkAttribute::$m_onchangecode

atkAttribute::$m_onchangehandler_init

atkAttribute::$m_order

atkAttribute::$m_owner

atkAttribute::$m_ownerInstance

atkAttribute::$m_postfixlabel

atkAttribute::$m_searchmode

atkAttribute::$m_searchsize

atkAttribute::$m_sections

atkAttribute::$m_storageType

atkAttribute::$m_tabs

atkAttribute::$m_viewCallback

Inherited From atkAttribute

atkAttribute::atkAttribute()

Constructor

atkAttribute::addCSSClass()

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

atkAttribute::addDependee()

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

atkAttribute::addDependency()

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

atkAttribute::addDisabledMode()

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

atkAttribute::addFlag()

Adds a flag to the attribute.

atkAttribute::addOnChangeHandler()

Add a javascript onchange event handler.

atkAttribute::addToEditArray()

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

atkAttribute::addToListArrayHeader()

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

atkAttribute::addToListArrayRow()

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

atkAttribute::addToQuery()

Adds this attribute to database queries.

atkAttribute::addToSearchformFields()

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

atkAttribute::addToViewArray()

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

atkAttribute::db2value()

Converts a database value to an internal value.

atkAttribute::dbFieldSize()

Return the size of the field in the database.

atkAttribute::dbFieldType()

Return the database field type of the attribute.

atkAttribute::delete()

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

atkAttribute::deleteAllowed()

Check if delete of the record is allowed.

atkAttribute::display()

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

atkAttribute::edit()

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

atkAttribute::equal()

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

atkAttribute::escapeSQL()

Escape string for use in a query.

atkAttribute::extendedSort()

Retrieves the sort options and sort order.

atkAttribute::fetchMeta()

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

atkAttribute::fetchValue()

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

atkAttribute::fieldName()

Returns the name of the attribute.

atkAttribute::formName()

Retrieve the name of the attribute in HTML forms.

atkAttribute::getAdditionalTabs()

Get list of additional tabs.

atkAttribute::getAttributeHtmlId()

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

atkAttribute::getColumn()

Get column.

atkAttribute::getCSSClassAttribute()

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

atkAttribute::getCSSClasses()

Retrieve the CSS classes that were registered for this attribute

atkAttribute::getDb()

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

atkAttribute::getDependencies()

Retrieve the dependees for this attribute.

atkAttribute::getEdit()

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

atkAttribute::getEditCallback()

Returns the edit callback (if set).

atkAttribute::getError()

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

atkAttribute::getFlags()

Returns the full set of flags of the attribute.

atkAttribute::getForceInsert()

Getter for wether or not an attribute is forced to insert

atkAttribute::getForceUpdate()

Getter for wether or not an attribute is forced to update

atkAttribute::getHtmlId()

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

atkAttribute::getLabel()

Get the HTML label of the attribute.

atkAttribute::getModule()

Get the module that this attribute originated from.

atkAttribute::getOrderByStatement()

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

atkAttribute::getOwnerInstance()

Returns the owner instance.

atkAttribute::getSearchCondition()

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

atkAttribute::getSearchFieldName()

Retrieve the fieldname of the attribute in an atksearch form.

atkAttribute::getSearchMode()

Retrieve the current set or default searchmode of this attribute

atkAttribute::getSearchModeFieldname()

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

atkAttribute::getSearchModes()

Retrieve the list of searchmodes supported by the attribute.

atkAttribute::getSections()

retrieve the tabs and/or sections for this attribute.

atkAttribute::getTabs()

retrieve the tabs for this attribute.

atkAttribute::getToolTip()

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

atkAttribute::getView()

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

atkAttribute::getViewCallback()

Returns the view callback (if set).

atkAttribute::hasDisabledMode()

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

atkAttribute::hasFlag()

Check if the attribute has a certain flag.

atkAttribute::hasStore()

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

atkAttribute::hide()

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

atkAttribute::init()

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

atkAttribute::initDependencies()

Initialize and calls the dependencies.

atkAttribute::initialValue()

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

atkAttribute::isEmpty()

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

atkAttribute::isInitialHidden()

check whether initially hidden or not

atkAttribute::isNotNullInDb()

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

atkAttribute::isPosted()

Is there a value posted for this attribute?

atkAttribute::label()

Return the label of the attribute.

atkAttribute::listHeaderSortOrder()

Retrieve the sortorder for the listheader based on the atkColumnConfig

atkAttribute::loadType()

Determine the load type of this attribute.

atkAttribute::maxInputSize()

Determine the maximum length an input field may be.

atkAttribute::needsInsert()

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

atkAttribute::needsReload()

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

atkAttribute::needsUpdate()

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

atkAttribute::observeJS()

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

atkAttribute::parseStringValue()

Convert a String representation into an internal value.

atkAttribute::partial()

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

atkAttribute::partial_dependencies()

Call dependencies for this attribute and output JavaScript.

atkAttribute::partial_refresh()

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

atkAttribute::postInit()

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

atkAttribute::preAddToEditArray()

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

atkAttribute::preAddToViewArray()

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

atkAttribute::registerJavaScriptObservers()

Register JavaScript event handlers.

atkAttribute::registerKeyListener()

Register keyboard navigation for this attribute.

atkAttribute::removeDisabledMode()

Removes a disabled mode from the attribute.

atkAttribute::removeFlag()

Removes a flag from the attribute.

atkAttribute::search()

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

atkAttribute::searchCondition()

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

atkAttribute::searchMode()

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

atkAttribute::setAttribSize()

Set the size(s) of the attribute

atkAttribute::setAttributeSearchmode()

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

atkAttribute::setColumn()

Set column.

atkAttribute::setDisabledModes()

Sets the disabled mode flag of the attribute

atkAttribute::setEditCallback()

Sets the edit callback.

atkAttribute::setFlags()

Sets the flags of the attribute

atkAttribute::setForceInsert()

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

atkAttribute::setForceReload()

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

atkAttribute::setForceUpdate()

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

atkAttribute::setInitialHidden()

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

atkAttribute::setInitialValue()

Set initial value for this attribute.

atkAttribute::setLabel()

Set the label of the attribute

atkAttribute::setLoadType()

Sets the load type.

atkAttribute::setOwnerInstance()

Sets the owner instance.

atkAttribute::setPostFixLabel()

Set the label of the attribute

atkAttribute::setSections()

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

atkAttribute::setStorageType()

Sets the storage type.

atkAttribute::setTabs()

Put the attribute on one or more tabs.

atkAttribute::setViewCallback()

Sets the view callback.

atkAttribute::showOnTab()

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

atkAttribute::smartSearchCondition()

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

atkAttribute::sortOptions()

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

atkAttribute::sortOrder()

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

atkAttribute::storageType()

Determine the storage type of this attribute.

atkAttribute::sum()

Calculate the sum of 2 records.

atkAttribute::text()

Translate using the owner instance's module and type.

atkAttribute::validate()

Checks if a value is valid.

atkAttribute::value2db()

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

atkAttribute::_callDependencies()

Calls the dependency callbacks for this attribute.

atkAttribute::_renderChangeHandler()

Renders the onchange code on the page.

atkAttribute::__toString()

String representation for this attribute (PHP5 only).

[ Top ]

Constant Summary

DEFAULT_SEPARATOR
SEPARATOR_DECIMAL
SEPARATOR_THOUSAND

[ Top ]

Property Summary

mixed	$m_decimals
mixed	$m_decimalseparator
mixed	$m_maxvalue
mixed	$m_minvalue
mixed	$m_size
mixed	$m_thousandsseparator
mixed	$m_use_thousands_separator

[ Top ]

Method Summary

static String	standardiseSeparator()	Replace decimal separator (from the language file "decimal_separator") with the standard separator ('.') so, for instance, 99,95 would become 99.95 when language is set to 'nl'.
static String	translateSeparator()	Replace standard decimal separator ('.') with the one from the language file so, for instance, 99.95 would be converted to 99,95 when language is set to 'nl'.
atkNumberAttribute	atkNumberAttribute()	Constructor
int	dbFieldSize()	Return the size of the field in the database.
String	dbFieldType()	Return the database field type of the attribute.
String	display()	Returns a displayable string for this value, to be used in HTML pages.
Piece	edit()	Returns a piece of html code that can be used in a form to edit this attribute's value.
void	fetchMeta()	Apply database metadata for setting the attribute size.
String	fetchValue()	Convert values from an HTML form posting to an internal value for this attribute.
string	formatNumber()	Formats the number based on setting in the language file
query	getBetweenCondition()	Get the between search condition
int	getDecimals()	Returns the number of decimals.
String	getDecimalSeparator()	Get the decimal separator
String	getOrderByStatement()	Retrieves the ORDER BY statement for this attribute's node.
String	getSearchCondition()	Creates a searchcondition for the field, was once part of searchCondition, however, searchcondition() also immediately adds the search condition.
array	getSearchModes()	Retrieve the list of searchmodes supported by the attribute.
String	getThousandsSeparator()	Get the thousands separator
bool	getUseThousandsSeparator()	Returns true if we 're using the thousands separator when formatting the number
String	hide()	Returns a piece of html code for hiding this attribute in an HTML form, while still posting its value. (<input type="hidden">)
string	processSearchValue()	Process the search value
String	removeSeparators()	convert a formatted number to a real number
String	search()	Returns a piece of html code that can be used to search for an attribute's value.
void	setDecimals()	Sets the number of decimals.
void	setDecimalSeparator()	Set the decimal separator
void	setRange()	Set the minimum and maximum value of the number. Violations of this range
void	setThousandsSeparator()	Set the thousands separator
bool	setUseThousandsSeparator()	Use the thousands separator when formatting a number
$record	validate()	Validates if value is numeric
String	value2db()	Converts the internal attribute value to one that is understood by the database.

[ Top ]

Properties

mixed $m_decimals = null [line 30]

[ Top ]

mixed $m_decimalseparator [line 34]

[ Top ]

mixed $m_maxvalue = false [line 32]

[ Top ]

mixed $m_minvalue = false [line 31]

[ Top ]

mixed $m_size [line 29]

Redefinition of:

atkAttribute::$m_size: The size the attribute's field.

[ Top ]

mixed $m_thousandsseparator [line 35]

[ Top ]

mixed $m_use_thousands_separator = false [line 33]

[ Top ]

Methods

static method standardiseSeparator [line 163]

static String standardiseSeparator(
String
$number 
)

Replace decimal separator (from the language file "decimal_separator") with the standard separator ('.') so, for instance, 99,95 would become 99.95 when language is set to 'nl'.

Parameters:

String

$number:

The number that needs to be converted

API Tags:

Return:	The converted number
Deprecated:

[ Top ]

static method translateSeparator [line 344]

static String translateSeparator(
String
$number 
)

Replace standard decimal separator ('.') with the one from the language file so, for instance, 99.95 would be converted to 99,95 when language is set to 'nl'.

Parameters:

String

$number:

The number that needs to be converted

API Tags:

Return:	The converted number
Deprecated:

[ Top ]

Constructor atkNumberAttribute [line 53]

atkNumberAttribute atkNumberAttribute(
string
$name, [int
$flags = 0], [mixed
$size = 10], [int
$decimals = null] 
)

Constructor

Parameters:

string	$name:	Name of the attribute
int	$flags:	Flags for this attribute
mixed	$size:	The size(s) of integral part (before seperator) for this attribute (default 10) also accepts an array. See setAttribSize for format.
int	$decimals:	The number of decimals to use.

[ Top ]

dbFieldSize [line 459]

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

Redefinition of:

atkAttribute::dbFieldSize(): Return the size of the field in the database.

[ Top ]

dbFieldType [line 437]

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().

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 145]

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

Redefinition of:

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

Redefined in descendants as:

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.

[ Top ]

edit [line 512]

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

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

Parameters:

array	$record:	Array with values
string	$fieldprefix:	The attribute must use this to prefix its form elements (used for embedded forms)
string	$mode:	The mode we're in ('add' or 'edit')

API Tags:

Return:

of htmlcode

Redefinition of:

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

Redefined in descendants as:

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.

[ Top ]

fetchMeta [line 467]

void fetchMeta(

$metadata 
)

Apply database metadata for setting the attribute size.

Parameters:

$metadata:

Redefinition of:

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

[ Top ]

fetchValue [line 378]

String fetchValue(
array
$postvars 
)

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

If the user entered a number in his native language, he may have used a different decimal separator, which we first convert to the '.' standard separator (ATK uses the regular dot notation internally)

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.

Redefined in descendants as:

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

[ Top ]

formatNumber [line 308]

string formatNumber(
float
$number, [string
$decimalSeparator = ""], [string
$thousandsSeparator = ""] 
)

Formats the number based on setting in the language file

Parameters:

float	$number:	number
string	$decimalSeparator:	override decimal separator
string	$thousandsSeparator:	override thousands separator

API Tags:

Return:	nicely formatted number
Access:	protected

[ Top ]

getBetweenCondition [line 666]

query getBetweenCondition(

&$query, string
$fieldname, string
$value, atkQuery
$query 
)

Get the between search condition

Parameters:

atkQuery	$query:	The query object where the search condition should be placed on
string	$fieldname:	The name of the field in the database
string	$value:	The processed search value
	&$query:

API Tags:

Return:

where clause for searching

[ Top ]

getDecimals [line 67]

int getDecimals(
)

Returns the number of decimals.

API Tags:

Return:	decimals
Access:	public

[ Top ]

getDecimalSeparator [line 283]

String getDecimalSeparator(
)

Get the decimal separator

API Tags:

Return:	with the decimal separator
Access:	public

[ Top ]

getOrderByStatement [line 105]

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

Redefinition of:

atkAttribute::getOrderByStatement(): Retrieves the ORDER BY statement for this attribute's node.

[ Top ]

getSearchCondition [line 705]

String getSearchCondition(

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

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

Parameters:

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

API Tags:

Return:

The searchcondition to use.

Redefinition of:

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

[ Top ]

getSearchModes [line 417]

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

Redefinition of:

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

[ Top ]

getThousandsSeparator [line 263]

String getThousandsSeparator(
)

Get the thousands separator

API Tags:

Return:	with the thousands separator
Access:	public

[ Top ]

getUseThousandsSeparator [line 253]

bool getUseThousandsSeparator(
)

Returns true if we 're using the thousands separator when formatting the number

API Tags:

Access:

public

[ Top ]

hide [line 181]

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">)

We have to format the value, so it matches the display value Otherwise the value will be corrupted by removeSeparators

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">)

[ Top ]

processSearchValue [line 616]

string processSearchValue(
string
$value, 
&$searchmode, string
$searchmode 
)

Process the search value

Parameters:

string	$value:	The search value
string	$searchmode:	The searchmode to use. This can be any one of the supported modes, as returned by this attribute's getSearchModes() method.
	&$searchmode:

API Tags:

Return:

with the processed search value

[ Top ]

removeSeparators [line 202]

String removeSeparators(
String
$number, [String
$decimal_separator = ""], [String
$thousands_separator = ""] 
)

convert a formatted number to a real number

Parameters:

String	$number:	The number that needs to be converted
String	$decimal_separator:	override decimal separator
String	$thousands_separator:	override thousands separator

API Tags:

Return:

The converted number

[ Top ]

search [line 565]

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

Returns a piece of html code that can be used to search for an attribute's value.

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 ]

setDecimals [line 77]

void setDecimals(
int
$decimals 
)

Sets the number of decimals.

Parameters:

int

$decimals:

number of decimals

API Tags:

Access:

public

[ Top ]

setDecimalSeparator [line 293]

void setDecimalSeparator(
string
$separator 
)

Set the decimal separator

Parameters:

string

$separator:

The decimal separator

API Tags:

Access:

public

[ Top ]

setRange [line 88]

void setRange(
int
$minvalue, int
$maxvalue 
)

Set the minimum and maximum value of the number. Violations of this range

Parameters:

int	$minvalue:	Minimum value of the number.
int	$maxvalue:	Maximum value of the number.

API Tags:

Access:

public

[ Top ]

setThousandsSeparator [line 273]

void setThousandsSeparator(
string
$separator 
)

Set the thousands separator

Parameters:

string

$separator:

The thousands separator

API Tags:

Access:

public

[ Top ]

setUseThousandsSeparator [line 242]

bool setUseThousandsSeparator(
bool
$use_separator 
)

Use the thousands separator when formatting a number

Parameters:

bool

$use_separator:

API Tags:

Access:

public

[ Top ]

validate [line 356]

$record validate(

&$record, string
$mode, array
$record 
)

Validates if value is numeric

Parameters:

array	$record:	Record that contains value to be validated. Errors are saved in this record
string	$mode:	can be either "add" or "update"
	&$record:

Redefinition of:

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

[ Top ]

value2db [line 398]

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

Redefinition of:

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

[ Top ]

Constants

DEFAULT_SEPARATOR = '.' [line 42]

[ Top ]

SEPARATOR_DECIMAL = 'decimal_separator' [line 38]

[ Top ]

SEPARATOR_THOUSAND = 'thousands_separator' [line 39]

[ Top ]