Docs For Class atkFuzzySearchAttribute

Home

Documentation home

Atk index

Docs For Class atkFuzzySearchAttribute [ package: atk ]

Class: atkFuzzySearchAttribute

Source Location: /attributes/class.atkfuzzysearchattribute.inc

Class atkFuzzySearchAttribute

Class Overview

The atkFuzzySearchAttribute class represents an attribute of a node that has a field where you can enter certain keywords to search for on another node.

Located in /attributes/class.atkfuzzysearchattribute.inc [line 25]

Wiki documentation

atkAttribute
   |
   --atkFuzzySearchAttribute

Author(s):

Ivo Jansch <ivo@achievo.org>

Information Tags:

Properties

Methods

[ Top ]

Descendants

Child Class	Description
atkTagAttribute	This attribute is used for adding tags to a node For example: This attribute can be used in a blog node for adding tags to the blogpost.

[ 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

String	$m_callback	The function to call back with the record and results
String	$m_destinationFilter
Array	$m_matches	The matches we got from the search
String	$m_mode	The mode of the the fuzzy search
String	$m_searchnode	The node we are searching on
int	$m_searchnodeInstance	An instance of the node we are searching on

[ Top ]

Method Summary

atkFuzzySearchAttribute	atkFuzzySearchAttribute()	The fuzzySearchAttribute, with this you can search a node for certain keywords and get a selectable list of records that match the keywords.
void	addSearchFilter()	Adds a filter on the instance of the searchnode
void	addToQuery()	Dummy method to prevent loading/storing of data.
boolean	createSearchNodeInstance()	Creates an instance of the node we are searching on and stores it in a member variable ($this->m_searchnodeInstance)
void	dbFieldSize()	Dummy method to prevent loading/storing of data.
void	dbFieldType()	Dummy method to prevent loading/storing of data.
String	edit()	Returns a piece of html code that can be used in a form to edit this attribute's value.
void	fetchMeta()	Dummy method to prevent loading/storing of data.
String	getDestinationFilter()	Returns the destination filter.
Array	getMatches()	The actual function that does the searching
void	getSearchCondition()	Dummy method to prevent loading/storing of data.
Array	getSearchModes()	Dummy method to prevent loading/storing of data.
void	hide()	Dummy method to prevent loading/storing of data.
void	load()	Dummy method to prevent loading/storing of data.
void	search()	Dummy method to prevent loading/storing of data.
void	searchCondition()	Dummy method to prevent loading/storing of data.
void	setDestinationFilter()	Sets the destination filter.
boolean	store()	Override the store method of this attribute to search
void	validate()	Checks if a value is valid.

[ Top ]

Properties

String $m_callback = "" [line 39]

The function to call back with the record and results

API Tags:

Access:

private

[ Top ]

String $m_destinationFilter = "" [line 65]

[ Top ]

Array $m_matches = array() [line 53]

The matches we got from the search

API Tags:

Access:

private

[ Top ]

String $m_mode = "all" [line 46]

The mode of the the fuzzy search

API Tags:

Access:

private

[ Top ]

String $m_searchnode = "" [line 32]

The node we are searching on

API Tags:

Access:

private

[ Top ]

int $m_searchnodeInstance = NULL [line 60]

An instance of the node we are searching on

API Tags:

Access:

private

[ Top ]

Methods

Constructor atkFuzzySearchAttribute [line 87]

atkFuzzySearchAttribute atkFuzzySearchAttribute(
String
$name, String
$searchnode, String
$callback, [String
$mode = "all"], [int
$flags = 0], [int
$size = 0] 
)

The fuzzySearchAttribute, with this you can search a node for certain keywords and get a selectable list of records that match the keywords.

Possible modes:

all (default) return everything
first return only the first result
firstperkeyword return the first result per keyword
select make the user select
selectperkeyword make the user select for every keyword
multiselect ?

Parameters:

String	$name:	The name of the attribute
String	$searchnode:	The node to search on
String	$callback:	The function of the owner node to call with the record to store and the results of the search Has to return a status (true or false)
String	$mode:	The mode of the search (all(default)\|first\|firstperkeyword\| select\|selectperkeyword\|multiselect)
int	$flags:	The flags of the attribute
int	$size:	The size of the search field

[ Top ]

addSearchFilter [line 484]

void addSearchFilter(
String
$filter, [String
$value = ""] 
)

Adds a filter on the instance of the searchnode

Parameters:

String	$filter:	The fieldname you want to filter OR a SQL where clause expression.
String	$value:	Required value. (Ommit this parameter if you pass an SQL expression for $filter.)

Redefined in descendants as:

atkTagAttribute::addSearchFilter() : Adds a filter on the instance of the destination

[ Top ]

addToQuery [line 434]

void addToQuery(
)

Dummy method to prevent loading/storing of data.

Redefinition of:

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

Redefined in descendants as:

atkTagAttribute::addToQuery() : Dummy implementation

[ Top ]

createSearchNodeInstance [line 105]

boolean createSearchNodeInstance(
)

Creates an instance of the node we are searching on and stores it in a member variable ($this->m_searchnodeInstance)

[ Top ]

dbFieldSize [line 470]

void dbFieldSize(
)

Dummy method to prevent loading/storing of data.

Redefinition of:

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

Redefined in descendants as:

atkTagAttribute::dbFieldSize() : Dummy implementation

[ Top ]

dbFieldType [line 475]

void dbFieldType(
)

Dummy method to prevent loading/storing of data.

Redefinition of:

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

Redefined in descendants as:

atkTagAttribute::dbFieldType() : Dummy implementation

[ Top ]

edit [line 186]

String edit(
[array
$rec = ""], [String
$prefix = ""], [String
$mode = ""] 
)

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

Parameters:

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

Redefined in descendants as:

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

[ Top ]

fetchMeta [line 465]

void fetchMeta(
)

Dummy method to prevent loading/storing of data.

Redefinition of:

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

Redefined in descendants as:

atkTagAttribute::fetchMeta() : Dummy implementation

[ Top ]

getDestinationFilter [line 494]

String getDestinationFilter(
)

Returns the destination filter.

API Tags:

Return:

The destination filter.

[ Top ]

getMatches [line 295]

Array getMatches(
String
$searchstring 
)

The actual function that does the searching

Parameters:

String

$searchstring:

The string to search for

API Tags:

Return:

The matches

Redefined in descendants as:

atkTagAttribute::getMatches() : The actual function that does the searching

[ Top ]

getSearchCondition [line 460]

void getSearchCondition(
)

Dummy method to prevent loading/storing of data.

Redefinition of:

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

Redefined in descendants as:

atkTagAttribute::getSearchCondition() : Dummy implementation

[ Top ]

getSearchModes [line 450]

Array getSearchModes(
)

Dummy method to prevent loading/storing of data.

API Tags:

Return:

empty array

Redefinition of:

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

Redefined in descendants as:

atkTagAttribute::getSearchModes() : Dummy implementation

[ Top ]

hide [line 439]

void hide(
)

Dummy method to prevent loading/storing of data.

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:

atkTagAttribute::hide() : Dummy implementation

[ Top ]

load [line 429]

void load(
)

Dummy method to prevent loading/storing of data.

Redefined in descendants as:

atkTagAttribute::load() : load function

[ Top ]

search [line 444]

void search(
)

Dummy method to prevent loading/storing of data.

Redefinition of:

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

Redefined in descendants as:

atkTagAttribute::search() : Dummy implementation

[ Top ]

searchCondition [line 455]

void searchCondition(
)

Dummy method to prevent loading/storing of data.

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.

Redefined in descendants as:

atkTagAttribute::searchCondition() : Dummy implementation

[ Top ]

setDestinationFilter [line 503]

void setDestinationFilter(
String
$filter 
)

Sets the destination filter.

Parameters:

String

$filter:

The destination filter.

[ Top ]

store [line 321]

boolean store(
atkDb
$db, array
$rec, string
$mode 
)

Override the store method of this attribute to search

Parameters:

atkDb	$db:
array	$rec:	The record
string	$mode:

Redefined in descendants as:

atkTagAttribute::store() : Store the value of this attribute

[ Top ]

validate [line 127]

void validate(

&$rec, String
$mode, array
$rec 
)

Checks if a value is valid.

Note that obligatory and unique fields are checked by the atkNodeValidator, and not by the validate() method itself.

Parameters:

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

Redefinition of:

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

Redefined in descendants as:

atkTagAttribute::validate() : Validate the input based on the current mode.

[ Top ]