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

clade: Sys\Data\Engine\Oper

Clade Family Aspect AClass ⇒ Oper ⇒ MyMar Clade Aliases Alias Clade Action* [i] Sys\Events\ItWent AdminReq* [i] Sys\Data\Engine\aux\ActionRq\AdminRq Base* [c,i] IO\Aspect BkupMode* [e] Sys\Data\Engine\aux\ActionRq\Admin\aux\FileFormat DataReq* [i] Sys\Data\Engine\aux\CommRq HasRost* [i,t] Config\Roster\for\AClass Schema* [i] Sys\Data\Engine\Schema Schemas* [i] Sys\Data\aux\list\Schemas Subpages MyMar MyMar/@fx/DoExport MyMar/@fx/DoTestAccess MyMar/@fx/DoUserSetup MyMar/@fx/TestRootAccess MyMar/@fx/TestUserAccess MyMar/@removed MyMar/Maria MyMar/Maria/@removed

About

• Purpose: engine-agnostic objects for doing operations on a Database Engine via an open DB connection (Conn).
  • 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.
  • Tentatively, must be initialized with a Conn object.
• Naming: short for "operator" or "operations"
• Parallel: Conn

History

• 2025-05-30 started
• 2025-11-11 renamed *Ops -> *Oper, for length-match with *Conn and consistency with related clade names

Code

as of 2025-11-11

interface iOper extends BaseIface {
    // ACTION: requests
    function DoDataRequest(DataReqIface $oReq);
    // ACTION: parameterized
    function SchemaList() : SchemasIface;
    function DoUserSetup();
    // OBJECTS
    function GetSchema(string $sName) : SchemaIface;
    #function Register() : RegIface; // SHORTCUT
    // INFO
    function ConnSlug() : string;   // connection shortname
}
abstract class caOper extends BaseClass implements SelfIface {

    // ++ 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() : iOper {
        $oThis = new static;
        return $oThis;
    }
    static public function FromConn(ConnIface $oConn) : iOper {
        $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->OConn(),$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 -- //
}

Removed

2025-11-11

Removed on 2025-06-06:

// 2025-06-06 default should take care of this now
    protected function RegisterThis() {
        $oConn = $this->OConn();
        #echo $oConn->ReflectThis()->Report(); // how do we get the ObjectSlug()?
        $sSlug = $oConn->Slug();
        $this->Register()->SetIt($sSlug,$oConn);
    }