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

clade: Sys\Data\Engine\Conn

Clade Family Plug AnObject → Conn → MyMar Clade Aliases Alias Clade ActionIface Sys\Events\ItWent Base* [c,i] IO\Aspect\Connx\Plug Creds* [i] IO\Aspect\Creds HasRost* [i,t] Config\Roster\for\AnObject Oper* [ca,i] Sys\Data\Engine\Ops PlayerIface Data\Base\Result\Player RostClass Sys\Data\Engine\aux\DbList SelfIface Sys\Data\Engine\Conn SockIface IO\Aspect\Socket ViewIface IO\O\View Subpages @history @removed MyMar MyMar/Maria view view/VConns

About

• PURPOSE: base class for talking to a database engine
  • This is a connection (to the DB engine), but it also contains a connection (to the shell endpoint).

Pages

• @history
• @removed

Code

as of 2025-10-15

interface iConn extends BaseIface, HasRostIface {
    // INVOCATION
    //#[BaseIface] function Open() : ActionIface;
    //#[BaseIface] function Shut() : ActionIface;
    // OBJECTS
    function OOper() : OperIface;
    function OSock() : SockIface;  // code-to-cmd-endpoint
    // UI
    //#[\Woozalia\Ferret\IO\iAspect] function DescribeInline() : string;
}

abstract class caConn extends BaseClass implements SelfIface {
    use HasRostTrait;

    // ++ CONFIG ++ //

    // #[Oper]
    abstract protected function OperType() : string;
    static protected function RosterClass() : string { return RostClass::class; }  // OVERRIDE

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

    public function __construct(string $sSlug, private SockIface $oSock) {
        $this->WithSlug($sSlug);
    }
    public function OSock() : SockIface { return $this->oSock; }

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

    public function Inspect() : ViewIface { return new ($this->InspectorClass())($this,$this->OSock(),$this->OCred(),$this); }

    // SHORTCUT
    protected function OCred() : CredsIface { return $this->OSock()->OCred(); }

    // #[Oper]
    private $oOper=NULL;
    #public function HoldOper(OperIface $o) : void { $this->oOper = $o; }
    // #[Oper]
    public function OOper() : OperIface { return $this->oOper ?? ($this->oOper = $this->OOperNew()); }
    // #[Oper]
    protected function OOperNew() : OperIface {
        $sType = $this->OperType();
        $osOper = OperAdmin::FromClassSlug($sType);
        if ($osOper->HasIt()) {
            $scOper = $osOper->GetIt();
            #$echo $this->ReflectThis()->Report();
            #echo $scOper::ReflectSelf()->Report();
            #$oOper = new ($scOper);
            $oOper = $scOper::AccessSelf();
            $oOper->WithConn($this);  // give new Oper a pointer to its Conn
        } else {
            echo self::CodingPrompt("This Connection expects an engine of type '$sType' to be defined.");
            $oOper = NULL;
        }
        return $oOper;
    }

    // -- OBJECTS -- //
}