DevOps:Doc/FlexForm/2.0/edit/json - Revision history

Fd4138e7-8b46-4c8f-99bf-d4b738ebc295: Text replacement - "|Subject version=2.0,2.1" to "|Subject version=2.0,2.1,2.5"

2025-08-21T09:06:20Z

Text replacement - "|Subject version=2.0,2.1" to "|Subject version=2.0,2.1,2.5"

ws-class-props
← Older revision		Revision as of 11:06, 21 August 2025
Line 1:		Line 1:
	{{Csp class properties		{{Csp class properties
	\|Subject version=2.0,2.1		\|Subject version=2.0,2.1,2.5
	\|Doc subject=DevOps:Doc/FlexForm		\|Doc subject=DevOps:Doc/FlexForm
	\|Doc parent=DevOps:Doc/FlexForm/1.0/edit		\|Doc parent=DevOps:Doc/FlexForm/1.0/edit

Maintenance script: Imported by PageSync

2025-07-15T08:33:27Z

Imported by PageSync

ws-class-props
← Older revision		Revision as of 10:33, 15 July 2025
Line 1:		Line 1:
	{{~~Doc~~ properties		{{Csp class properties
	\|Subject version=2.0,2.1		\|Subject version=2.0,2.1
	\|Doc subject=DevOps:Doc/FlexForm		\|Doc subject=DevOps:Doc/FlexForm

944f869b-8467-464e-95c7-903362952755: corrected mwformat --> format; made clear that template is mandatory

2024-12-30T13:49:47Z

corrected mwformat --> format; made clear that template is mandatory

← Older revision		Revision as of 15:49, 30 December 2024
Line 15:		Line 15:
	'''target''' = Target page ( title or page id ) that needs to be edited		'''target''' = Target page ( title or page id ) that needs to be edited

	'''~~mwformat~~''' = "json". Tell an edit that we are working with JSON		'''format''' = "json". Tell an edit that we are working with JSON

	'''template ''' = This argument has been kept to keep editing a template wiki page and editing a JSON page similar to each other.		'''template ''' = Mandatory if format=json. This argument has been kept to keep editing a template wiki page and editing a JSON page similar to each other.
	Name of the template differs from editing template content and now has two options : json and jsonk.		Name of the template differs from editing template content and now has two options : json and jsonk.

Charlot: User:Charlot

2023-03-31T20:12:49Z

User:Charlot

ws-class-props
← Older revision		Revision as of 22:12, 31 March 2023
Line 1:		Line 1:
	{{Doc properties		{{Doc properties
	\|Subject version=2.0		\|Subject version=2.0,2.1
	\|Doc subject=DevOps:Doc/FlexForm		\|Doc subject=DevOps:Doc/FlexForm
	\|Doc parent=DevOps:Doc/FlexForm/1.0/edit		\|Doc parent=DevOps:Doc/FlexForm/1.0/edit

Charlot at 20:23, 2 January 2023

2023-01-02T20:23:19Z

← Older revision		Revision as of 22:23, 2 January 2023
Line 19:		Line 19:
	'''template ''' = This argument has been kept to keep editing a template wiki page and editing a JSON page similar to each other.		'''template ''' = This argument has been kept to keep editing a template wiki page and editing a JSON page similar to each other.
	Name of the template differs from editing template content and now has two options : json and jsonk.		Name of the template differs from editing template content and now has two options : json and jsonk.
	*'''json''' : When you create a JSON page with _create, every new named array will also get a unique id, called '''ffID'''. The following example ~~tell~~ FlexForm to find a certain ffID and then find a named value ( so the key ) called Title. FlexForm will then check if the submitted form has an input with the same name the "Title" and use it's value to add to the JSON.
			*'''json''' : When you create a JSON page with _create, every new named array will also get a unique id, called '''ffID'''. The following example tells FlexForm to find a certain ffID and then find a named value ( so the key ) called Title. FlexForm will then check if the submitted form has an input with the same name the "Title" and use it's value to add to the JSON.

	Example JSON:		Example JSON:
Line 57:		Line 58:
	</syntaxhighlight>		</syntaxhighlight>
	This will change the first Color array value into the value of the form field Title.		This will change the first Color array value into the value of the form field Title.

	'''formfield''' = Name of the key in the JSON. When using template type json, then the formfield in the form should have the same name		'''formfield''' = Name of the key in the JSON. When using template type json, then the formfield in the form should have the same name

Charlot at 19:34, 22 December 2022

2022-12-22T19:34:39Z

← Older revision		Revision as of 21:34, 22 December 2022
Line 44:		Line 44:
	</syntaxhighlight>		</syntaxhighlight>

	*'''jsonk''' : This option lets you traverse down a JSON manually using the JSONPath (xpath for JSON). You tell FlexForm exactly what part of the JSON you want to edit and what value of a form input field to use. The following example uses the same JSON example from above and we tell FlexForm to go to '''Coats->Title''', then take the form input of type '''Title''' and put that value in the JSON.		*'''jsonk''' : This option lets you traverse down a JSON manually using the JSONPath (xpath for JSON). You tell FlexForm exactly what part of the JSON you want to edit and what value of a form input field to use. You can use the full root path method ( $. ) or leave it out for convenience and FlexForm will add it automatically. The following example uses the same JSON example from above and we tell FlexForm to go to '''Coats->Title''', then take the form input of type '''Title''' and put that value in the JSON.
	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
	<_edit target="Json_test_result" format="json" template="jsonk\|Coats.Title" formfield="Title" />		<_edit target="Json_test_result" format="json" template="jsonk\|Coats.Title" formfield="Title" />

Charlot at 19:32, 22 December 2022

2022-12-22T19:32:00Z

← Older revision		Revision as of 21:32, 22 December 2022
Line 4:		Line 4:
	_edit		_edit
	===Synopsis===		===Synopsis===
	~~'''Introduced in FlexForm version 1.1.43'''.~~ Using a form to edit pages that have content with JSON.		Using a form to edit pages that have content with JSON.
	===Description===		===Description===
	How to edit JSON content pages in the wiki with FlexForm.		How to edit JSON content pages in the wiki with FlexForm.
Line 44:		Line 44:
	</syntaxhighlight>		</syntaxhighlight>

	*'''jsonk''' : This option lets you traverse down a JSON manually. You tell FlexForm exactly what part of the JSON you want to edit and what value of a form input field to use. The following example uses the same JSON example from above and we tell FlexForm to go to '''Coats->Title''', then take the form input of type '''Title''' and put that value in the JSON.		*'''jsonk''' : This option lets you traverse down a JSON manually using the JSONPath (xpath for JSON). You tell FlexForm exactly what part of the JSON you want to edit and what value of a form input field to use. The following example uses the same JSON example from above and we tell FlexForm to go to '''Coats->Title''', then take the form input of type '''Title''' and put that value in the JSON.
	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
	<_edit target="Json_test_result" format="json" template="jsonk\|Coats.Title" formfield="Title" />		<_edit target="Json_test_result" format="json" template="jsonk\|Coats.Title" formfield="Title" />
Line 54:		Line 54:
	You can even traverse into unnamed values like so :		You can even traverse into unnamed values like so :
	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
	<_edit target="Json_test_result" format="json" template="jsonk\|Coats.Color.0" formfield="Title" />		<_edit target="Json_test_result" format="json" template="jsonk\|Coats.Color[0]" formfield="Title" />
	</syntaxhighlight>		</syntaxhighlight>
	This will change the first Color array value into the value of the form field Title.		This will change the first Color array value into the value of the form field Title.
Line 69:		Line 69:
	===Links===		===Links===
	https://www.mediawiki.org/wiki/Multi-Content_Revisions		https://www.mediawiki.org/wiki/Multi-Content_Revisions

			https://github.com/Galbar/JsonPath-PHP

Charlot: User:Charlot

2022-12-11T20:56:23Z

User:Charlot

ws-class-props
← Older revision		Revision as of 22:56, 11 December 2022
Line 5:		Line 5:
	\|Doc sort order=10		\|Doc sort order=10
	\|Doc target group=User		\|Doc target group=User
			\|Doc synopsis=Edit JSON content
	}}		}}

Charlot: Charlot moved page DevOps:Doc/FlexForm/2.0/json to DevOps:Doc/FlexForm/2.0/edit/json without leaving a redirect

2022-12-11T20:54:47Z

Charlot moved page DevOps:Doc/FlexForm/2.0/json to json without leaving a redirect

← Older revision	Revision as of 22:54, 11 December 2022
(No difference)

Charlot: User:Charlot

2022-12-11T20:54:13Z

User:Charlot

New page

===Name===
_edit JSON content
===Type===
_edit
===Synopsis===
'''Introduced in FlexForm version 1.1.43'''. Using a form to edit pages that have content with JSON.
===Description===
How to edit JSON content pages in the wiki with FlexForm.

The edit function is very similar to editing template content, we will brake down the differences here.

===Parameters===
'''_edit'''

'''target''' = Target page ( title or page id ) that needs to be edited

'''mwformat''' = "json". Tell an edit that we are working with JSON

'''template ''' = This argument has been kept to keep editing a template wiki page and editing a JSON page similar to each other.
Name of the template differs from editing template content and now has two options : json and jsonk.
*'''json''' : When you create a JSON page with _create, every new named array will also get a unique id, called '''ffID'''. The following example tell FlexForm to find a certain ffID and then find a named value ( so the key ) called Title. FlexForm will then check if the submitted form has an input with the same name the "Title" and use it's value to add to the JSON.

Example JSON:
<syntaxhighlight lang="php">
{
"Coats": {
"ffID": 1669192355,
"Title": "The Body protector",
"Type": "Bodywarmer",
"Color": [
"blue",
"pink"
]
}
}
</syntaxhighlight>
Example EDIT:
<syntaxhighlight lang="php">
<_edit target="Json_test_result" format="json" template="json|ffID=1669192355" formfield="Title" />
</syntaxhighlight>
If you do not have a ffID, but do have something else in the JSON that is always unique you can use those instead of a ffID. For example, if you know the '''Type:"Bodywamer"''' is unique in this JSON, you can edit the '''Title''' of the JSON this way :
<syntaxhighlight lang="php">
<_edit target="Json_test_result" format="json" template="json|Type=Bodywarmer" formfield="Title" />
</syntaxhighlight>

*'''jsonk''' : This option lets you traverse down a JSON manually. You tell FlexForm exactly what part of the JSON you want to edit and what value of a form input field to use. The following example uses the same JSON example from above and we tell FlexForm to go to '''Coats->Title''', then take the form input of type '''Title''' and put that value in the JSON.
<syntaxhighlight lang="php">
<_edit target="Json_test_result" format="json" template="jsonk|Coats.Title" formfield="Title" />
</syntaxhighlight>
You can also use a different input in your form to use as the new value
<syntaxhighlight lang="php">
<_edit target="Json_test_result" format="json" template="jsonk|Coats.Title" formfield="Alternative title" />
</syntaxhighlight>
You can even traverse into unnamed values like so :
<syntaxhighlight lang="php">
<_edit target="Json_test_result" format="json" template="jsonk|Coats.Color.0" formfield="Title" />
</syntaxhighlight>
This will change the first Color array value into the value of the form field Title.
'''formfield''' = Name of the key in the JSON. When using template type json, then the formfield in the form should have the same name

'''value''' = [optional] Don't read the value from the form field, but use this value explicitly

'''mwslot''' = [optional] Name of content slot to use. Defaults to main content slot

===Note===

* You can have multiple _edit's in a form all doing different tasks.
* If you omit value, then the value of the form will be used (so what a user has filled in).
===Links===
https://www.mediawiki.org/wiki/Multi-Content_Revisions