Workbench Plugin Contract v1

Zavezujoča pogodba z oznako različice, prek katere paket prispeva k delovni površini: k vrstici dejavnosti, stranski vrstici, pomožni vrstici, spodnji plošči, vrstici stanja, ukazni vrstici in paleti ukazov ter k seznamu modulov. Ta stran je povzetek za upravljavce in avtorje paketov. Zavezujoča in popolna specifikacija (API, življenjski cikel, vedenje ob napakah, primer) je v repozitoriju, v angleščini: lib/plugins/wkfluentui/docs/contract-v1.md.

Sorodno: Pregled wkfluentui · Pogodba o slogih

Pred Contract v1 je paket k delovni površini prispeval prek petih ločenih mehanizmov, ki jih je lupina prepoznala samo z method_exists() (getModuleInfo(), getShellRegions(), getShellBadge(), getShellViews() in dogodek WKFLUENTUI_ADMIN_COMMANDS). Vsaj eden od njih ni prenašal nobene prave informacije več: vrnjene vrednosti getShellRegions() ne prebere nobena koda – signal je bil že sam obstoj metode. Paket ni mogel vprašati, ali delovna površina spodnjo ploščo sploh podpira, preden jo je uporabil, in ni imel mesta, kjer bi pravico opredelil ožje kot »ali ta uporabnik sploh sme odpreti zaslon«.

Nič od tega ni izklopljeno. Paket, ki uporablja katero od petih starih metod, deluje nespremenjeno naprej: prilagojevalnik (helper/legacyadapter.php) jih samodejno prevede v isto obliko opisa, ki jo uporablja Contract v1.

Vsa druga področja sprejmejo zaupanja vreden HTML klicatelja; to sprejme navadno besedilo, posebne znake v njem pa za HTML kodira lupina. Vrstica stanja ima eno vrstico, prispevek, ki bi lahko odprl element, pa bi zasedel vse, kar ostane od nje.

Veljavnost je enaka kot pri ukazu: prispevek, katerega lastnik je prikazani zaslon, se prikaže; prispevek, katerega lastnik sploh nima skrbniškega zaslona, velja povsod; prispevek, ki pripada drugemu zaslonu, se ne prikaže. To je dobesedno isto preverjanje, ne drugo z enakim besedilom.

Dve meji za preživetje, izpeljani iz ene številke. Pod 1024 px odpade vse, kar nima prioritete; pod 768 px poleg tega vse pod helper_plugin_wkfluentui_widgets::STATUS_PHONE_PRIORITY (80). Prispevek sme priority navesti sam; vrednost se omeji na razpon 10–95, da noben prispevek ne prehiti poti nazaj iz delovne površine, prispevek brez navedbe pa dobi 85.

priority ni order. order razvršča znotraj področja, priority odloča, kaj ostane pri ozkem zaslonu. Če bi bili eno polje, bi nov vrstni red v stranski vrstici spremenil, kaj telefon pokaže v vrstici stanja.

Tabela deskriptorja navaja html kot string | callable; viewStack() pogled s praznim telesom izpusti.

Razlika ni kozmetična. Dogodek za prijavo prispevkov se sproži enkrat, pri skrbniškem zaslonu pa še preden je zaslon izrisan. Niz mora biti torej mogoče izračunati ob prijavi, callable pa se razreši ob sestavljanju, torej potem, ko je lastna metoda html() že tekla. Prav zato obstaja.

Callable, ki vrže izjemo, stane samo ta pogled, napaka pa se zabeleži v dnevnik. Zmožnost: workbench.view.html.callable.

Register vrstice z zavihki vodi za vsako delovno območje urejen seznam neprosojnih nizov. Vrstica zato poleg modulov poimenuje tudi predmete, s katerimi dela zaslon – pri urejevalniku nastavitev je tak predmet območje, pri delovni površini za poizvedbe poizvedba. To je enkrat zgrajeno v gostitelju, ker bi bila alternativa v obeh primerih druga vrstica z zavihki v vsebini.

Zmožnost: workbench.screen.tabs.v1.

Nadomestni zaslon wkfluentui izriše za vgrajeni paket DokuWikija, zato ga pogodba v1 ne doseže: nativeViewsFor($owner) primerja lastnika prispevka s prikazanim zaslonom – lastnik bi bil wkfluentui, zaslon config, in ta dva se nikoli ne srečata. Prijava pod imenom vgrajenega paketa bi pomenila, da se ta paket izdaja za drugega.

Tak zaslon zato neposredno odgovori na štiri neobvezne metode: commands(), views(), statusItems() in tabs(). Vse štiri tečejo skozi eno zavarovano točko, zato napaka stane natanko ta en odgovor in se zabeleži v dnevnik.

Lastni pogled zaslona izpodrine splošni pogled lupine za isto področje. Zaslon, ki izriše lastno navigacijo, ne sme poleg nje dobiti še splošnega kazala, zaslon z lastnim stolpcem s kontekstom pa ne še plugin.info.txt. To je isto pravilo, ki že velja za paket, ki gosti delovno površino sam – in ista vrsta napake: nič ne spodleti, pojavi se preprosto druga stranska vrstica.

permission je callable (brez argumentov, vrne bool) ali null. Dodatno k ACL, nikoli namesto nje – skrbniški zaslon, na katerem prispevek temelji, ostane nespremenjeno zaščiten z lastnim preverjanjem DokuWikija isAccessibleByCurrentUser(). Vrednost permission, ki ni niti null niti klicljiva, velja za napačno prijavo in prispevek izključi – ne za manjkajočo, ki bi ga spustila skozi. Preverjanje, ki vrže izjemo, velja za zavrnitev, ne za sesutje, in se ne zabeleži kot napaka: »ta uporabnik tega ne sme videti« je mehanizem, ki deluje, ne okvara.

helper_plugin_wkfluentui_capabilities::has($name) – ime, ki ga paket preveri, preden zmožnost uporabi, namesto da bi preverjal številko različice ali razred. Razlog: zmožnost je lahko izdana pozneje kot različica, ki jo je napovedala.

Dve dodatni imeni:

Med dogodkom za prijavo has() odgovarja samo z osnovnim besediščem – in to je vsa resnica, ne kompromis. Ko teče lastna obravnava dogodka, provides nobenega drugega prispevajočega paketa še ni zbran. Vprašanje po zmožnosti tujega paketa v tistem trenutku nima odgovora in dobi false.

all() se za čas dogodka označi, list() pa medtem odgovarja z osnovnim besediščem, ne da bi si rezultat zapomnil. Poizvedba o zmožnosti iz lastne obravnave dogodka zato dogodka ne sproži znova.