Ferreteria/v0.6/fx: Difference between revisions
< Ferreteria | v0.6
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 18: | Line 18: | ||
{{!-!}} <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|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 {{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|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>). | ||
Revision as of 19:10, 4 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 | |
OCred() |
retrieves the applicable connection credentials object | |
OHost() |
retrieves the applicable Host object
| |
OPlug() |
retrieves the applicable Plug 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
- ActionClass
- Dadex
- Describe
- DescribeInline
- DoCommand
- DoExport
- DoImport
- From*
- FromParams
- GetFTags
- GetQObj
- GetSchema
- GetVals
- Go
- HowItWent
- NameOfInput
- OCred
- ODbConn
- OSock
- Open
- OpenProcess
- ParseInputArgs
- ParseInputString
- QDbConnSlug
- QVarClass
- ReadInput
- ReadUserCommand
- WithItemPiece
- WithItemValue
- WithItemValue/@removed