Ferreteria/v0.6/fx: Difference between revisions

From Woozle Writes Code
Jump to navigation Jump to search
(Created page with "{{fmt/title|Ferreteria v0.6: functions|key functions & methods}} * {{l/ver/fx|Describe}}() * {{l/ver/fx|ParseInputArgs}}() * {{l/ver/fx|ParseInputString}}()")
 
No edit summary
 
(28 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{fmt/title|Ferreteria v0.6: functions|key functions & methods}}
{{fmt/title|Ferreteria v0.6: functions|key methods (class functions)}}
* {{l/ver/fx|Describe}}()
{| class="wikitable"
* {{l/ver/fx|ParseInputArgs}}()
! fx() name || attribs || description/notes
* {{l/ver/fx|ParseInputString}}()
{{!-!}} <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|Describe}}()</code>
{{!-!}} <code>{{l/ver/fx|DescribeInline}}()</code>
{{!-!}} <code>{{l/ver/fx|DoCommand}}()<code>
{{!-!}} <code>{{l/ver/fx|DoExport}}()</code>
{{!-!}} <code>{{l/ver/fx|DoImport}}()</code>
{{!-!}} <code>{{l/ver/fx|FromParams}}()</code> || static
{{!-!}} <code>{{l/ver/fx|FromItemPiece}}()</code> || static
{{!-!}} <code>{{l/ver/fx|GetFTags}}()</code>
{{!-!}} <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/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|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 <code>{{l/ver/clade|Sys\Events|ItWent}}</code> action-status object
{{!-!}} <code>{{l/ver/fx|NameOfInput}}()</code>
{{!-!}} <code>{{l/ver/fx|NewAction}}()</code>|| || create a new <code>{{l/ver/clade|Sys\Events|ItWent}}</code> object
{{!-!}} <code>{{l/ver/fx|ODbConn}}()</code> || || retrieve the applicable {{l/ver/clade|Sys\Data\Engine|Conn|database connection}} object
{{!-!}} <code>{{l/ver/fx|OCred}}()</code>  || || retrieves the applicable {{l/ver/clade|IO\Aspect|Creds|connection credentials}} object
{{!-!}} <code>{{l/ver/fx|OHost}}()</code>  || || retrieves the applicable <code>{{l/ver/clade|IO\Aspect|Host}}</code> object
{{!-!}} <code>{{l/ver/fx|OPlug}}()</code>  || || retrieves the applicable <code>{{l/ver/clade|IO\Aspect\Connx|Plug}}</code> object
{{!-!}} <code>{{l/ver/fx|OSock}}()</code>  || || retrieves the applicable <code>{{l/ver/clade|IO\Aspect|Socket}}</code> object
{{!-!}} <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|ParseInputArgs}}()</code>
{{!-!}} <code>{{l/ver/fx|ParseInputString}}()</code>
{{!-!}} <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 <code>Q{{l/ver/clade|Data\Mem\QVar|Str}}</code> 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|SaveAsEngConnName}}()</code>
{{!-!}} <code>{{l/ver/fx|Shut}}()</code> || || closes an open connection (opposite: <code>{{l/ver/fx|Open}}()</code>)
{{!-!}} <code>{{l/ver/fx|WithItemPiece}}()</code> || protected
|}
==Existing Function Pages==
<code>{{:Special:PrefixIndex/{{PAGENAME}}/|stripprefix=1}}</code>

Latest revision as of 02:42, 5 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()
NewAction() create a new ItWent object
ODbConn() retrieve the applicable database connection object
OCred() retrieves the applicable connection credentials object
OHost() retrieves the applicable Host object
OPlug() retrieves the applicable Plug object
OSock() retrieves the applicable Socket 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=8276"