Class: atkWeekdayAttribute
Source Location: /attributes/class.atkweekdayattribute.inc
Class atkWeekdayAttribute
Inherited from parent
|
Inherited From atkNumberAttribute
-
atkNumberAttribute::$m_decimals
-
-
atkNumberAttribute::$m_decimalseparator
-
-
atkNumberAttribute::$m_maxvalue
-
-
atkNumberAttribute::$m_minvalue
-
-
atkNumberAttribute::$m_size
-
-
atkNumberAttribute::$m_thousandsseparator
-
-
atkNumberAttribute::$m_use_thousands_separator
-
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 atkNumberAttribute
-
atkNumberAttribute::atkNumberAttribute()
-
Constructor
-
atkNumberAttribute::dbFieldSize()
-
Return the size of the field in the database.
-
atkNumberAttribute::dbFieldType()
-
Return the database field type of the attribute.
-
atkNumberAttribute::display()
-
Returns a displayable string for this value, to be used in HTML pages.
-
atkNumberAttribute::edit()
-
Returns a piece of html code that can be used in a form to edit this attribute's value.
-
atkNumberAttribute::fetchMeta()
-
Apply database metadata for setting the attribute size.
-
atkNumberAttribute::fetchValue()
-
Convert values from an HTML form posting to an internal value for this attribute.
-
atkNumberAttribute::formatNumber()
-
Formats the number based on setting in the language file
-
atkNumberAttribute::getBetweenCondition()
-
Get the between search condition
-
atkNumberAttribute::getDecimals()
-
Returns the number of decimals.
-
atkNumberAttribute::getDecimalSeparator()
-
Get the decimal separator
-
atkNumberAttribute::getOrderByStatement()
-
Retrieves the ORDER BY statement for this attribute's node.
-
atkNumberAttribute::getSearchCondition()
-
Creates a searchcondition for the field, was once part of searchCondition, however, searchcondition() also immediately adds the search condition.
-
atkNumberAttribute::getSearchModes()
-
Retrieve the list of searchmodes supported by the attribute.
-
atkNumberAttribute::getThousandsSeparator()
-
Get the thousands separator
-
atkNumberAttribute::getUseThousandsSeparator()
-
Returns true if we 're using the thousands separator when formatting the number
-
atkNumberAttribute::hide()
-
Returns a piece of html code for hiding this attribute in an HTML form, while still posting its value. (<input type="hidden">)
-
atkNumberAttribute::processSearchValue()
-
Process the search value
-
atkNumberAttribute::removeSeparators()
-
convert a formatted number to a real number
-
atkNumberAttribute::search()
-
Returns a piece of html code that can be used to search for an attribute's value.
-
atkNumberAttribute::setDecimals()
-
Sets the number of decimals.
-
atkNumberAttribute::setDecimalSeparator()
-
Set the decimal separator
-
atkNumberAttribute::setRange()
-
Set the minimum and maximum value of the number. Violations of this range
-
atkNumberAttribute::setThousandsSeparator()
-
Set the thousands separator
-
atkNumberAttribute::setUseThousandsSeparator()
-
Use the thousands separator when formatting a number
-
atkNumberAttribute::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'.
-
atkNumberAttribute::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::validate()
-
Validates if value is numeric
-
atkNumberAttribute::value2db()
-
Converts the internal attribute value to one that is understood by the database.
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 From atkNumberAttribute
-
atkNumberAttribute::DEFAULT_SEPARATOR
-
-
atkNumberAttribute::SEPARATOR_DECIMAL
-
-
atkNumberAttribute::SEPARATOR_THOUSAND
-
|
Method Summary
| 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. |
| String |
fetchValue() |
Convert values from an HTML form posting to an internal value for this attribute. |
Methods
atkWeekdayAttribute atkWeekdayAttribute(
String
$name, [int
$extraOrFlags = 0], [int
$flags = 0]
)
|
|
Constructor.
Parameters:
|
String |
$name: |
Name of the attribute (unique within a node, and corresponds to the name of the datetime field in the database where the stamp is stored. |
|
int |
$extraOrFlags: |
Flags for the attribute or array of extra options these options will be numbered from 2^7 (128) to 2^x. |
|
int |
$flags: |
Flags for the attribute. Only used if no set in previous param. |
String display(
array
$record, [String
$mode = "list"]
)
|
|
Returns a displayable string for this value, to be used in HTML pages.
In this case, the timestamp is returned in human readable format.
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). The regular atkAttribute does not use this parameter, but derived attributes may use it to distinguish between the two display modes. |
API Tags:
Redefinition of:
- atkNumberAttribute::display()
- Returns a displayable string for this value, to be used in HTML pages.
String edit(
[array
$record = ""], [String
$fieldprefix = ""], [String
$mode = 'add']
)
|
|
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:
- atkNumberAttribute::edit()
- Returns a piece of html code that can be used in a form to edit this attribute's value.
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:
- atkNumberAttribute::fetchValue()
- Convert values from an HTML form posting to an internal value for this attribute.