Ferreteria/v0.6/fx: Difference between revisions

Revision as of 17:36, 18 November 2025

Ferreteria v0.6: functions

key methods (class functions)

fx() name	attribs	description/notes
`ActionClass()`	protected	sets the CommOp class for `DoCommand()` to return
`Describe()`
`DescribeInline()`
`DoCommand()`
`DoExport()`
`DoImport()`
`FromParams()`	static
`FromItemPiece()`	static
`GetFTags()`
`GetQObj(int\|string $snKey) : QVarIface`	protected	retrieve-by-key an element from an array, wrapped in a QVar
`GetSchema(string $sName) : Schema`	public	retrieves an object for the given Schema from the current DB Connection
`GetVals()`
`Go()`		used as a kind of primary entry-point on objects that do specific actions
`HowItWent()`		returns an object's ItWent action-status object
`NameOfInput()`
`ODbConn()`		retrieve the applicable database connection object
`Open()`		open a connection (opposite: `Shut()`)
`OpenProcess()`		open/create/start a process (returns an object which controls the process; there is no `ShutProcess()</code).`
`ParseInputArgs()`
`ParseInputString()`
`PromptForMethod()`		code-annotation method provided by Helper
`QDbConnSlug()`		retrieves the Database Connection shortname (slug) if available; always returns a QStr object.
`QVarClass(int\|string $snKey) : string`	protected	configures the QVar class to use for creating new elements in a QStor array-object
`ReadInput()`	public	read & interpret any user input (CLI or web) which came with the startup request
`SaveAsEngConnName()`
`Shut()`		closes an open connection (opposite: `Open()`)
`WithItemPiece()`	protected

@@ Line 19: / Line 19: @@
 {{!-!}} <code>{{l/ver/fx|ODbConn}}()</code> || || retrieve the applicable database connection object
 {{!-!}} <code>{{l/ver/fx|Open}}()</code> || || open a connection (opposite: <code>{{l/ver/fx|Shut}}()</code>)
-{{!-!}} <code>{{l/ver/fx|OpenProcess}}()</code> || || open/start a process
+{{!-!}} <code>{{l/ver/fx|OpenProcess}}()</code> || || open/create/start a process (returns an object which controls the process; there is no <code>ShutProcess()</code).
 {{!-!}} <code>{{l/ver/fx|ParseInputArgs}}()</code>
 {{!-!}} <code>{{l/ver/fx|ParseInputString}}()</code>
@@ Line 25: / Line 25: @@
 {{!-!}} <code>{{l/ver/fx|QDbConnSlug}}()</code> || || retrieves the Database Connection shortname ([[slug]]) if available; always returns a Q{{l/ver/clade|Ferret\Data\Mem\QVar|Str}} object.
 {{!-!}} <code>{{l/ver/fx|QVarClass}}(int{{!}}string $snKey) : string</code> || protected || configures the QVar class to use for creating new elements in a {{l/ver/clade|Sys\Data\Things\Array|QStor}} array-object
-{{!-!}} <code>{{l/ver/fx|ReadInput}}()</code> || read & interpret user input (CLI or web)
+{{!-!}} <code>{{l/ver/fx|ReadInput}}()</code> || public || read & interpret any user input (CLI or web) which came with the startup request
 {{!-!}} <code>{{l/ver/fx|SaveAsEngConnName}}()</code>
 {{!-!}} <code>{{l/ver/fx|Shut}}()</code> || || closes an open connection (opposite: <code>{{l/ver/fx|Open}}()</code>)