Ferreteria/v0.6/fx: Difference between revisions

From Woozle Writes Code
Jump to navigation Jump to search
No edit summary
No edit summary
Line 2: Line 2:
{| class="wikitable"
{| class="wikitable"
! fx() name || attribs || description/notes
! fx() name || attribs || description/notes
{{!-!}} <code>{{l/ver/fx|ActionClass}}()</code> || protected || sets the {{l/ver/clade|Sys/Events/ItWent|CommOp}} class for <code>{{l/ver/fx|DoCommand}}()</code> to return
{{!-!}} <code>{{l/ver/fx|ActionClass}}()</code> || protected || sets the <code>{{l/ver/clade|Sys/Events/ItWent|CommOp}}</code> class for <code>{{l/ver/fx|DoCommand}}()</code> to return
{{!-!}} <code>{{l/ver/fx|Dadex}}()</code>
{{!-!}} <code>{{l/ver/fx|Dadex}}()</code>
{{!-!}} <code>{{l/ver/fx|Describe}}()</code>
{{!-!}} <code>{{l/ver/fx|Describe}}()</code>
Line 12: Line 12:
{{!-!}} <code>{{l/ver/fx|FromItemPiece}}()</code> || static
{{!-!}} <code>{{l/ver/fx|FromItemPiece}}()</code> || static
{{!-!}} <code>{{l/ver/fx|GetFTags}}()</code>
{{!-!}} <code>{{l/ver/fx|GetFTags}}()</code>
{{!-!}} <code>{{l/ver/fx|GetQObj}}(int|string $snKey) : QVarIface</code> || protected || retrieve-by-key an element from an array, wrapped in a QVar
{{!-!}} <code>{{l/ver/fx|GetQObj}}(int|string $snKey) : {{l/ver/clade|Data\Mem|QVar|QVarIface}}</code> || protected || retrieve-by-key an element from an array, wrapped in a <code>{{l/ver/clade|Data\Mem|QVar}}</code>
{{!-!}} <code>{{l/ver/fx|GetSchema}}(string $sName) : {{l/ver/fx|Sys\Data\Engine|Schema|SchemaIface}}</code> || public || retrieves an object for the given Schema from the current DB Connection
{{!-!}} <code>{{l/ver/fx|GetSchema}}(string $sName) : {{l/ver/clade|Sys\Data\Engine|Schema|SchemaIface}}</code> || public || retrieves an object for the given Schema from the current DB Connection
{{!-!}} <code>{{l/ver/fx|GetVals}}()</code>
{{!-!}} <code>{{l/ver/fx|GetVals}}()</code>
{{!-!}} <code>{{l/ver/fx|Go}}()</code> || || used as a kind of primary entry-point on objects that do specific actions
{{!-!}} <code>{{l/ver/fx|Go}}()</code> || || used as a kind of primary entry-point on objects that do specific actions
{{!-!}} <code>{{l/ver/fx|HowItWent}}()</code> || || returns an object's {{l/ver/clade|Sys\Events|ItWent}} action-status object
{{!-!}} <code>{{l/ver/fx|HowItWent}}()</code> || || returns an object's <code>{{l/ver/clade|Sys\Events|ItWent}}</code> action-status object
{{!-!}} <code>{{l/ver/fx|NameOfInput}}()</code>
{{!-!}} <code>{{l/ver/fx|NameOfInput}}()</code>
{{!-!}} <code>{{l/ver/fx|ODbConn}}()</code> || || retrieve the applicable database connection object
{{!-!}} <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|Open}}()</code> || || open a connection (opposite: <code>{{l/ver/fx|Shut}}()</code>)
{{!-!}} <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|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|ParseInputArgs}}()</code>
{{!-!}} <code>{{l/ver/fx|ParseInputString}}()</code>
{{!-!}} <code>{{l/ver/fx|ParseInputString}}()</code>
{{!-!}} <code>{{l/ver/fx|PromptForMethod}}()</code> || || code-annotation method provided by {{l/ver/clade|Sys\Diag\Util|Helper}}
{{!-!}} <code>{{l/ver/fx|PromptForMethod}}()</code> || || code-annotation method provided by <code>{{l/ver/clade|Sys\Diag\Util|Helper}}</code>
{{!-!}} <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|QDbConnSlug}}()</code>     || || retrieves the Database Connection shortname ([[slug]]) if available; always returns a <code>Q{{l/ver/clade|Data\Mem\QVar|Str}}</code> 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|QVarClass}}(int{{!}}string $snKey) : string</code> || protected || sets which <code>{{l/ver/clade|Data\Mem|QVar}}</code> class to use for creating new elements in a <code>{{l/ver/clade|Sys\Data\Things\Array|QStor}}</code> array-object
{{!-!}} <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|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|SaveAsEngConnName}}()</code>
Line 32: Line 32:
|}
|}
==Existing Function Pages==
==Existing Function Pages==
{{:Special:PrefixIndex/{{PAGENAME}}/|stripprefix=1}}
<code>{{:Special:PrefixIndex/{{PAGENAME}}/|stripprefix=1}}</code>

Revision as of 02:43, 2 December 2025

Ferreteria v0.6: functions
key methods (class functions)
fx() name attribs description/notes
ActionClass() protected sets the CommOp class for DoCommand() to return
Dadex()
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) : SchemaIface 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()).
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 sets which 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

Existing Function Pages

Retrieved from "https://wooz.dev/mw/index.php?title=Ferreteria/v0.6/fx&oldid=8241"