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

From Woozle Writes Code
< Ferreteria‎ | v0.6‎ | clade‎ | Sys‎ | Data‎ | Engine
Revision as of 17:09, 11 November 2025 by Woozle (talk | contribs)
Jump to navigation Jump to search
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

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.
  • PURPOSE: Handles data operations on an open DB connection
 * Tentatively, must be initialized with a Conn object.
  • Naming: short for "operator" or "operations"

History

  • 2025-05-30 started
  • 2025-11-11 renamed *Ops -> *Oper, for length-match with *Conn

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 -- //
}

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);
    }