class Sivujetti\UserSite\UserSiteAPI

Luokka, joka passataan automaattisesti sivuston pääluokalle ${SIVUJETTI_SITE_PATH}Site.php (/path/to/backend/site/Site.php).

Synopsis

class UserSiteAPI {

    /* Vakiot */
    const ON_ROUTE_CONTROLLER_BEFORE_EXEC = "sivujetti:beforeExecRouteController";
    const ON_PAGE_BEFORE_RENDER = "sivujetti:onPageBeforeRender";

    /* Metodit */
    public on(string $when, callable $thenDo): int
    public enqueueCssFile(string $url, array<string, string> $attrs = []): void
    public enqueueJsFile(string $url, array<string, string> $attrs = []): void
    public isCssFileEnqueued(string $url): bool
    public isJsFileEnqueued(string $url): bool
    public registerBlockType(string $name, BlockTypeInterface $instance): void
    public enqueueEditAppJsFile(string $url): void
    public enqueuePreviewAppJsFile(string $url): void
    public registerBlockRenderer(string $fileId, ?string $friendlyName = null, ?string $for = null): void
    public getPlugin(string $name): ?UserPluginInterface
}

Vakiot

ON_ROUTE_CONTROLLER_BEFORE_EXEC: Signaali, joka ajetaan juuri ennen kontrolleria
ON_PAGE_BEFORE_RENDER: Signaali, joka ajetaan juuri ennen sivun renderöimistä

Metodit

on()

…

Signature

public function on(string $when, callable $thenDo): int

Esimerkit

...

enqueueCssFile()

…

Signature

public function enqueueCssFile(string $url, array<string, string> $attrs = []): void

Esimerkit

...

enqueueJsFile()

…

Signature

public function enqueueJsFile(string $url, array<string, string> $attrs = []): void

Esimerkit

...

isCssFileEnqueued()

…

Signature

public function isCssFileEnqueued(string $url): bool

Esimerkit

...

isJsFileEnqueued()

…

Signature

public function isJsFileEnqueued(string $url): bool

Esimerkit

...

registerBlockType()

…

Signature

public function registerBlockType(string $name, BlockTypeInterface $instance): void

Esimerkit

...

enqueueEditAppJsFile()

Lisää tiedoston sisällytettäväksi sivuun kirjautuneelle muokkaustilassa. $url tulee sijaita ${SIVUJETTI_SITE_PATH}public/ -kansiossa.

Signature

public function enqueueEditAppJsFile(string $url): void

Esimerkit

...

enqueuePreviewAppJsFile()

Lisää tiedoston sisällytettäväksi esikatselu-iframeen.

Signature

public function enqueuePreviewAppJsFile(string $url): void

Esimerkit

...

registerBlockRenderer()

Rekisteröi tiedosto, jolla voi renderöidä lohkon.

Signature

public function registerBlockRenderer(string $fileId, ?string $friendlyName = null, ?string $for = null): void

Esimerkit

...

getPlugin()

…

Signature

public function getPlugin(string $name): ?UserPluginInterface

Esimerkit

...