Ferreteria/v0.6/fx: Difference between revisions

From Woozle Writes Code
Jump to navigation Jump to search
No edit summary
(improved layout; GetQObj())
Line 1: Line 1:
{{fmt/title|Ferreteria v0.6: functions|key functions & methods}}
{{fmt/title|Ferreteria v0.6: functions|key functions & methods}}
* {{l/ver/fx|Describe}}()
{| class="wikitable"
* {{l/ver/fx|DescribeInline}}()
! fx() name/definition || attribs || description/notes
* {{l/ver/fx|DoExport}}()
{{!-!}} <code>{{l/ver/fx|Describe}}()</code>
* {{l/ver/fx|DoImport}}()
{{!-!}} <code>{{l/ver/fx|DescribeInline}}()</code>
* {{l/ver/fx|FromParams}}() (static)
{{!-!}} <code>{{l/ver/fx|DoExport}}()</code>
* {{l/ver/fx|FromItemPiece}}() (static)
{{!-!}} <code>{{l/ver/fx|DoImport}}()</code>
* {{l/ver/fx|GetFTags}}()
{{!-!}} <code>{{l/ver/fx|FromParams}}()</code> || static
* {{l/ver/fx|GetVals}}()
{{!-!}} <code>{{l/ver/fx|FromItemPiece}}()</code> || static
* {{l/ver/fx|Go}}(): used as a kind of primary entry-point on objects that do specific actions
{{!-!}} <code>{{l/ver/fx|GetFTags}}()</code>
* {{l/ver/fx|HowItWent}}(): returns an object's {{l/ver/clade|Sys\Events|ItWent}} action-status object
{{!-!}} <code>{{l/ver/fx|GetQObj}}(int|string $snKey) : QVarIface</code> || protected || retrieve-by-key an element from an array, wrapped in a QVar
* {{l/ver/fx|NameOfInput}}
{{!-!}} <code>{{l/ver/fx|GetVals}}()</code>
* {{l/ver/fx|ODbConn}}: retrieves the applicable database connection object
{{!-!}} <code>{{l/ver/fx|Go}}()</code> || || used as a kind of primary entry-point on objects that do specific actions
* {{l/ver/fx|ParseInputArgs}}()
{{!-!}} <code>{{l/ver/fx|HowItWent}}()</code> || || returns an object's {{l/ver/clade|Sys\Events|ItWent}} action-status object
* {{l/ver/fx|ParseInputString}}()
{{!-!}} <code>{{l/ver/fx|NameOfInput}}()</code>
* {{l/ver/fx|PromptForMethod}}(): code-annotation method provided by {{l/ver/clade|Sys\Diag\Util|Helper}}
{{!-!}} <code>{{l/ver/fx|ODbConn}}()</code> || || retrieves the applicable database connection object
* {{l/ver/fx|QDbConnSlug}}(): 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|ParseInputArgs}}()</code>
* {{l/ver/fx|SaveAsEngSchemaName}}()
{{!-!}} <code>{{l/ver/fx|ParseInputString}}()</code>
* {{l/ver/fx|WithItemValue}}() (protected)
{{!-!}} <code>{{l/ver/fx|PromptForMethod}}()</code> || || code-annotation method provided by {{l/ver/clade|Sys\Diag\Util|Helper}}
{{!-!}} <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|SaveAsEngSchemaName}}()</code>
{{!-!}} <code>{{l/ver/fx|WithItemValue}}()</code> protected
|}

Revision as of 12:26, 29 October 2025

Ferreteria v0.6: functions
key functions & methods
fx() name/definition attribs description/notes
Describe()
DescribeInline()
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
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
ParseInputArgs()
ParseInputString()
PromptForMethod() code-annotation method provided by Helper
QDbConnSlug() retrieves the Database Connection shortname (slug) if available; always returns a QStr object.
SaveAsEngSchemaName()
WithItemValue() protected