Ferreteria/v0.6/fx: Difference between revisions

Revision as of 02:03, 31 October 2025

Ferreteria v0.6: functions

key functions & methods

fx() name/definition	attribs	description/notes
`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()`		retrieves the applicable database connection object
`Open()`		opens a connection (opposite: `Shut()`)
`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
`SaveAsEngSchemaName()`
`Shut()`		closes an open connection (opposite: `Open()`)
`WithItemValue()`	protected

@@ Line 17: / Line 17: @@
 {{!-!}} <code>{{l/ver/fx|NameOfInput}}()</code>
 {{!-!}} <code>{{l/ver/fx|ODbConn}}()</code> || || retrieves the applicable database connection object
+{{!-!}} <code>{{l/ver/fx|Open}}()</code> || || opens a connection (opposite: <code>{{l/ver/fx|Shut}}()</code>)
 {{!-!}} <code>{{l/ver/fx|ParseInputArgs}}()</code>
 {{!-!}} <code>{{l/ver/fx|ParseInputString}}()</code>
@@ Line 23: / Line 24: @@
 {{!-!}} <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|SaveAsEngSchemaName}}()</code>
+{{!-!}} <code>{{l/ver/fx|Shut}}()</code> || || closes an open connection (opposite: <code>{{l/ver/fx|Open}}()</code>)
 {{!-!}} <code>{{l/ver/fx|WithItemValue}}()</code> || protected
 |}