ACF core principles - Revision history

Fab: Reverted edits by RuthHughes (talk) to last revision by Ttrask

2016-03-07T12:30:38Z

Reverted edits by RuthHughes (talk) to last revision by Ttrask

← Older revision		Revision as of 12:30, 7 March 2016
Line 86:		Line 86:

	[[Category:ACF]]		[[Category:ACF]]

	~~== private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm ==~~

	Offers private label cosmetics with custom design. We produce lip balms, serum, creams and more. Easy to buy with eshop. Private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm

	~~[[http://ultra-high-end.com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm]]~~

	~~[[http://ultra-high-end.com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm]]~~

	~~== private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm ==~~

	Offers private label cosmetics with custom design. We produce lip balms, serum, creams and more. Easy to buy with eshop. Private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm

	~~[[http://ultra-high-end.com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm]]~~

	~~[[http://ultra-high-end.com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm]]~~

	~~== private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm ==~~

	Offers private label cosmetics with custom design. We produce lip balms, serum, creams and more. Easy to buy with eshop. Private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm

	~~[[http://ultra-high-end.com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm]]~~

	~~[[http://ultra-high-end.com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm]]~~

	~~== private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm ==~~

	Offers private label cosmetics with custom design. We produce lip balms, serum, creams and more. Easy to buy with eshop. Private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm

	~~[[http://ultra-high-end.com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm]]~~

	~~[[http://ultra-high-end.com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm]]~~

	~~== private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm ==~~

	Offers private label cosmetics with custom design. We produce lip balms, serum, creams and more. Easy to buy with eshop. Private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm

	~~[[http://ultra-high-end.com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm]]~~

	~~[[http://ultra-high-end.com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm]]~~

RuthHughes: minor updates

2016-03-07T03:10:35Z

minor updates

← Older revision		Revision as of 03:10, 7 March 2016
Line 86:		Line 86:

	[[Category:ACF]]		[[Category:ACF]]

			== private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm ==

			Offers private label cosmetics with custom design. We produce lip balms, serum, creams and more. Easy to buy with eshop. Private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm

			[[http://ultra-high-end.com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm]]

			[[http://ultra-high-end.com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm]]

			== private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm ==

			Offers private label cosmetics with custom design. We produce lip balms, serum, creams and more. Easy to buy with eshop. Private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm

			[[http://ultra-high-end.com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm]]

			[[http://ultra-high-end.com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm]]

			== private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm ==

			Offers private label cosmetics with custom design. We produce lip balms, serum, creams and more. Easy to buy with eshop. Private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm

			[[http://ultra-high-end.com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm]]

			[[http://ultra-high-end.com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm]]

			== private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm ==

			Offers private label cosmetics with custom design. We produce lip balms, serum, creams and more. Easy to buy with eshop. Private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm

			[[http://ultra-high-end.com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm]]

			[[http://ultra-high-end.com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm]]

			== private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm ==

			Offers private label cosmetics with custom design. We produce lip balms, serum, creams and more. Easy to buy with eshop. Private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm

			[[http://ultra-high-end.com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm]]

			[[http://ultra-high-end.com/custom-made.html private label cosmetics, custom made cosmetic, custom made cream, custom lip stick lip balm]]

Ttrask: Remove CRUD section, remove function type, change table type to structure

2016-01-13T19:54:45Z

Remove CRUD section, remove function type, change table type to structure

← Older revision		Revision as of 19:54, 13 January 2016
Line 62:		Line 62:
	\| multi \|\| a multi-select list \|\| ''value'' is an array of selected items <br>''option'' is an array of select options		\| multi \|\| a multi-select list \|\| ''value'' is an array of selected items <br>''option'' is an array of select options
	\|-		\|-
	\| list \|\| a list \|\| ''value'' is an array of ~~items~~		\| list \|\| a list \|\| ''value'' is an array of strings
	\|-		\|-
	\| boolean \|\| true or false \|\|		\| boolean \|\| true or false \|\|
	\|-		\|-
	\| raw \|\| raw binary data \|\|		\| raw \|\| raw binary data \|\|
	\|-
	~~\| function \|\| a function \|\| ''value'' is a function (generally used for iterators returning very large data)~~
	\|-		\|-
	\| form \|\| a set of cfe's that make up a form \|\| ''value'' is a table of cfe's that make up a form (the table should be name-indexed)<br>''option'' is the command name to save changes (button name for HTML)<br>''descr'' or ''errtxt'' may contain the result of a save attempt		\| form \|\| a set of cfe's that make up a form \|\| ''value'' is a table of cfe's that make up a form (the table should be name-indexed)<br>''option'' is the command name to save changes (button name for HTML)<br>''descr'' or ''errtxt'' may contain the result of a save attempt
	\|-		\|-
	\| group \|\| a set of cfe's that make up an anonymous group \|\| ''value'' is a table of grouped cfe's (can be used to pass several items to a view)		\| group \|\| a set of cfe's that make up an anonymous group \|\| ''value'' is a table of grouped cfe's (can be used to pass several items to a view) (the table should be name-indexed)
	\|-		\|-
	\| ~~table~~ \|\| a Lua table with no further type info \|\|		\| structure \|\| a Lua table with no further type info \|\|
	\|-		\|-
	\| password \|\| a password which should not be readable by a user \|\|		\| password \|\| a password which should not be readable by a user \|\|
Line 80:		Line 78:
	\| hidden \|\| a hidden field typically containing information used by ACF and not visible to a user \|\|		\| hidden \|\| a hidden field typically containing information used by ACF and not visible to a user \|\|
	\|}		\|}

	~~= Use of CRUD =~~

	CRUD stands for Create Read Update Delete. Where possible, ACF models/controllers should follow this pattern. To help reuse of code, the functions in models and controllers should have one of Create Read Update or Delete in their names (create_interface_by_name, update_hostname, delete_package, read_timezone, etc.)

	= The Model defines the object set =		= The Model defines the object set =

Ncopa: added to ACF category

2012-03-12T04:40:57Z

added to ACF category

← Older revision		Revision as of 04:40, 12 March 2012
Line 90:		Line 90:

	Since the model can choose how much or how little of the system to expose, the basic data set should be defined in the model.		Since the model can choose how much or how little of the system to expose, the basic data set should be defined in the model.

			[[Category:ACF]]

Ttrask: Update to reflect some of the newer principles

2012-02-09T14:25:12Z

Update to reflect some of the newer principles

← Older revision		Revision as of 14:25, 9 February 2012
Line 1:		Line 1:
	While the mvc.lua code provides a generic framework for any lua "mvc"-based ~~appliction~~, "acf" is the component that makes the mvc.lua framework into a configuration Application. Some ideas and rationales for application-wide settings are discussed here.		While the mvc.lua code provides a generic framework for any lua "mvc"-based application, "acf" is the component that makes the mvc.lua framework into a web configuration Application. Some ideas and rationales for application-wide settings are discussed here.

	= Use of ''cfe'' =		= Use of ''cfe'' =

	A ''cfe'' ('''C'''onfiguration '''F'''ramework '''E'''ntity) is a way to pass data between a model,controller and view in a common way. There are many ways to do this (e.g. closures, AKClass); use of cfe is an arbitrary decision just to keep development moving forward.		A ''cfe'' ('''C'''onfiguration '''F'''ramework '''E'''ntity) is a way to pass data between a model, controller and view in a common way. There are many ways to do this (e.g. closures, AKClass); use of cfe is an arbitrary decision just to keep development moving forward.

	A cfe is a table with some fields guaranteed to exist. It is also a way to abstract user-modifiable data from view-centric ~~html~~ input types. ACF isn't necessarily web-only. With a different controller and views, it could be cli (or gui?!)		A cfe is a table with some fields guaranteed to exist. It is also a way to abstract user-modifiable data from view-centric HTML input types. ACF isn't necessarily web-only. With a different controller and views, it could be cli (or gui?!). The acf-cli application is an example of this.

	== Fields in all cfes ==		== Fields in all cfes ==

	cfe's are constructed from a function in <tt>~~acf-controller~~.lua</tt> that returns an anonymous table with the following fields		cfe's are constructed from a function in <tt>mvc.lua</tt> that returns an anonymous table with the following fields

	{\| border=1		{\| border=1
	! Field !! Default !! Description		! Field !! Default !! Description
	\|-		\|-
	\|value \|\| "" \|\| The value of the cfe (e.g. the ip address, hostname, password, etc.)		\|value \|\| "" \|\| The value of the cfe (e.g. the IP address, hostname, password, etc.)
	\|-		\|-
	\|type \|\| "text" \|\| The type of entity (see below)		\|type \|\| "text" \|\| The type of entity (see below)
Line 21:		Line 21:
	\|}		\|}

	The reason for having these fields pre-defined is to allow models,controllers and views to use the indexes without having to first check if they exist. For example the entity will always have a value and type.		The reason for having these fields pre-defined is to allow models, controllers and views to use the indexes without having to first check if they exist. For example the entity will always have a value and type.

	cfe's can have other fields. Some common fields that may, or may not, be present:		cfe's can have other fields. Some common fields that may, or may not, be present:
Line 33:		Line 33:
	\|-		\|-
	\|descr \|\| User-readable description for the value		\|descr \|\| User-readable description for the value
			\|-
			\|seq \|\| Numeric sequence suggesting display order for cfe's in a group or form
			\|-
			\|default \|\| Default value (can be displayed to user)
			\|-
			\|readonly \|\| If present, indicates that the information is to be displayed, but not editable, typically used in forms
	\|}		\|}

Line 64:		Line 70:
	\| function \|\| a function \|\| ''value'' is a function (generally used for iterators returning very large data)		\| function \|\| a function \|\| ''value'' is a function (generally used for iterators returning very large data)
	\|-		\|-
	\| form \|\| a set of cfe's that make up a form \|\| ''value'' is a table of ~~cfes~~ that make up a form (the table should be name-indexed)<br>''option'' is the command name to save changes (button name for HTML)<br>''descr'' or ''errtxt'' may contain the result of a save attempt		\| form \|\| a set of cfe's that make up a form \|\| ''value'' is a table of cfe's that make up a form (the table should be name-indexed)<br>''option'' is the command name to save changes (button name for HTML)<br>''descr'' or ''errtxt'' may contain the result of a save attempt
			\|-
			\| group \|\| a set of cfe's that make up an anonymous group \|\| ''value'' is a table of grouped cfe's (can be used to pass several items to a view)
			\|-
			\| table \|\| a Lua table with no further type info \|\|
			\|-
			\| password \|\| a password which should not be readable by a user \|\|
	\|-		\|-
	\| ~~group~~ \|\| a ~~set of cfe's that make up an anonymous group \|\| ''value'' is a table of grouped cfes (can be~~ used ~~to pass several items~~ to a ~~view)~~		\| hidden \|\| a hidden field typically containing information used by ACF and not visible to a user \|\|
	\|}		\|}

	= Use of CRUD =		= Use of CRUD =

	CRUD stands for Create Read Update Delete. Where possible, ACF models/controllers should follow this pattern. To help reuse of code, the functions in models and controllers should have one of ~~Cread~~ Read Update or Delete in their names (create_interface_by_name, update_hostname, delete_package, read_timezone, etc.)		CRUD stands for Create Read Update Delete. Where possible, ACF models/controllers should follow this pattern. To help reuse of code, the functions in models and controllers should have one of Create Read Update or Delete in their names (create_interface_by_name, update_hostname, delete_package, read_timezone, etc.)

	~~= Use of cmd =~~

	~~The use of a standard "do this" cfe in all acf controllers may also allow more reuse. It is suggested to use "cmd" as the ''name'' of this cfe, with the value being the command to perform.~~


	= The Model defines the object set =		= The Model defines the object set =

	The model is responsible for writing and reading from the running system. The model ~~also~~ does not need to know which part of a specific acf module it is running under. It is not mandatory that the model be lua "oop" as the rest of the system is. (the model may not have any need to know "self")		The model is responsible for writing and reading from the running system. The model typically does not need to know which part of a specific acf module it is running under. It is not mandatory that the model be lua "oop" as the rest of the system is. (the model may not have any need to know "self")


	Since the model can choose how much or how little of the system to expose, the basic data set should be defined in the model ~~(perhaps as a constructor function)~~		Since the model can choose how much or how little of the system to expose, the basic data set should be defined in the model.

Ttrask: /* Use of ''cfe'' */

2008-05-15T20:25:37Z

Use of ''cfe''

← Older revision		Revision as of 20:25, 15 May 2008
Line 45:		Line 45:
	The ''type'' field of a cfe can be one of the following:		The ''type'' field of a cfe can be one of the following:

	{\|		{\| border=1
	\|-
	! type !! Description !! Modifiers		! type !! Description !! Modifiers
	\|-		\|-
Line 53:		Line 52:
	\| longtext \|\| a multi-line text field, like a textarea \|\|		\| longtext \|\| a multi-line text field, like a textarea \|\|
	\|-		\|-
	\| select \|\| a select list \|\| ''value'' is the currently selected item <br>''option'' is ~~a table~~ of select options		\| select \|\| a select list \|\| ''value'' is the currently selected item <br>''option'' is an array of select options
	\|-		\|-
	\| multi \|\| a multi-select list \|\| ''value'' is ~~a table~~ of selected items <br>''option'' is ~~a table~~ of select options		\| multi \|\| a multi-select list \|\| ''value'' is an array of selected items <br>''option'' is an array of select options
	\|-		\|-
	\| list \|\| a list \|\| ''value'' is ~~a table~~ of items		\| list \|\| a list \|\| ''value'' is an array of items
	\|-		\|-
	\| boolean \|\| true or false \|\|		\| boolean \|\| true or false \|\|
Line 65:		Line 64:
	\| function \|\| a function \|\| ''value'' is a function (generally used for iterators returning very large data)		\| function \|\| a function \|\| ''value'' is a function (generally used for iterators returning very large data)
	\|-		\|-
	\| form \|\| a set of cfe's that make up a form \|\| ''value'' is a table of cfes that make up a form (the table should be name-indexed)		\| form \|\| a set of cfe's that make up a form \|\| ''value'' is a table of cfes that make up a form (the table should be name-indexed)<br>''option'' is the command name to save changes (button name for HTML)<br>''descr'' or ''errtxt'' may contain the result of a save attempt
	\|-		\|-
	\| group \|\| a set of cfe's that make up an anonymous group \|\| ''value'' is a table of grouped cfes (can be used to pass several items to a view)		\| group \|\| a set of cfe's that make up an anonymous group \|\| ''value'' is a table of grouped cfes (can be used to pass several items to a view)
	\|}		\|}


	= Use of CRUD =		= Use of CRUD =

Ttrask at 15:56, 15 May 2008

2008-05-15T15:56:05Z

← Older revision		Revision as of 15:56, 15 May 2008
Line 14:		Line 14:
	! Field !! Default !! Description		! Field !! Default !! Description
	\|-		\|-
	\|value \|\| ~~empty~~ \|\|The value of the cfe (e.g. the ip address, hostname, password, etc.)		\|value \|\| "" \|\| The value of the cfe (e.g. the ip address, hostname, password, etc.)
	\|-		\|-
	\|type \|\| text \|\| The type of entity (see below)		\|type \|\| "text" \|\| The type of entity (see below)
	\|-		\|-
	\|~~option~~ \|\|~~empty~~ \|\|~~common modifiers~~ for ~~this type of cfe~~		\|label \|\| "" \|\| User-readable label for the value
	\|-
	~~\|errtxt \|\| empty \|\|text explaining why validation failed~~
	\|}		\|}

	The reason for having these fields pre-defined is to allow models,controllers and views to use the indexes without having to first check if they exist. For example the entity will always have a value and type.		The reason for having these fields pre-defined is to allow models,controllers and views to use the indexes without having to first check if they exist. For example the entity will always have a value and type.

	cfe's can have other fields, or ~~can have their defaults overwritten by specifying a table in the argument list to the cfe constructor~~:		cfe's can have other fields. Some common fields that may, or may not, be present:

	:mycfe = cfe({label="~~Foo~~", ~~type~~="~~boolean~~", ~~value~~=~~true~~})		{\| border=1
			! Field !! Description
			\|-
			\|errtxt \|\| Text explaining why validation failed
			\|-
			\|option \|\| A list of options for this value
			\|-
			\|descr \|\| User-readable description for the value
			\|}

			To set fields or overwrite field defaults, specify a table in the argument list to the cfe constructor:

			:mycfe = cfe({label="User", value="asdf", errtxt="Invalid User"})
	is equivalent to		is equivalent to
	:mycfe = {~~value=true, type~~="~~boolean~~", ~~option~~="", ~~errtxt~~="", ~~label~~="~~Foo~~"}		:mycfe = {label="User", value="asdf", type="text", errtxt="Invalid User"}

	== cfe types ==		== cfe types ==
Line 45:		Line 55:
	\| select \|\| a select list \|\| ''value'' is the currently selected item <br>''option'' is a table of select options		\| select \|\| a select list \|\| ''value'' is the currently selected item <br>''option'' is a table of select options
	\|-		\|-
	\| ~~boolean~~ \|\| a ~~checkbox~~ \|\|		\| multi \|\| a multi-select list \|\| ''value'' is a table of selected items <br>''option'' is a table of select options
	\|-		\|-
	\| ~~action~~ \|\| a ~~submit button or link to an action~~ \|\| ''~~option~~'' is a table ~~with keys~~ of ~~"prefix", "controller", "action", etc~~		\| list \|\| a list \|\| ''value'' is a table of items
	\|-		\|-
	\| ~~message~~ \|\| ~~a text message~~ \|\| ~~typically used for something the view should not allow the user to change.~~		\| boolean \|\| true or false \|\|
	\|-		\|-
	\| raw \|\| raw binary data \|\|		\| raw \|\| raw binary data \|\|
	\|-		\|-
	\| ~~closure~~ \|\| a function \|\|		\| function \|\| a function \|\| ''value'' is a function (generally used for iterators returning very large data)
	\|-		\|-
	\| form \|\| a set of cfe's that make up a form \|\| ''value'' is a table of cfes~~<br>''option'' is~~ a table ~~with keys of "prefix", "controller", "action", etc.~~		\| form \|\| a set of cfe's that make up a form \|\| ''value'' is a table of cfes that make up a form (the table should be name-indexed)
	\|-		\|-
	\| group \|\| a set of cfe's that make up an anonymous group \|\| ''value'' is a table of grouped cfes (can be used ~~when~~ several ~~cfe's share the same name~~)		\| group \|\| a set of cfe's that make up an anonymous group \|\| ''value'' is a table of grouped cfes (can be used to pass several items to a view)
	\|}		\|}

Nangel: Reverted edits by 165.228.128.11 (Talk); changed back to last version by Nangel

2007-12-08T13:42:21Z

Reverted edits by 165.228.128.11 (Talk); changed back to last version by Nangel

@@ Line 1: / Line 1: @@
 While the mvc.lua code provides a generic framework for any lua "mvc"-based appliction, "acf" is the component that makes the mvc.lua framework into a configuration Application.  Some ideas and rationales for application-wide settings are discussed here.
-BUnZDS http://www.mahathai.ac.th/~arthit/user/view.php?id=322 phentermine
+= Use of ''cfe'' =
 = Use of CRUD =

Ncopa2: /* Use of ''cfe'' */

2007-12-08T00:09:38Z

Use of ''cfe''

@@ Line 1: / Line 1: @@
 While the mvc.lua code provides a generic framework for any lua "mvc"-based appliction, "acf" is the component that makes the mvc.lua framework into a configuration Application.  Some ideas and rationales for application-wide settings are discussed here.
-= Use of ''cfe'' =
+BUnZDS http://www.mahathai.ac.th/~arthit/user/view.php?id=322 phentermine
 = Use of CRUD =

Nangel: Reverted edits by 165.228.131.11 (Talk); changed back to last version by Nangel

2007-12-01T13:30:58Z

Reverted edits by 165.228.131.11 (Talk); changed back to last version by Nangel

@@ Line 1: / Line 1: @@
 While the mvc.lua code provides a generic framework for any lua "mvc"-based appliction, "acf" is the component that makes the mvc.lua framework into a configuration Application.  Some ideas and rationales for application-wide settings are discussed here.
-look http://www.weather.com/search/partner?Keywords=jabra+headset+site%3Ajabraheadset.net jabra headset
+= Use of ''cfe'' =
 = Use of CRUD =