Ferreteria/v0.6/clade/Sys/Data/Engine/Oper

clade: Sys\Data\Engine\Oper

Clade Family
Aspect AClass	→ Ops	→ MyMar
Aliases
alias clade Action* ItWent (i) AdminReq* AdminRq (i) Base* Aspect (c,i) BkupMode* FileFormat (e) DataReq* CommRq (i) HasRost* AClass (i,t) Schema* Schema (i) Schemas* Schemas (i)

About

• Purpose: engine-agnostic objects for doing operations on a Database Engine
  • This mainly descends from the I/O Aspect clade. The other major aspect of Database management is the Engine Connection clade, which handles the mechanics of connecting from the Ferreteria client code to the database server, wherever it may be, and handling I/O therewith.

Code

interface iOps extends BaseIface, HasRostIface {
    // ACTION: requests
    function DoDataRequest(DataReqIface $oReq);
    // ACTION: parameterized
    function SchemaList() : SchemasIface;
    function DoUserSetup();
    // OBJECTS
    function GetSchema(string $sName) : SchemaIface;
    // INFO
    function ConnSlug() : string;   // connection shortname
}
abstract class caOps extends BaseClass implements SelfIface {
    use HasRostTrait;

    // ++ CONFIG ++ //

    abstract protected function CommOpClass() : string;
    abstract protected function SchemaClass() : string;
    abstract protected function ScribeClass() : string;

    // -- CONFIG -- //
    // ++ SETUP ++ //

    protected function __construct() {}

    // USAGE: Only call if constructing to pass to a Conn object's constructor
    static public function ForConn() : iOps {
        $oThis = new static;
        return $oThis;
    }
    static public function FromConn(ConnIface $oConn) : iOps {
        $oThis = new static;
        $oThis->WithConn($oConn);
        return $oThis;
    }

    // ++ SETUP: dynamic ++ //

    private $oConn=NULL;
    public function WithConn(ConnIface $oConn) : void {
        $this->oConn = $oConn;
        #$this->RegisterThis();
    }
    protected function OConn() : ConnIface { return $this->oConn; }

    // -- SETUP -- //
    // ++ OBJECTS ++ //

    // TODO: Rename to OSchema()
    public function GetSchema(string $sName) : SchemaIface { return new ($this->SchemaClass())($this,$sName); }

    // -- OBJECTS -- //
    // ++ INFO ++ //

    public function ConnSlug() : string { return $this->OConn()->ObjectSlug(); }

    // -- INFO -- //
    // ++ UI ++ //

    // UNPROMPT
    public function DescribeInline() : string { return $this->OConn()->DescribeInline(); }  // sometimes not needed

    // -- UI -- //
}