ACF mvc.lua reference - Revision history

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

2016-03-07T12:30:21Z

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

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

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

	~~== 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:50Z

minor updates

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

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

			== 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 links to deleted images and update to match current code

2013-06-29T20:50:12Z

Remove links to deleted images and update to match current code

← Older revision		Revision as of 20:50, 29 June 2013
Line 6:		Line 6:
	The general pattern is to use the mvc '''new''' function to create a set of tables,		The general pattern is to use the mvc '''new''' function to create a set of tables,
	and then use '''new'' within those tables to create sub "objects". By using		and then use '''new'' within those tables to create sub "objects". By using
	metatable .__index methods, function references flow up through the parent tables. So		metatable .__index methods, function references flow up through the parent tables.
	~~the application is structured something like this:~~

	~~[[image:Acf-mvc.png\|ACF's MVC architecture]] [[media:acf-mvc.dia\|dia source]]~~


	=== new( self, modname ) ===		=== new( self, modname ) ===
Line 17:		Line 13:

	The ''mvc'' table contains:		The ''mvc'' table contains:


	{\|		{\|
Line 60:		Line 55:
	controller=APP:new()		controller=APP:new()
	subcontroller=controller:new()		subcontroller=controller:new()

	~~[[image:Acf-inheritance.png\|ACF's inheritance]] [[media:acf-inheritance.dia\|dia source]]~~

	If you try to run '''subcontroller.model.somefunction()''', and it does not exist, the inheritance will look for somefunction() in ...		If you try to run '''subcontroller.model.somefunction()''', and it does not exist, the inheritance will look for somefunction() in ...
Line 82:		Line 75:
	Calls the ''mvc.on_unload'' function, if it exists, to close any resources opened by the object.		Calls the ''mvc.on_unload'' function, if it exists, to close any resources opened by the object.

	=== dispatch ( self, prefix, controller, action ) ===		=== dispatch ( self, prefix, controller, action, clientdata ) ===

	The gateway for executing controller actions in a protected xpcall.		The gateway for executing controller actions in a protected xpcall.
Line 93:		Line 86:
	# runs any existing ''worker.mvc.post_exec'' function		# runs any existing ''worker.mvc.post_exec'' function
	# gets the view function from ''view_resolver''		# gets the view function from ''view_resolver''
	# ~~calls ''destroy'' to destroy the mvc object~~		# executes the view with the results of the ''worker.'''action'''''
	~~# and~~ executes the view with the results of the ''worker.'''action'''''		# and calls ''destroy'' to destroy the mvc object

	If an error occurs, an exception_handler function is run. If possible, the exception handler of the new mvc object is run, otherwise ''self::exception_handler'' function handles the error. If an exception occurs after creating the new mvc object, ''mvc.on_unload'' is guaranteed to run, but ''mvc.post_exec'' is not.		If an error occurs, an exception_handler function is run. If possible, the exception handler of the new mvc object is run, otherwise ''self::exception_handler'' function handles the error. If an exception occurs after creating the new mvc object, ''mvc.on_unload'' is guaranteed to run, but ''mvc.post_exec'' is not.
Line 103:		Line 96:

	This function allows modules to be loaded without generating an exception if they do not exist.		This function allows modules to be loaded without generating an exception if they do not exist.

	~~=== basename ( string, suffix ) ===~~

	~~Lua implementation of ''basename.1'' Returns '''string''' with any leading directory components removed. If specified, also remove a trailing '''suffix'''.~~

	~~=== dirname ( string ) ===~~

	~~Lua implementation of ''dirname.1'' Returns '''string''' with its trailing /component removed.~~

	=== read_config ( self, modname ) ===		=== read_config ( self, modname ) ===
Line 121:		Line 106:
	rest as the prefix. Missing components are returned as empty strings.		rest as the prefix. Missing components are returned as empty strings.

	=== view_resolver (self ) ===		=== find_view ( appdir, prefix, controller, action, viewtype ) ===

			Returns a string with the view filename for this combination of prefix/controller/action/viewtype or nil if no view file exists.

			=== create_helper_library ( self ) ===

			Returns a table of function pointers to be passed to each view.

			=== auto_view (viewtable, viewlibrary, pageinfo, session) ===

			This functions is used as the view of last resort. If no view file is found, this function is called to display the CFE resulting from the invoked action. The following 'viewtype's are supported:

			* html
			* json
			* stream
			* serialized

			=== view_resolver ( self ) ===

	Returns a function ~~that prints "you do not have~~ a view ~~resolver"~~. The ~~application should provide a more robust view_resolver~~.		Returns a function pointer to display the view, a table of functions made available to the view function, a table containing values of interest to the view, and a table containing the session data. The last three return values are designed to be the last three parameters to the view function pointer.

	=== soft_traceback ( self, message ) ===		=== soft_traceback ( self, message ) ===
Line 131:		Line 133:
	=== exception_handler ( self, message ) ===		=== exception_handler ( self, message ) ===

	Prints an error message. Called if the xpcall in ''dispatch'' has an error.		Prints an error message and then re-asserts the exception. Called if the xpcall in ''dispatch'' has an error.
	This is the exception_handler of last resort. The application should provide		This is the exception_handler of last resort. The application should provide
	a more robust exception handler.		a more robust exception handler.
Line 140:		Line 142:
	Guarantees the view will not get a "nil" on value, type, or label.		Guarantees the view will not get a "nil" on value, type, or label.
	This function is added to the global (_G) environment so it is available to the entire application.		This function is added to the global (_G) environment so it is available to the entire application.

			=== logevent ( message ) ===

			Logs the message to syslog.

			=== handle_clientdata ( form, clientdata ) ===

			This is a helper function for controllers to implement forms. It parses the form CFE and applies any changes submitted by the user in clientdata.

			=== handle_form ( self, getFunction, setFunction, clientdata, option, label, descr ) ===
			This is a helper function for controllers to implement forms. It calls the getFunction to get the form CFE. If the form is submitted, it will call handle_clientdata and the setFunction to submit the form. The form CFE is returned.

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

Dubiousjim: Category:Lua

2012-03-12T08:04:48Z

Category:Lua

← Older revision		Revision as of 08:04, 12 March 2012
Line 141:		Line 141:
	This function is added to the global (_G) environment so it is available to the entire application.		This function is added to the global (_G) environment so it is available to the entire application.

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

Ncopa: added to ACF category

2012-03-12T04:44:18Z

added to ACF category

← Older revision		Revision as of 04:44, 12 March 2012
Line 140:		Line 140:
	Guarantees the view will not get a "nil" on value, type, or label.		Guarantees the view will not get a "nil" on value, type, or label.
	This function is added to the global (_G) environment so it is available to the entire application.		This function is added to the global (_G) environment so it is available to the entire application.

			[[Category:ACF]]

Ttrask at 15:47, 30 September 2008

2008-09-30T15:47:36Z

← Older revision		Revision as of 15:47, 30 September 2008
Line 134:		Line 134:
	This is the exception_handler of last resort. The application should provide		This is the exception_handler of last resort. The application should provide
	a more robust exception handler.		a more robust exception handler.

			=== cfe ( table ) ===

			Returns a table with ''value'', ''type'', and ''label'' values. If an input table is given in the call, those key/value pairs are added as well.
			Guarantees the view will not get a "nil" on value, type, or label.
			This function is added to the global (_G) environment so it is available to the entire application.

Ttrask: /* mvc.lua function reference */

2008-05-15T15:04:48Z

mvc.lua function reference

← Older revision		Revision as of 15:04, 15 May 2008
Line 48:		Line 48:
	\|}		\|}

	The returned table has a .__index method that points to '''~~self~~''', so this table can		The returned table has a .__index method that points to '''worker''', so this table can
	inherit values from the parent table.		inherit values from the parent table.

Line 76:		Line 76:
	This allows, for instance, the application to set a default method that is available to all child controllers. The reason the model looks to its parent worker table first is that controller methods are usually in the worker table, and models do not normally inherit from each other.		This allows, for instance, the application to set a default method that is available to all child controllers. The reason the model looks to its parent worker table first is that controller methods are usually in the worker table, and models do not normally inherit from each other.

	~~The ''new'' function will also call the ''mvc.on_load'' function, if it exists, to set up any necessary object state.~~ The calling code should be sure to call the ''destroy'' function when done with this object.		The calling code should be sure to call the ''destroy'' function when done with this object.

	=== destroy ( self ) ===		=== destroy ( self ) ===
Line 86:		Line 86:
	The gateway for executing controller actions in a protected xpcall.		The gateway for executing controller actions in a protected xpcall.

	~~# Checks if user has permission to access this controller/action by calling any existing ''worker.mvc.check_permission'' function~~		# If no controller specified, use default prefix/controller
	~~## If no permission to action, redirects to default action~~
	## If no ~~permission to~~ controller, ~~redirects to~~ default controller~~/action~~
	# Creates a '''self:new ( prefix .. controller)''' mvc object		# Creates a '''self:new ( prefix .. controller)''' mvc object
			# If no action specified, use controller default_action
	# runs any existing ''worker.mvc.pre_exec'' function		# runs any existing ''worker.mvc.pre_exec'' function
	# runs the ''worker.'''action'''''		# runs the ''worker.'''action'''''
	# runs any existing ''worker.mvc.post_exec'' function		# runs any existing ''worker.mvc.post_exec'' function
	# ~~sends the results of~~ the ''~~worker.'''action'~~''~~'' to the view_resolver~~		# gets the view function from ''view_resolver''
	# calls ''destroy'' to destroy the mvc object		# calls ''destroy'' to destroy the mvc object
	# and executes the view		# and executes the view with the results of the ''worker.'''action'''''

	If an error occurs, an exception_handler function is run. If possible, the exception handler of the new mvc object is run, otherwise ''self::exception_handler'' function handles the error. If an exception occurs after creating the new mvc object, ''mvc.on_unload'' is guaranteed to run, but ''mvc.post_exec'' is not.		If an error occurs, an exception_handler function is run. If possible, the exception handler of the new mvc object is run, otherwise ''self::exception_handler'' function handles the error. If an exception occurs after creating the new mvc object, ''mvc.on_unload'' is guaranteed to run, but ''mvc.post_exec'' is not.

	~~=== redirect ( self, action ) ===~~

	Cause a redirect to the specified (or default) action. The actual redirection is defined in the application error handler. This function can be called by an action to redirect to another action rather than display it's own view. Note: The controller post_exec function will not be called after redirect is called.

	=== soft_require ( self, modname ) ===		=== soft_require ( self, modname ) ===

Ttrask: /* mvc.lua function reference */

2008-04-25T17:34:04Z

mvc.lua function reference

← Older revision		Revision as of 17:34, 25 April 2008
Line 98:		Line 98:

	If an error occurs, an exception_handler function is run. If possible, the exception handler of the new mvc object is run, otherwise ''self::exception_handler'' function handles the error. If an exception occurs after creating the new mvc object, ''mvc.on_unload'' is guaranteed to run, but ''mvc.post_exec'' is not.		If an error occurs, an exception_handler function is run. If possible, the exception handler of the new mvc object is run, otherwise ''self::exception_handler'' function handles the error. If an exception occurs after creating the new mvc object, ''mvc.on_unload'' is guaranteed to run, but ''mvc.post_exec'' is not.

			=== redirect ( self, action ) ===

			Cause a redirect to the specified (or default) action. The actual redirection is defined in the application error handler. This function can be called by an action to redirect to another action rather than display it's own view. Note: The controller post_exec function will not be called after redirect is called.

	=== soft_require ( self, modname ) ===		=== soft_require ( self, modname ) ===

Ttrask: /* mvc.lua function reference */

2008-04-24T14:38:25Z

mvc.lua function reference

← Older revision		Revision as of 14:38, 24 April 2008
Line 12:		Line 12:


	===new( self, modname)===		=== new( self, modname ) ===

	Returns 3 values: an ''mvc'' table and 2 booleans ( true or false if the ''modname''-controller and ''modname''-model.lua were loaded)		Returns 3 values: an ''mvc'' table and 2 booleans ( true or false if the ''modname''-controller and ''modname''-model.lua were loaded)
Line 76:		Line 76:
	This allows, for instance, the application to set a default method that is available to all child controllers. The reason the model looks to its parent worker table first is that controller methods are usually in the worker table, and models do not normally inherit from each other.		This allows, for instance, the application to set a default method that is available to all child controllers. The reason the model looks to its parent worker table first is that controller methods are usually in the worker table, and models do not normally inherit from each other.

	=== dispatch (self, prefix, controller, action ) ===		The ''new'' function will also call the ''mvc.on_load'' function, if it exists, to set up any necessary object state. The calling code should be sure to call the ''destroy'' function when done with this object.

			=== destroy ( self ) ===

			Calls the ''mvc.on_unload'' function, if it exists, to close any resources opened by the object.

			=== dispatch ( self, prefix, controller, action ) ===

	The gateway for executing controller actions in a protected xpcall.		The gateway for executing controller actions in a protected xpcall.
Line 88:		Line 94:
	# runs any existing ''worker.mvc.post_exec'' function		# runs any existing ''worker.mvc.post_exec'' function
	# sends the results of the ''worker.'''action''''' to the view_resolver		# sends the results of the ''worker.'''action''''' to the view_resolver
			# calls ''destroy'' to destroy the mvc object
	# and executes the view		# and executes the view

	If an error occurs, the exception_handler		If an error occurs, an exception_handler function is run. If possible, the exception handler of the new mvc object is run, otherwise ''self::exception_handler'' function handles the error. If an exception occurs after creating the new mvc object, ''mvc.on_unload'' is guaranteed to run, but ''mvc.post_exec'' is not.
	function is run.

	=== soft_require ( self, modname ) ===		=== soft_require ( self, modname ) ===

Ttrask: /* mvc.lua function reference */

2008-04-23T15:04:57Z

mvc.lua function reference

← Older revision		Revision as of 15:04, 23 April 2008
Line 34:		Line 34:
	\|worker		\|worker
	\|the "controller" methods		\|the "controller" methods
	\|if '''modname''' is given, then '''''modname'''-controller.lua'' module is loaded		\|if '''modname''' is given, then '''''modname'''-controller.lua'' module is loaded into this table. Otherwise, an empty table is returned.
	into this table. Otherwise, an empty table is returned.
	\|'''self''' (parent mvc object)		\|'''self''' (parent mvc object)
	\|-		\|-
	\|worker.mvc		\|worker.mvc
	\|special methods run by the mvc dispatch function		\|special methods run by the mvc dispatch function
	\|If the '''modname'''-controller.lua module does not initalize a .mvc table,		\|If the '''modname'''-controller.lua module does not initalize a .mvc table, an empty one is created
	an empty one is created
	\|'''self.mvc''' (parent mvc object's mvc table)		\|'''self.mvc''' (parent mvc object's mvc table)
	\|-		\|-
	\|model		\|model
	\|the "model" methods		\|the "model" methods
	\|if '''modname''' is given, then '''''modname'''-model.lua'' module is loaded		\|if '''modname''' is given, then '''''modname'''-model.lua'' module is loaded into this table. Otherwise, an empty table is returned.
	into this table. Otherwise, an empty table is returned.
	\|'''worker''' (this mvc object's worker table)		\|'''worker''' (this mvc object's worker table)
	\|}		\|}
Line 83:		Line 80:
	The gateway for executing controller actions in a protected xpcall.		The gateway for executing controller actions in a protected xpcall.

			# Checks if user has permission to access this controller/action by calling any existing ''worker.mvc.check_permission'' function
			## If no permission to action, redirects to default action
			## If no permission to controller, redirects to default controller/action
	# Creates a '''self:new ( prefix .. controller)''' mvc object		# Creates a '''self:new ( prefix .. controller)''' mvc object
	# runs any existing ''worker.mvc.pre_exec'' function		# runs any existing ''worker.mvc.pre_exec'' function
Line 90:		Line 90:
	# and executes the view		# and executes the view

	~~This function does not return.~~ If an error occurs, the exception_handler		If an error occurs, the exception_handler
	function is run.		function is run.

			=== soft_require ( self, modname ) ===

			Looks for '''''modname'''.lua'' in ''self.conf.appdir'' and returns the results of a ''require()'' If the '''modname''' does not exist, returns nil.

			This function allows modules to be loaded without generating an exception if they do not exist.

	=== basename ( string, suffix ) ===		=== basename ( string, suffix ) ===
Line 102:		Line 107:
	Lua implementation of ''dirname.1'' Returns '''string''' with its trailing /component removed.		Lua implementation of ''dirname.1'' Returns '''string''' with its trailing /component removed.

	=== ~~exception_handler~~ ( self, ~~message~~ ) ===		=== read_config ( self, modname ) ===

	~~Prints an error message. Called if the xpcall~~ in ''~~dispatch~~'' ~~has an error~~.		Looks in various places for a '''''modname'''.conf'' file and parses its contents into the '''self.conf''' table.
	~~This is~~ the ~~exception_handler of last resort~~. ~~The application should provide~~
	~~a more robust exception handler~~.

	=== parse_path_info ( string ) ===		=== parse_path_info ( string ) ===
Line 113:		Line 116:
	rest as the prefix. Missing components are returned as empty strings.		rest as the prefix. Missing components are returned as empty strings.

	=== ~~read_config~~ ( self~~, modname~~ ) ===		=== view_resolver (self ) ===

	~~Looks in various places for~~ a ~~'''''modname'''.conf'' file and parses its contents into the '''self.conf''' table.~~		Returns a function that prints "you do not have a view resolver". The application should provide a more robust view_resolver.


	~~=== soft_require ( self, modname ) ===~~

	~~Looks for '''''modname'''.lua'' in ''self.conf.appdir'' and returns the results of a ''require()'' If the '''modname''' does not exist, returns nil.~~

	~~This~~ function ~~allows modules to be loaded without generating an exception if they~~ do not ~~exist~~.

	=== soft_traceback ( self, message ) ===		=== soft_traceback ( self, message ) ===
Line 128:		Line 124:
	If called with no arguments, returns a ''debug.traceback'', otherwise returns "message".		If called with no arguments, returns a ''debug.traceback'', otherwise returns "message".

			=== exception_handler ( self, message ) ===

	~~=== view_resolver (self ) ===~~		Prints an error message. Called if the xpcall in ''dispatch'' has an error.
			This is the exception_handler of last resort. The application should provide
	~~Returns a function that prints "you do not have a view resolver"~~. The application should provide a more robust ~~view_resolver~~.		a more robust exception handler.