Developer Manual - Revision history

Mike at 16:40, 21 October 2016

2016-10-21T16:40:23Z

2015-03-13T16:49:40Z

‎API Documentation

2014-04-09T15:20:50Z

‎API Documentation

2013-12-03T14:44:34Z

‎API Documentation

2013-12-03T14:30:32Z

‎API Documentation

2013-11-20T16:53:47Z

‎API Documentation

2013-11-15T16:12:55Z

‎API Documentation

2013-11-15T15:16:28Z

‎API Documentation

2013-11-14T16:37:24Z

‎API Documentation

2013-11-12T14:56:12Z

‎API Documentation

@@ Line 3: / Line 3: @@
 If you don't know why you are reading this documentation, you are probably looking in the wrong part of the manual. For information on installation and administration see the [[Administrator Manual| administrator]] section of the manual.
-Work to create developer documentation including migration of old documentation (Ticket #122) is ongoing (as of 11th Feb 2009) but in the meantime please contact a member of the [http://ark.lparchaeology.com/contact ARK Development Team] if you can't find what you are looking for within these pages.
+Work to create developer documentation including migration of old documentation (Ticket #122) is ongoing (as of 21st Oct 2016) but in the meantime please contact a member of the [http://ark.lparchaeology.com/contact ARK Development Team] if you can't find what you are looking for within these pages.
 ===Background Reading===

← Older revision		Revision as of 16:49, 13 March 2015
Line 87:		Line 87:

	[[getFields]] - this returns an array of the fields attached to an item with their values		[[getFields]] - this returns an array of the fields attached to an item with their values
		+
		+	[[getConcepts]] - this is a wrapper page which retrieves the definition of a particular concept

	[[transcludeFilter]] - this returns a fully rendered HTML representation of a filter result		[[transcludeFilter]] - this returns a fully rendered HTML representation of a filter result

← Older revision		Revision as of 15:20, 9 April 2014
Line 67:		Line 67:

	The following methods can be used:		The following methods can be used:
		+
		+	[[describeARK]] - this provides some simple metadata about the ARK instance

	[[describeItems]] - this provides a list of all the types of modules available		[[describeItems]] - this provides a list of all the types of modules available

← Older revision		Revision as of 14:44, 3 December 2013
Line 89:		Line 89:

	[[transcludeSubform]] - this returns a fully rendered HTML representation of a subform		[[transcludeSubform]] - this returns a fully rendered HTML representation of a subform
		+
		+	[[putField]] - this is for putting values to an ARK. Use this for adding, editing or deleting fields

	[[XMLParser]] - this is mainly used internally by the spatial elements of ARK to retrieve and present GML data		[[XMLParser]] - this is mainly used internally by the spatial elements of ARK to retrieve and present GML data

← Older revision		Revision as of 14:30, 3 December 2013
Line 87:		Line 87:

	[[transcludeFilter]] - this returns a fully rendered HTML representation of a filter result		[[transcludeFilter]] - this returns a fully rendered HTML representation of a filter result
		+
		+	[[transcludeSubform]] - this returns a fully rendered HTML representation of a subform

	[[XMLParser]] - this is mainly used internally by the spatial elements of ARK to retrieve and present GML data		[[XMLParser]] - this is mainly used internally by the spatial elements of ARK to retrieve and present GML data

@@ Line 75: / Line 75: @@
 [[describeSubforms]] - this provides a list of available subforms (for transclusion)
 [[getItems]] - this returns an array of items of a specified module
@@ Line 81: / Line 83: @@
 [[getFilter]] - this returns the result of a saved filter or a free-text search
 [[transcludeFilter]] - this returns a fully rendered HTML representation of a filter result

← Older revision		Revision as of 16:12, 15 November 2013
Line 73:		Line 73:

	[[describeFilters]] - this provides a list of all available filters		[[describeFilters]] - this provides a list of all available filters
		+
		+	[[describeSubforms]] - this provides a list of available subforms (for transclusion)

	[[getItems]] - this returns an array of items of a specified module		[[getItems]] - this returns an array of items of a specified module

← Older revision		Revision as of 15:16, 15 November 2013
Line 71:		Line 71:

	[[describeFrags]] - this provides a list of all the different types of data available within the ARK instance (it lists the different 'types' of dataclass available		[[describeFrags]] - this provides a list of all the different types of data available within the ARK instance (it lists the different 'types' of dataclass available
		+
		+	[[describeFilters]] - this provides a list of all available filters

	[[getItems]] - this returns an array of items of a specified module		[[getItems]] - this returns an array of items of a specified module

← Older revision		Revision as of 16:37, 14 November 2013
Line 77:		Line 77:

	[[getFilter]] - this returns the result of a saved filter or a free-text search		[[getFilter]] - this returns the result of a saved filter or a free-text search
		+
		+	[[transcludeFilter]] - this returns a fully rendered HTML representation of a filter result

	[[XMLParser]] - this is mainly used internally by the spatial elements of ARK to retrieve and present GML data		[[XMLParser]] - this is mainly used internally by the spatial elements of ARK to retrieve and present GML data

← Older revision		Revision as of 14:56, 12 November 2013
Line 75:		Line 75:

	[[getFrags]] - this returns an array of data frags attached to a specified item		[[getFrags]] - this returns an array of data frags attached to a specified item
		+
		+	[[getFilter]] - this returns the result of a saved filter or a free-text search

	[[XMLParser]] - this is mainly used internally by the spatial elements of ARK to retrieve and present GML data		[[XMLParser]] - this is mainly used internally by the spatial elements of ARK to retrieve and present GML data