Vizuálny editor

Balík neobsahuje žiadne UI. Editoru dá všetko, čo potrebuje na kreslenie, úpravy, kontrolu, porovnanie, náhľad a sledovanie workflowu. Zapojte to za vlastné controllery a autorizáciu (len pre správcov vlastníka):

• Dve karty: kontrolný súčet, ktorý editor načítal, posielajte ako $expectedChecksum; zastarané uloženie vyhodí DraftConflictException (409).
• Nedokončené grafy sa uložia bez problémov; úplnú validáciu robí až publikovanie.
• Pozície a popisy patria do objektu ui každého uzla — ukladá sa doslovne, engine ho ignoruje a porovnanie ho hlási ako presun.
• Id uzlov určuje editor (^[a-z][a-z0-9_]{0,63}$); importy ich premapujú (ImportResult::$idMap).
• Validačné chyby ukazujú na uzol, hranu alebo JSON pointer v konfigurácii uzla, takže editor môže zvýrazniť presné pole. Správy sú preložené (en, sk) a neobsahujú názvy tried.
• Nikde žiadne názvy tried: typy subjektov sú kľúče z registra, odkazy sa vykresľujú cez referenčné resources.

JSON resources

API pre editor a správu je vaše: použite manažéra a tieto resources (RoundlyConsulting\Workflows\Http\Resources) za vlastnou autorizáciou:

use RoundlyConsulting\Workflows\Http\Resources\{CatalogueEntryResource, InstanceResource, ValidationReportResource};

// The palette and a step's form
return CatalogueEntryResource::collection(Workflows::catalogue()->export()->types);

// Live validation
return new ValidationReportResource(Workflows::versions()->validate($request->input('graph'), 'purchase_request', $team));

// One run in detail: steps, waits and escalations in a fixed number of queries
$instance = Workflows::instances()->find($ulid) ?? abort(404);
Workflows::instances()->detail($instance);

return new InstanceResource($instance->loadMissing(['subject', 'owner', 'starter']));

• definition, version, subject, owner, started_by a published_by sa vykresľujú len z načítaných relácií alebo uloženej morph dvojice: kolekcia nikdy nerobí dopyt na každý riadok. Načítajte vopred, čo potrebujete: ->with(['definition', 'version', 'subject', 'owner', 'starter']).
• Workflows::instances()->detail($instance) cez loadMissing() načíta definíciu, verziu, záznam krokov (v poradí), čakajúce čakania aj čakajúce eskalácie (podľa splatnosti), takže InstanceResource vykreslí steps, waits a escalations pevným počtom dopytov. Bez detail() sa tieto tri kľúče vynechajú.
• Správy neznámych výnimiek sa nikdy neposielajú von: pri exception alebo worker_timeout je správou preložené workflows::failures.exception; pôvodná správa ostáva v databáze pre operátorov.
• output.request_id kroku approval je kolo, v ktorom sa rozhoduje cez within().

Referenčné resources — žiadne názvy tried navonok

Modely aplikácie (vlastník, subjekt, používateľ) sa vykresľujú cez referenčný resource — predvolene len {id, type: class_basename}, nikdy morph trieda ani názov triedy. Zmazaný subjekt sa vykreslí z uloženej dvojice bez dopytu:

final class TeamReferenceResource extends JsonResource
{
    public function toArray(Request $request): array
    {
        return ['id' => $this->resource->getKey(), 'name' => $this->resource->name];
    }
}

// config/workflows.php
'resources' => ['owner' => TeamReferenceResource::class, ...],

Prázdna hodnota použije predvolenú triedu; čokoľvek, čo nie je inštanciovateľná podtrieda JsonResource (vrátane samotnej základnej triedy), vyhodí InvalidWorkflowsConfigurationException s názvom kľúča.

Chyby → HTTP

Každá výnimka balíka rozširuje WorkflowsException s errorCode(), status() a context(); úplný zoznam nájdete v časti Výnimky:

try {
    $result = $workflows->start($key, $subject, $owner)->input($request->all())->by($request->user())->dispatch();
} catch (WorkflowsException $e) {
    return response()->json(['code' => $e->errorCode(), 'message' => $e->getMessage()], $e->status());
}