{ "generated": "php tests/tools/api-docs.php", "classes": [ { "name": "Minn\\Admin\\ActivityChart", "short": "ActivityChart", "namespace": "Minn\\Admin", "kind": "final readonly class", "file": "public/minn/src/Minn/Admin/ActivityChart.php", "lines": 65, "doc": "The overview's activity chart: published posts and pages plus every\ncomment, counted per bar. A window over 45 days is drawn in weeks,\nanything shorter in days; each bar carries the (from, to] GMT bounds\nthe drill-down asks for.", "implements": [], "extends": null, "uses": [ "Minn\\Content\\Site", "Minn\\Db" ], "usedBy": [ "Minn\\Admin\\Dashboard", "Minn\\Rest\\Services" ], "constructor": { "signature": "__construct(Minn\\Db $db, Minn\\Content\\Site $site)", "doc": "", "shapes": [], "params": [ { "name": "db", "type": "Minn\\Db", "shape": "", "default": null, "doc": "" }, { "name": "site", "type": "Minn\\Content\\Site", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 18, "end": 22 }, "cases": [], "constants": [], "properties": [ { "name": "db", "type": "Minn\\Db", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "site", "type": "Minn\\Content\\Site", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [], "name": "bars", "static": false, "visibility": "public", "signature": "bars(int $days, int $now): array", "doc": "The bars for a window of days, counted from the database.", "shapes": [ "@return list" ], "params": [ { "name": "days", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "now", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 29, "end": 44 }, { "routes": [], "name": "bucket", "static": true, "visibility": "public", "signature": "bucket(array $dates, int $days, int $now, int $offset): array", "doc": "GMT stamps into bars, oldest first. Labels are site-local: the day\nfor daily bars, \"Week of\" the bar's first day for weekly ones.", "shapes": [ "@param list $dates \"Y-m-d H:i:s\" in GMT", "@return list" ], "params": [ { "name": "dates", "type": "array", "shape": "list", "default": null, "doc": "\"Y-m-d H:i:s\" in GMT" }, { "name": "days", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "now", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "offset", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 53, "end": 79 } ] }, { "name": "Minn\\Admin\\ActivityFeed", "short": "ActivityFeed", "namespace": "Minn\\Admin", "kind": "final readonly class", "file": "public/minn/src/Minn/Admin/ActivityFeed.php", "lines": 212, "doc": "What happened lately, as the overview and the bell tell it: the caller's\nown recent posts and the latest comments, and the events behind one\nchart bar. Also the visibility rule every comment row is put through.", "implements": [], "extends": null, "uses": [ "Minn\\Admin\\Format", "Minn\\Auth\\Capabilities", "Minn\\Content\\Texturize", "Minn\\Content\\Users", "Minn\\Db" ], "usedBy": [ "Minn\\Admin\\Dashboard", "Minn\\Admin\\Notifications", "Minn\\Rest\\Services" ], "constructor": { "signature": "__construct(Minn\\Db $db, Minn\\Content\\Users $users, Minn\\Auth\\Capabilities $capabilities)", "doc": "", "shapes": [], "params": [ { "name": "db", "type": "Minn\\Db", "shape": "", "default": null, "doc": "" }, { "name": "users", "type": "Minn\\Content\\Users", "shape": "", "default": null, "doc": "" }, { "name": "capabilities", "type": "Minn\\Auth\\Capabilities", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 19, "end": 24 }, "cases": [], "constants": [], "properties": [ { "name": "db", "type": "Minn\\Db", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "users", "type": "Minn\\Content\\Users", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "capabilities", "type": "Minn\\Auth\\Capabilities", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [], "name": "recent", "static": false, "visibility": "public", "signature": "recent(int $userId, int $now, int $offset): array", "doc": "The overview's four most recent items, times already worded (\"2 hours ago\").\n\nOracle-caught quirk: the reference's recent-activity query runs with a\nmulti-type post_type plus perm=editable, and on that combination it\nrestricts EVERY status to post_author = caller, admins included,\npublished posts included. Authorless posts appear for nobody. The\nengine reproduces the observed behavior, not the intent.", "shapes": [ "@return list" ], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "now", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "offset", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 37, "end": 47 }, { "routes": [], "name": "between", "static": false, "visibility": "public", "signature": "between(int $userId, string $from, string $to, int $now): array", "doc": "The events behind one chart bar, (from, to] GMT, newest first. Post\nrows decode the RAW stored title; comment rows decode the texturized\none (the reference's asymmetry, kept).", "shapes": [ "@return list" ], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "from", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "to", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "now", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 56, "end": 66 }, { "routes": [], "name": "commentVisible", "static": false, "visibility": "public", "signature": "commentVisible(int $userId, int $postId): bool", "doc": "May this caller see a comment row that names its post?", "shapes": [], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "postId", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 69, "end": 79 }, { "routes": [], "name": "postTitle", "static": false, "visibility": "public", "signature": "postTitle(int $postId): string", "doc": "A post's stored title, empty when the post is gone.", "shapes": [], "params": [ { "name": "postId", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 82, "end": 85 }, { "routes": [], "name": "displayName", "static": false, "visibility": "public", "signature": "displayName(int $userId): string", "doc": "A user's display name, empty when the user is gone.", "shapes": [], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 88, "end": 91 }, { "routes": [], "name": "ownPosts", "static": false, "visibility": "private", "signature": "ownPosts(int $userId, int $offset): array", "doc": "The caller's own posts, merged from a by-modified and a by-date window.", "shapes": [ "@return list" ], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "offset", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 98, "end": 140 }, { "routes": [], "name": "latestComments", "static": false, "visibility": "private", "signature": "latestComments(int $userId): array", "doc": "", "shapes": [ "@return list" ], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 143, "end": 168 }, { "routes": [], "name": "publishedBetween", "static": false, "visibility": "private", "signature": "publishedBetween(string $from, string $to): array", "doc": "", "shapes": [ "@return list" ], "params": [ { "name": "from", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "to", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 171, "end": 193 }, { "routes": [], "name": "commentsBetween", "static": false, "visibility": "private", "signature": "commentsBetween(int $userId, string $from, string $to): array", "doc": "", "shapes": [ "@return list" ], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "from", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "to", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 196, "end": 227 } ] }, { "name": "Minn\\Admin\\AdminTypes", "short": "AdminTypes", "namespace": "Minn\\Admin", "kind": "final class", "file": "public/minn/src/Minn/Admin/AdminTypes.php", "lines": 85, "doc": "Admin-facing type facts (viewable, labels, supports, the edit gate) live\nbeside, not inside, the wp/v2 registry, so the types route's payload\nstays byte-faithful.", "implements": [], "extends": null, "uses": [ "Minn\\Auth\\Capabilities", "Minn\\Json", "Minn\\Rest\\Types" ], "usedBy": [ "Minn\\Admin\\V1Controller", "Minn\\Engine", "Minn\\Front\\AdminBar", "Minn\\Rest\\Api" ], "constructor": { "signature": "__construct(Minn\\Rest\\Types $types, Minn\\Auth\\Capabilities $capabilities)", "doc": "", "shapes": [], "params": [ { "name": "types", "type": "Minn\\Rest\\Types", "shape": "", "default": null, "doc": "" }, { "name": "capabilities", "type": "Minn\\Auth\\Capabilities", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 20, "end": 24 }, "cases": [], "constants": [], "properties": [ { "name": "extra", "type": "?array", "readonly": false, "static": false, "doc": "", "visibility": "private", "promoted": false }, { "name": "types", "type": "Minn\\Rest\\Types", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "capabilities", "type": "Minn\\Auth\\Capabilities", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [], "name": "extra", "static": false, "visibility": "public", "signature": "extra(): array", "doc": "The types beyond post and page the app may show, with their labels.", "shapes": [], "params": [], "line": 27, "end": 45 }, { "routes": [], "name": "section", "static": false, "visibility": "public", "signature": "section(int $userId): array", "doc": "The boot-status types section: edit-visible types for this user, slimmed.", "shapes": [], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 48, "end": 68 }, { "routes": [], "name": "restBaseOf", "static": false, "visibility": "public", "signature": "restBaseOf(string $slug): string", "doc": "The rest_base of a type slug.", "shapes": [], "params": [ { "name": "slug", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 71, "end": 74 }, { "routes": [], "name": "singularOf", "static": false, "visibility": "public", "signature": "singularOf(string $slug): string", "doc": "A type's singular label.", "shapes": [], "params": [ { "name": "slug", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 77, "end": 80 }, { "routes": [], "name": "editable", "static": false, "visibility": "public", "signature": "editable(): array", "doc": "The viewable types a person edits in the app: slug => rest base. @return array", "shapes": [ "@return array" ], "params": [], "line": 83, "end": 92 }, { "routes": [], "name": "commentsEnabled", "static": false, "visibility": "public", "signature": "commentsEnabled(): bool", "doc": "Whether a UI post type still supports comments.", "shapes": [], "params": [], "line": 95, "end": 99 } ] }, { "name": "Minn\\Admin\\App", "short": "App", "namespace": "Minn\\Admin", "kind": "final readonly class", "file": "public/minn/src/Minn/Admin/App.php", "lines": 100, "doc": "The Minn Admin app on disk: the symlinked dev copy the engine serves the\nshell and assets from. Minn Admin is MIT, so reading its files is fine.", "implements": [], "extends": null, "uses": [ "Minn\\Content\\Site", "Minn\\Support\\FileHeaders", "Minn\\Support\\Serialized" ], "usedBy": [ "Minn\\Admin\\AppController", "Minn\\Admin\\BootPayload", "Minn\\Admin\\BundleController", "Minn\\Admin\\Translations", "Minn\\Engine", "Minn\\Front\\AdminBar", "Minn\\Rest\\Services" ], "constructor": { "signature": "__construct(string $dir)", "doc": "", "shapes": [], "params": [ { "name": "dir", "type": "string", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 27, "end": 29 }, "cases": [], "constants": [ { "name": "ASSET_TYPES", "value": "array ( 'css' => 'text/css', 'js' => 'application/javascript', 'woff2' => 'font/woff2', 'woff' => 'font/woff', 'svg' => 'image/svg+xml', 'png' => 'image/png', 'json' => 'application/json', )", "doc": "", "visibility": "private" } ], "properties": [ { "name": "dir", "type": "string", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [], "name": "switchedOff", "static": true, "visibility": "public", "signature": "switchedOff(string $contentDir, Minn\\Content\\Site $site): bool", "doc": "Whether the site has switched Minn Admin off: its plugin folder is in\nwp-content/plugins (the record the reference keeps) and active_plugins\ndoes not name it. A site that carries only the engine's bundle has no\nsuch record and keeps its admin.", "shapes": [], "params": [ { "name": "contentDir", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "site", "type": "Minn\\Content\\Site", "shape": "", "default": null, "doc": "" } ], "line": 37, "end": 43 }, { "routes": [], "name": "dir", "static": false, "visibility": "public", "signature": "dir(): string", "doc": "Where the bundle sits on disk.", "shapes": [], "params": [], "line": 46, "end": 49 }, { "routes": [], "name": "installed", "static": false, "visibility": "public", "signature": "installed(): bool", "doc": "Whether the bundle is on disk.", "shapes": [], "params": [], "line": 52, "end": 55 }, { "routes": [], "name": "version", "static": false, "visibility": "public", "signature": "version(): string", "doc": "The bundle's version from its plugin header.", "shapes": [], "params": [], "line": 58, "end": 72 }, { "routes": [], "name": "file", "static": false, "visibility": "public", "signature": "file(string $relative): ?string", "doc": "The absolute path of a readable file inside the app, or null.", "shapes": [], "params": [ { "name": "relative", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 75, "end": 85 }, { "routes": [], "name": "assetVersion", "static": false, "visibility": "public", "signature": "assetVersion(string $relative): string", "doc": "A self-busting asset version: app version plus file mtime.", "shapes": [], "params": [ { "name": "relative", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 88, "end": 92 }, { "routes": [], "name": "asset", "static": false, "visibility": "public", "signature": "asset(string $relative): ?array", "doc": "The absolute path and content type of an asset inside the app, or\nnull for anything missing or outside it.", "shapes": [ "@return array{0: string, 1: string}|null" ], "params": [ { "name": "relative", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 100, "end": 113 } ] }, { "name": "Minn\\Admin\\AppController", "short": "AppController", "namespace": "Minn\\Admin", "kind": "final readonly class", "file": "public/minn/src/Minn/Admin/AppController.php", "lines": 149, "doc": "Serves Minn Admin from the engine: the path-routed shell (every\nsub-path renders the same page) and the app's assets. The nonce refresh\napp.js asks admin-ajax.php for is the reference's own rest-nonce action\n(Runtime\\AjaxController).", "implements": [], "extends": null, "uses": [ "Minn\\Admin\\App", "Minn\\Admin\\BootPayload", "Minn\\Auth\\Authenticated", "Minn\\Auth\\Authenticator", "Minn\\Auth\\Capabilities", "Minn\\Content\\SiteIcon", "Minn\\Front\\Permalinks", "Minn\\Html", "Minn\\Http\\Access", "Minn\\Http\\Method", "Minn\\Http\\Policy", "Minn\\Http\\Request", "Minn\\Http\\Response", "Minn\\Http\\Route", "Minn\\Json", "Minn\\Runtime\\Runtime" ], "usedBy": [ "Minn\\Engine" ], "constructor": { "signature": "__construct(Minn\\Admin\\App $app, Minn\\Admin\\BootPayload $payload, Minn\\Auth\\Authenticator $authenticator, Minn\\Auth\\Capabilities $capabilities, Minn\\Front\\Permalinks $permalinks, string $engineVersion, Minn\\Content\\SiteIcon $icon, bool $off = false)", "doc": "", "shapes": [], "params": [ { "name": "app", "type": "Minn\\Admin\\App", "shape": "", "default": null, "doc": "" }, { "name": "payload", "type": "Minn\\Admin\\BootPayload", "shape": "", "default": null, "doc": "" }, { "name": "authenticator", "type": "Minn\\Auth\\Authenticator", "shape": "", "default": null, "doc": "" }, { "name": "capabilities", "type": "Minn\\Auth\\Capabilities", "shape": "", "default": null, "doc": "" }, { "name": "permalinks", "type": "Minn\\Front\\Permalinks", "shape": "", "default": null, "doc": "" }, { "name": "engineVersion", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "icon", "type": "Minn\\Content\\SiteIcon", "shape": "", "default": null, "doc": "" }, { "name": "off", "type": "bool", "shape": "", "default": "false", "doc": "" } ], "visibility": "public", "line": 30, "end": 41 }, "cases": [], "constants": [], "properties": [ { "name": "app", "type": "Minn\\Admin\\App", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "payload", "type": "Minn\\Admin\\BootPayload", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "authenticator", "type": "Minn\\Auth\\Authenticator", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "capabilities", "type": "Minn\\Auth\\Capabilities", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "permalinks", "type": "Minn\\Front\\Permalinks", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "engineVersion", "type": "string", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "icon", "type": "Minn\\Content\\SiteIcon", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "off", "type": "bool", "readonly": true, "static": false, "doc": "the site has deactivated the Minn Admin plugin: the engine runs without an admin", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [ "GET /minn-admin (public)", "GET /minn-admin/{rest*} (public)" ], "name": "shell", "static": false, "visibility": "public", "signature": "shell(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "Requires a signed-in user who can edit content; otherwise the login form.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 46, "end": 64 }, { "routes": [ "GET /minn/admin/assets/{path*} (public)" ], "name": "asset", "static": false, "visibility": "public", "signature": "asset(Minn\\Http\\Request $request, string $path): Minn\\Http\\Response", "doc": "One file of the app bundle, with its content type and caching headers.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" }, { "name": "path", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 115, "end": 123 }, { "routes": [], "name": "offPage", "static": false, "visibility": "private", "signature": "offPage(): string", "doc": "The engine without an admin: the site keeps serving; the command that brings the admin back is named.", "shapes": [], "params": [], "line": 67, "end": 82 }, { "routes": [], "name": "favicon", "static": false, "visibility": "private", "signature": "favicon(): string", "doc": "The tab's icon, chosen as Minn Admin's own shell chooses it: the site\nicon when there is one, else a brand mark a theme or plugin offers on\nminn_admin_favicon, else Minn's \"m\" in the viewer's accent (Minn\nAdmin's own drawing when it runs as code, its default accent if not).\nWithout one the browser asks for /favicon.ico.", "shapes": [], "params": [], "line": 91, "end": 111 }, { "routes": [], "name": "render", "static": false, "visibility": "private", "signature": "render(array $boot): string", "doc": "The shell reproduces the structure of Minn Admin's own template.php\n(an MIT file): pre-paint theme, inline window.MINN, mount point, app.js.", "shapes": [], "params": [ { "name": "boot", "type": "array", "shape": "", "default": null, "doc": "" } ], "line": 129, "end": 175 } ] }, { "name": "Minn\\Admin\\Appearance", "short": "Appearance", "namespace": "Minn\\Admin", "kind": "final readonly class", "file": "public/minn/src/Minn/Admin/Appearance.php", "lines": 82, "doc": "A person's Minn Admin appearance: the colour scheme and its custom\ntoken maps, stored where the app stores them (user meta\nminn_admin_appearance, a serialized array) so the choice survives an\neject. The two WordPress-era switches, \"Minn is the default admin\" and\n\"Minn admin bar on the site\", are always on here: there is no other\nadmin and no other bar, so the engine reports them true and ignores\nwrites to them.", "implements": [], "extends": null, "uses": [ "Minn\\Content\\Users", "Minn\\Support\\Serialized" ], "usedBy": [ "Minn\\Admin\\BootPayload", "Minn\\Admin\\PreferencesController", "Minn\\Engine", "Minn\\Front\\AdminBar", "Minn\\Rest\\Services" ], "constructor": { "signature": "__construct(Minn\\Content\\Users $users)", "doc": "", "shapes": [], "params": [ { "name": "users", "type": "Minn\\Content\\Users", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 42, "end": 44 }, "cases": [], "constants": [ { "name": "META", "value": "'minn_admin_appearance'", "doc": "", "visibility": "public" }, { "name": "SCHEMES", "value": "array ( 0 => 'minn', 1 => 'ocean', 2 => 'forest', 3 => 'amber', 4 => 'rose', 5 => 'coral', 6 => 'teal', 7 => 'slate', 8 => 'dusk', )", "doc": "", "visibility": "public" }, { "name": "SLOTS", "value": "array ( 0 => 'bg', 1 => 'bg2', 2 => 'panel', 3 => 'panel2', 4 => 'hover', 5 => 'border', 6 => 'border2', 7 => 'text', 8 => 'text2', 9 => 'text3', 10 => 'accent', 11 => 'accent2', 12 => 'accentFg', )", "doc": "Scheme slots in the order the app lists them.", "visibility": "public" }, { "name": "BASE", "value": "array ( 'dark' => array ( 'bg' => '#0b0b0d', 'bg2' => '#101013', 'panel' => '#151518', 'panel2' => '#1b1b1f', 'hover' => '#202027', 'border' => '#242429', 'border2' => '#31313a', 'text' => '#ececed', 'text2' => '#9d9da7', 'text3' => '#63636d', 'accent' => '#6e62f5', 'accent2' => '#8a80f8', 'accentFg' => '#ffffff', ), 'light' => array ( 'bg' => '#f6f6f7', 'bg2' => '#ffffff', 'panel' => '#ffffff', 'panel2' => '#f4f4f6', 'hover' => '#eeeef1', 'border' => '#e7e7ea', 'border2' => '#dadade', 'text' => '#1a1a1f', 'text2' => '#5e5e69', 'text3' => '#9696a0', 'accent' => '#6a5ef2', 'accent2' => '#5a4ef0', 'accentFg' => '#ffffff', ), )", "doc": "The app's own Minn tokens, the fill for incomplete custom maps.", "visibility": "public" } ], "properties": [ { "name": "users", "type": "Minn\\Content\\Users", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [], "name": "read", "static": false, "visibility": "public", "signature": "read(int $userId): array", "doc": "A user's saved appearance, normalised.", "shapes": [ "@return array{scheme: string, custom: array, defaultAdmin: bool, frontBar: bool, font: string}" ], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 51, "end": 55 }, { "routes": [], "name": "save", "static": false, "visibility": "public", "signature": "save(int $userId, array $raw): array", "doc": "Merges the given keys over the stored map and writes it back; returns the normalised result.", "shapes": [], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "raw", "type": "array", "shape": "", "default": null, "doc": "" } ], "line": 58, "end": 68 }, { "routes": [], "name": "normalise", "static": true, "visibility": "public", "signature": "normalise(array $raw): array", "doc": "The appearance with every field valid and every missing one defaulted.", "shapes": [], "params": [ { "name": "raw", "type": "array", "shape": "", "default": null, "doc": "" } ], "line": 71, "end": 89 }, { "routes": [], "name": "hex", "static": true, "visibility": "public", "signature": "hex(string $value): string", "doc": "#rgb or #rrggbb to lowercase #rrggbb, or '' for anything else.", "shapes": [], "params": [ { "name": "value", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 92, "end": 99 } ] }, { "name": "Minn\\Admin\\BootPayload", "short": "BootPayload", "namespace": "Minn\\Admin", "kind": "final readonly class", "file": "public/minn/src/Minn/Admin/BootPayload.php", "lines": 245, "doc": "The window.MINN boot payload, assembled from the engine: the keys app.js\nneeds to boot and drive the wp/v2 surface, with capabilities from the\nengine's own model.", "implements": [], "extends": null, "uses": [ "Minn\\Admin\\App", "Minn\\Admin\\Appearance", "Minn\\Admin\\HiddenIntegrations", "Minn\\Admin\\Translations", "Minn\\Auth\\Authenticated", "Minn\\Auth\\Capabilities", "Minn\\Auth\\Nonce", "Minn\\Content\\Site", "Minn\\Content\\SiteIcon", "Minn\\Front\\Permalinks", "Minn\\Runtime\\Runtime" ], "usedBy": [ "Minn\\Admin\\AppController", "Minn\\Engine" ], "constructor": { "signature": "__construct(Minn\\Content\\Site $site, Minn\\Front\\Permalinks $permalinks, Minn\\Auth\\Capabilities $capabilities, Minn\\Admin\\App $app, string $engineVersion, Minn\\Admin\\Appearance $appearance, Minn\\Admin\\HiddenIntegrations $hidden, Minn\\Content\\SiteIcon $icon, bool $blockTheme = false, ?Minn\\Admin\\Translations $translations = NULL)", "doc": "", "shapes": [], "params": [ { "name": "site", "type": "Minn\\Content\\Site", "shape": "", "default": null, "doc": "" }, { "name": "permalinks", "type": "Minn\\Front\\Permalinks", "shape": "", "default": null, "doc": "" }, { "name": "capabilities", "type": "Minn\\Auth\\Capabilities", "shape": "", "default": null, "doc": "" }, { "name": "app", "type": "Minn\\Admin\\App", "shape": "", "default": null, "doc": "" }, { "name": "engineVersion", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "appearance", "type": "Minn\\Admin\\Appearance", "shape": "", "default": null, "doc": "" }, { "name": "hidden", "type": "Minn\\Admin\\HiddenIntegrations", "shape": "", "default": null, "doc": "" }, { "name": "icon", "type": "Minn\\Content\\SiteIcon", "shape": "", "default": null, "doc": "" }, { "name": "blockTheme", "type": "bool", "shape": "", "default": "false", "doc": "" }, { "name": "translations", "type": "?Minn\\Admin\\Translations", "shape": "", "default": "NULL", "doc": "" } ], "visibility": "public", "line": 26, "end": 38 }, "cases": [], "constants": [ { "name": "PLUGIN_KEYS_WITHHELD", "value": "array ( 0 => 'notices', )", "doc": "Boot keys the plugin computes that point the app at wp-admin pages the engine does not serve.", "visibility": "private" } ], "properties": [ { "name": "site", "type": "Minn\\Content\\Site", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "permalinks", "type": "Minn\\Front\\Permalinks", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "capabilities", "type": "Minn\\Auth\\Capabilities", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "app", "type": "Minn\\Admin\\App", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "engineVersion", "type": "string", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "appearance", "type": "Minn\\Admin\\Appearance", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "hidden", "type": "Minn\\Admin\\HiddenIntegrations", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "icon", "type": "Minn\\Content\\SiteIcon", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "blockTheme", "type": "bool", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "translations", "type": "?Minn\\Admin\\Translations", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [], "name": "siteName", "static": false, "visibility": "public", "signature": "siteName(): string", "doc": "The site's name, or Site when it has none.", "shapes": [], "params": [], "line": 41, "end": 44 }, { "routes": [], "name": "build", "static": false, "visibility": "public", "signature": "build(Minn\\Auth\\Authenticated $session): array", "doc": "The window.MINN payload the app boots from, for one signed-in session.", "shapes": [], "params": [ { "name": "session", "type": "Minn\\Auth\\Authenticated", "shape": "", "default": null, "doc": "" } ], "line": 47, "end": 88 }, { "routes": [], "name": "userSlice", "static": false, "visibility": "private", "signature": "userSlice(Minn\\Auth\\Authenticated $session, string $role): array", "doc": "", "shapes": [ "@return array" ], "params": [ { "name": "session", "type": "Minn\\Auth\\Authenticated", "shape": "", "default": null, "doc": "" }, { "name": "role", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 91, "end": 105 }, { "routes": [], "name": "siteSlice", "static": false, "visibility": "private", "signature": "siteSlice(): array", "doc": "", "shapes": [ "@return array" ], "params": [], "line": 108, "end": 126 }, { "routes": [], "name": "commerce", "static": true, "visibility": "private", "signature": "commerce(?array $plugin): bool", "doc": "Whether WooCommerce is running: the plugin's own answer when it gave one,\nelse whether the runtime loaded the class.", "shapes": [ "@param array|null $plugin" ], "params": [ { "name": "plugin", "type": "?array", "shape": "array|null", "default": null, "doc": "" } ], "line": 134, "end": 137 }, { "routes": [], "name": "caps", "static": false, "visibility": "private", "signature": "caps(int $userId, ?array $plugin): array", "doc": "What the app may show, each key a capability the reference gates the\nsame view on. The commerce caps mirror the plugin's own conditions:\nWC loaded, the WC capability, and for coupons the store having them enabled.", "shapes": [ "@return array" ], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "plugin", "type": "?array", "shape": "", "default": null, "doc": "" } ], "line": 146, "end": 196 }, { "routes": [], "name": "pluginPayload", "static": false, "visibility": "private", "signature": "pluginPayload(): ?array", "doc": "What Minn Admin's own boot_payload() computes when the plugin runs as\ncode on the runtime, so the app boots with the same keys on both\nstacks (connectors, discussion defaults, roles, post formats, the\nadapter flags). Engine-owned keys win; the withheld ones would send\nthe app to a wp-admin page the engine does not have.", "shapes": [], "params": [], "line": 205, "end": 218 }, { "routes": [], "name": "standHomeQuery", "static": false, "visibility": "private", "signature": "standHomeQuery(): void", "doc": "The reference serves the app shell from the home query, so the global\npost is the newest post while the payload is built; the comments\nfeature check reads it through the comments_open filter (a site that\ncloses comments on old posts reports the feature off when its newest\npost is old).", "shapes": [], "params": [], "line": 227, "end": 238 }, { "routes": [], "name": "adapterSlices", "static": false, "visibility": "private", "signature": "adapterSlices(): array", "doc": "What Minn Admin's own adapters contribute when the plugin runs as code\non the runtime: plugin surfaces (Tools), editor panels, design\nsources, editor commands, block forms. Absent, the app's fallbacks apply.", "shapes": [], "params": [], "line": 245, "end": 264 } ] }, { "name": "Minn\\Admin\\BundleController", "short": "BundleController", "namespace": "Minn\\Admin", "kind": "final readonly class", "file": "public/minn/src/Minn/Admin/BundleController.php", "lines": 45, "doc": "What the app bundle answers for: the user guide it carries, the\ntranslation offers (none: the engine polls no translation channel), and\nthe two changelogs, Minn Admin's and the engine's, read from GitHub\nbecause a release carries neither.", "implements": [], "extends": null, "uses": [ "Minn\\Admin\\App", "Minn\\Http\\Access", "Minn\\Http\\Method", "Minn\\Http\\Policy", "Minn\\Http\\Request", "Minn\\Http\\Response", "Minn\\Http\\Route", "Minn\\Ops\\Changelog", "Minn\\Rest\\Caller", "Minn\\Rest\\Reply" ], "usedBy": [ "Minn\\Rest\\Api" ], "constructor": { "signature": "__construct(Minn\\Admin\\App $app, Minn\\Rest\\Caller $caller, Minn\\Ops\\Changelog $adminChangelog, Minn\\Ops\\Changelog $engineChangelog)", "doc": "", "shapes": [], "params": [ { "name": "app", "type": "Minn\\Admin\\App", "shape": "", "default": null, "doc": "" }, { "name": "caller", "type": "Minn\\Rest\\Caller", "shape": "", "default": null, "doc": "" }, { "name": "adminChangelog", "type": "Minn\\Ops\\Changelog", "shape": "", "default": null, "doc": "" }, { "name": "engineChangelog", "type": "Minn\\Ops\\Changelog", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 25, "end": 31 }, "cases": [], "constants": [], "properties": [ { "name": "app", "type": "Minn\\Admin\\App", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "caller", "type": "Minn\\Rest\\Caller", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "adminChangelog", "type": "Minn\\Ops\\Changelog", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "engineChangelog", "type": "Minn\\Ops\\Changelog", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [ "GET /minn-admin/v1/translations (floor edit_posts)" ], "name": "translations", "static": false, "visibility": "public", "signature": "translations(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "The translation offers; none on the engine.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 35, "end": 38 }, { "routes": [ "GET /minn-admin/v1/changelog (floor edit_posts)" ], "name": "changelog", "static": false, "visibility": "public", "signature": "changelog(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "Minn Admin's changelog, released sections only, beside the bundle's version.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 42, "end": 45 }, { "routes": [ "GET /minn-admin/v1/engine-changelog (floor edit_posts)" ], "name": "engineChangelog", "static": false, "visibility": "public", "signature": "engineChangelog(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "The engine's own changelog, kept in its repository and not in a release, shown beside the app's on Minn.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 49, "end": 52 }, { "routes": [ "GET /minn-admin/v1/guide (floor edit_posts)" ], "name": "guide", "static": false, "visibility": "public", "signature": "guide(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "The app's bundled user guide.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 56, "end": 59 }, { "routes": [], "name": "bundled", "static": false, "visibility": "private", "signature": "bundled(string $relative): array", "doc": "", "shapes": [ "@return array{version: string, markdown: string}" ], "params": [ { "name": "relative", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 62, "end": 66 } ] }, { "name": "Minn\\Admin\\Dashboard", "short": "Dashboard", "namespace": "Minn\\Admin", "kind": "final readonly class", "file": "public/minn/src/Minn/Admin/Dashboard.php", "lines": 273, "doc": "The overview payload: stat cards, the activity chart, and the recent\nactivity feed, plus the per-bar activity drill-down.", "implements": [], "extends": null, "uses": [ "Minn\\Admin\\ActivityChart", "Minn\\Admin\\ActivityFeed", "Minn\\Admin\\Format", "Minn\\Admin\\UploadsSize", "Minn\\Auth\\Capabilities", "Minn\\Content\\Site", "Minn\\Content\\Users", "Minn\\Db", "Minn\\Support\\Serialized" ], "usedBy": [ "Minn\\Admin\\OverviewController", "Minn\\Rest\\Services" ], "constructor": { "signature": "__construct(Minn\\Db $db, Minn\\Content\\Site $site, Minn\\Content\\Users $users, Minn\\Auth\\Capabilities $capabilities, Minn\\Admin\\ActivityChart $chart, Minn\\Admin\\ActivityFeed $feed, string $uploadsDir)", "doc": "", "shapes": [], "params": [ { "name": "db", "type": "Minn\\Db", "shape": "", "default": null, "doc": "" }, { "name": "site", "type": "Minn\\Content\\Site", "shape": "", "default": null, "doc": "" }, { "name": "users", "type": "Minn\\Content\\Users", "shape": "", "default": null, "doc": "" }, { "name": "capabilities", "type": "Minn\\Auth\\Capabilities", "shape": "", "default": null, "doc": "" }, { "name": "chart", "type": "Minn\\Admin\\ActivityChart", "shape": "", "default": null, "doc": "" }, { "name": "feed", "type": "Minn\\Admin\\ActivityFeed", "shape": "", "default": null, "doc": "" }, { "name": "uploadsDir", "type": "string", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 19, "end": 28 }, "cases": [], "constants": [], "properties": [ { "name": "db", "type": "Minn\\Db", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "site", "type": "Minn\\Content\\Site", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "users", "type": "Minn\\Content\\Users", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "capabilities", "type": "Minn\\Auth\\Capabilities", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "chart", "type": "Minn\\Admin\\ActivityChart", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "feed", "type": "Minn\\Admin\\ActivityFeed", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "uploadsDir", "type": "string", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [], "name": "overview", "static": false, "visibility": "public", "signature": "overview(int $userId, int $days): array", "doc": "The stat cards, the metric catalog and layout, the chart, and the feed.", "shapes": [], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "days", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 31, "end": 65 }, { "routes": [], "name": "metricLayout", "static": false, "visibility": "public", "signature": "metricLayout(int $userId, array $catalog, array $stats): array", "doc": "Which cards show: the user's saved picks over the site default over\nthe built-in layout, unknown keys dropped and slots refilled.", "shapes": [ "@param list $catalog", "@param list $stats", "@return array{keys: list, defaults: list, custom: bool}" ], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "catalog", "type": "array", "shape": "list", "default": null, "doc": "" }, { "name": "stats", "type": "array", "shape": "list", "default": null, "doc": "" } ], "line": 172, "end": 190 }, { "routes": [], "name": "cleanMetricKeys", "static": true, "visibility": "public", "signature": "cleanMetricKeys(mixed $keys): array", "doc": "At most six unique sanitize_key metric ids; anything else drops.", "shapes": [], "params": [ { "name": "keys", "type": "mixed", "shape": "", "default": null, "doc": "" } ], "line": 193, "end": 213 }, { "routes": [], "name": "activity", "static": false, "visibility": "public", "signature": "activity(int $userId, string $from, string $to): array", "doc": "The events behind one chart bar, (from, to] GMT.", "shapes": [], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "from", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "to", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 260, "end": 263 }, { "routes": [], "name": "postsCard", "static": false, "visibility": "private", "signature": "postsCard(array $posts, int $userId): array", "doc": "", "shapes": [ "@param array $posts" ], "params": [ { "name": "posts", "type": "array", "shape": "array", "default": null, "doc": "" }, { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 68, "end": 82 }, { "routes": [], "name": "pagesCard", "static": false, "visibility": "private", "signature": "pagesCard(array $pages): array", "doc": "", "shapes": [ "@param array $pages" ], "params": [ { "name": "pages", "type": "array", "shape": "array", "default": null, "doc": "" } ], "line": 85, "end": 88 }, { "routes": [], "name": "usersCard", "static": false, "visibility": "private", "signature": "usersCard(): array", "doc": "", "shapes": [], "params": [], "line": 90, "end": 93 }, { "routes": [], "name": "commentsCard", "static": false, "visibility": "private", "signature": "commentsCard(array $comments, int $userId): array", "doc": "", "shapes": [ "@param array $comments" ], "params": [ { "name": "comments", "type": "array", "shape": "array", "default": null, "doc": "" }, { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 96, "end": 109 }, { "routes": [], "name": "mediaCard", "static": false, "visibility": "private", "signature": "mediaCard(array $media, int $userId): array", "doc": "", "shapes": [ "@param array $media" ], "params": [ { "name": "media", "type": "array", "shape": "array", "default": null, "doc": "" }, { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 112, "end": 116 }, { "routes": [], "name": "metricCatalog", "static": false, "visibility": "private", "signature": "metricCatalog(int $userId, array $stats, array $posts, array $pages, array $comments, array $media): array", "doc": "The full metric catalog behind the Overview cards: the default layout\nfirst, then every cap-gated card the caller may pick. The store group\nneeds the WooCommerce runtime and is honestly absent.", "shapes": [ "@param list $stats", "@param array $posts", "@param array $pages", "@param array $comments", "@param array $media", "@return list" ], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "stats", "type": "array", "shape": "list", "default": null, "doc": "" }, { "name": "posts", "type": "array", "shape": "array", "default": null, "doc": "" }, { "name": "pages", "type": "array", "shape": "array", "default": null, "doc": "" }, { "name": "comments", "type": "array", "shape": "array", "default": null, "doc": "" }, { "name": "media", "type": "array", "shape": "array", "default": null, "doc": "" } ], "line": 130, "end": 162 }, { "routes": [], "name": "overlayMetricKeys", "static": true, "visibility": "private", "signature": "overlayMetricKeys(array $saved, array $fallback, array $allowed): array", "doc": "Overlay saved keys onto a fallback of the same length, dropping keys\noutside $allowed and de-duplicating left to right.", "shapes": [ "@param list $saved", "@param list $fallback", "@param array $allowed", "@return list" ], "params": [ { "name": "saved", "type": "array", "shape": "list", "default": null, "doc": "" }, { "name": "fallback", "type": "array", "shape": "list", "default": null, "doc": "" }, { "name": "allowed", "type": "array", "shape": "array", "default": null, "doc": "" } ], "line": 224, "end": 257 }, { "routes": [], "name": "statusCounts", "static": false, "visibility": "private", "signature": "statusCounts(string $type): array", "doc": "", "shapes": [ "@return array counts by status for one post type" ], "params": [ { "name": "type", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 266, "end": 274 }, { "routes": [], "name": "commentCounts", "static": false, "visibility": "private", "signature": "commentCounts(): array", "doc": "", "shapes": [ "@return array{approved: int, moderated: int}" ], "params": [], "line": 277, "end": 288 } ] }, { "name": "Minn\\Admin\\EditorController", "short": "EditorController", "namespace": "Minn\\Admin", "kind": "final readonly class", "file": "public/minn/src/Minn/Admin/EditorController.php", "lines": 45, "doc": "The editor's helpers in minn-admin/v1: the edit lock, and the template\nand pattern lists (honestly empty: the engine carries no theme content).", "implements": [], "extends": null, "uses": [ "Minn\\Content\\PostWriter", "Minn\\Http\\Access", "Minn\\Http\\Method", "Minn\\Http\\Policy", "Minn\\Http\\Request", "Minn\\Http\\Response", "Minn\\Http\\Route", "Minn\\RestError", "Minn\\Rest\\Caller", "Minn\\Rest\\Reply" ], "usedBy": [ "Minn\\Rest\\Api" ], "constructor": { "signature": "__construct(Minn\\Content\\PostWriter $writer, Minn\\Rest\\Caller $caller)", "doc": "", "shapes": [], "params": [ { "name": "writer", "type": "Minn\\Content\\PostWriter", "shape": "", "default": null, "doc": "" }, { "name": "caller", "type": "Minn\\Rest\\Caller", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 24, "end": 28 }, "cases": [], "constants": [], "properties": [ { "name": "writer", "type": "Minn\\Content\\PostWriter", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "caller", "type": "Minn\\Rest\\Caller", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [ "POST /minn-admin/v1/posts/{id:\\d+}/lock (floor edit_posts)" ], "name": "lock", "static": false, "visibility": "public", "signature": "lock(Minn\\Http\\Request $request, string $id): Minn\\Http\\Response", "doc": "Takes the edit lock on a post.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" }, { "name": "id", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 32, "end": 40 }, { "routes": [ "POST /minn-admin/v1/posts/{id:\\d+}/unlock (floor edit_posts)" ], "name": "unlock", "static": false, "visibility": "public", "signature": "unlock(Minn\\Http\\Request $request, string $id): Minn\\Http\\Response", "doc": "Releases the edit lock on a post.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" }, { "name": "id", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 44, "end": 51 }, { "routes": [ "GET /minn-admin/v1/templates (floor edit_posts)" ], "name": "templates", "static": false, "visibility": "public", "signature": "templates(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "No theme, no page templates: an honest empty set.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 55, "end": 58 }, { "routes": [ "GET /minn-admin/v1/patterns (floor edit_posts)" ], "name": "patterns", "static": false, "visibility": "public", "signature": "patterns(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "Theme patterns are GPL theme content the engine does not carry.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 62, "end": 65 } ] }, { "name": "Minn\\Admin\\Format", "short": "Format", "namespace": "Minn\\Admin", "kind": "final class", "file": "public/minn/src/Minn/Admin/Format.php", "lines": 51, "doc": "The dashboard's number, size, age, and title formatting.", "implements": [], "extends": null, "uses": [ "Minn\\Content\\Texturize" ], "usedBy": [ "Minn\\Admin\\ActivityFeed", "Minn\\Admin\\Dashboard", "Minn\\Admin\\Notifications", "Minn\\Admin\\UploadsSize", "Minn\\Blocks\\Dynamic\\TagCloud", "Minn\\Blocks\\Dynamic\\Theme\\Comments" ], "constructor": null, "cases": [], "constants": [], "properties": [], "methods": [ { "routes": [], "name": "number", "static": true, "visibility": "public", "signature": "number(int|float $value, int $decimals = 0): string", "doc": "number_format_i18n for the default locale: comma thousands.", "shapes": [], "params": [ { "name": "value", "type": "int|float", "shape": "", "default": null, "doc": "" }, { "name": "decimals", "type": "int", "shape": "", "default": "0", "doc": "" } ], "line": 13, "end": 16 }, { "routes": [], "name": "size", "static": true, "visibility": "public", "signature": "size(int $bytes): string", "doc": "size_format with one decimal: 1024-step units, comma thousands.", "shapes": [], "params": [ { "name": "bytes", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 19, "end": 27 }, { "routes": [], "name": "humanTimeDiff", "static": true, "visibility": "public", "signature": "humanTimeDiff(int $from, ?int $to = NULL): string", "doc": "Humanized age, pinned by an oracle capture table: each unit rounds,\nfloors at 1, and hands off at the next unit boundary.", "shapes": [], "params": [ { "name": "from", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "to", "type": "?int", "shape": "", "default": "NULL", "doc": "" } ], "line": 33, "end": 52 }, { "routes": [], "name": "plainTitle", "static": true, "visibility": "public", "signature": "plainTitle(string $raw): string", "doc": "A post title as the feed shows it: texturized, entities decoded, tags gone.", "shapes": [], "params": [ { "name": "raw", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 55, "end": 59 } ] }, { "name": "Minn\\Admin\\HiddenIntegrations", "short": "HiddenIntegrations", "namespace": "Minn\\Admin", "kind": "final readonly class", "file": "public/minn/src/Minn/Admin/HiddenIntegrations.php", "lines": 94, "doc": "What a person hid from their own Minn Admin: the app's per-user map\n(user meta minn_admin_hidden_integrations, \"kind:id\" => hidden-at) read\nand written in the app's own shape so a choice made under WordPress\nsurvives the swap and vice versa. The engine registers the core views\nas hideable; plugin surfaces, editor panels, design sources, and slash\nnamespaces have no registry here, so hiding one is refused as\nunregistered and a stored hide of one is simply not listed.", "implements": [], "extends": null, "uses": [ "Minn\\Auth\\Capabilities", "Minn\\Content\\Users", "Minn\\Support\\Serialized" ], "usedBy": [ "Minn\\Admin\\BootPayload", "Minn\\Admin\\PreferencesController", "Minn\\Engine", "Minn\\Rest\\Services" ], "constructor": { "signature": "__construct(Minn\\Content\\Users $users, Minn\\Auth\\Capabilities $capabilities)", "doc": "", "shapes": [], "params": [ { "name": "users", "type": "Minn\\Content\\Users", "shape": "", "default": null, "doc": "" }, { "name": "capabilities", "type": "Minn\\Auth\\Capabilities", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 48, "end": 50 }, "cases": [], "constants": [ { "name": "META", "value": "'minn_admin_hidden_integrations'", "doc": "", "visibility": "public" }, { "name": "CORE", "value": "array ( 'content' => array ( 0 => 'Content', 1 => 'edit_posts', ), 'media' => array ( 0 => 'Media', 1 => 'upload_files', ), 'comments' => array ( 0 => 'Comments', 1 => 'moderate_comments', ), 'orders' => array ( 0 => 'Orders', 1 => 'edit_shop_orders', ), 'subscriptions' => array ( 0 => 'Subscriptions', 1 => 'edit_shop_orders', ), 'products' => array ( 0 => 'Products', 1 => 'edit_products', ), 'coupons' => array ( 0 => 'Coupons', 1 => 'edit_shop_coupons', ), 'customers' => array ( 0 => 'Customers', 1 => 'list_users', ), 'users' => array ( 0 => 'Users', 1 => 'list_users', ), 'terms' => array ( 0 => 'Terms', 1 => 'manage_categories', ), 'menus' => array ( 0 => 'Menus', 1 => 'edit_theme_options', ), 'widgets' => array ( 0 => 'Widgets', 1 => 'edit_theme_options', ), 'posttypes' => array ( 0 => 'Structure', 1 => 'manage_options', ), 'extensions' => array ( 0 => 'Extensions', 1 => 'activate_plugins', ), 'database' => array ( 0 => 'Database', 1 => 'manage_options', ), 'system' => array ( 0 => 'System', 1 => 'manage_options', ), 'settings' => array ( 0 => 'Settings', 1 => 'manage_options', ), )", "doc": "Core view id => [label, the capability that shows the view].", "visibility": "public" }, { "name": "CAP", "value": "100", "doc": "Newest hides kept when the map is capped.", "visibility": "private" } ], "properties": [ { "name": "users", "type": "Minn\\Content\\Users", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "capabilities", "type": "Minn\\Auth\\Capabilities", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [], "name": "sanitize", "static": true, "visibility": "public", "signature": "sanitize(string $id): string", "doc": "The id as the app sends it: lower-case, only word characters, colon, and dash.", "shapes": [], "params": [ { "name": "id", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 53, "end": 56 }, { "routes": [], "name": "map", "static": false, "visibility": "public", "signature": "map(int $userId): array", "doc": "The views a user has hidden, by id.", "shapes": [ "@return array id => hidden-at" ], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 63, "end": 71 }, { "routes": [], "name": "listFor", "static": false, "visibility": "public", "signature": "listFor(int $userId): array", "doc": "The restore list: every hidden core view the person can still see. @return list", "shapes": [ "@return list" ], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 74, "end": 84 }, { "routes": [], "name": "hide", "static": false, "visibility": "public", "signature": "hide(int $userId, string $id): bool", "doc": "False when the id names nothing this person could hide.", "shapes": [], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "id", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 87, "end": 100 }, { "routes": [], "name": "unhide", "static": false, "visibility": "public", "signature": "unhide(int $userId, string $id): void", "doc": "Shows a hidden view again.", "shapes": [], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "id", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 103, "end": 112 } ] }, { "name": "Minn\\Admin\\LanguageChoices", "short": "LanguageChoices", "namespace": "Minn\\Admin", "kind": "final class", "file": "public/minn/src/Minn/Admin/LanguageChoices.php", "lines": 42, "doc": "The language picker's markup. English always leads the list and carries the\nempty value, because \"no locale\" and \"American English\" are the same choice.\nWhen the picker also offers what could be downloaded, the two halves split\ninto named groups; otherwise every option sits in one flat list.\n\nThe attribute order is not tidy and is not ours to tidy: the English option\ncarries `data-installed` before `selected`, an installed translation carries\nit after, and themes and plugins have been matching on that markup for\nyears.", "implements": [], "extends": null, "uses": [ "Minn\\Html" ], "usedBy": [], "constructor": null, "cases": [], "constants": [ { "name": "ENGLISH", "value": "'English (United States)'", "doc": "", "visibility": "private" } ], "properties": [], "methods": [ { "routes": [], "name": "dropdown", "static": true, "visibility": "public", "signature": "dropdown(string $name, string $id, array $installed, array $available, string $selected, bool $offerAvailable): string", "doc": "The language select's HTML, installed languages first.", "shapes": [ "@param list $installed locale codes the site already holds", "@param array}> $available every translation the directory offers, keyed by locale" ], "params": [ { "name": "name", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "id", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "installed", "type": "array", "shape": "list", "default": null, "doc": "locale codes the site already holds" }, { "name": "available", "type": "array", "shape": "array}>", "default": null, "doc": "every translation the directory offers, keyed by locale" }, { "name": "selected", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "offerAvailable", "type": "bool", "shape": "", "default": null, "doc": "" } ], "line": 30, "end": 49 }, { "routes": [], "name": "option", "static": true, "visibility": "private", "signature": "option(string $locale, array $translation, string $selected, bool $installed): string", "doc": "", "shapes": [ "@param array{native_name: string, iso: array} $translation" ], "params": [ { "name": "locale", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "translation", "type": "array", "shape": "array{native_name: string, iso: array}", "default": null, "doc": "" }, { "name": "selected", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "installed", "type": "bool", "shape": "", "default": null, "doc": "" } ], "line": 52, "end": 60 } ] }, { "name": "Minn\\Admin\\LanguageController", "short": "LanguageController", "namespace": "Minn\\Admin", "kind": "final readonly class", "file": "public/minn/src/Minn/Admin/LanguageController.php", "lines": 98, "doc": "Languages: what is installed, what a person reads in, what the site defaults to.", "implements": [], "extends": null, "uses": [ "Minn\\Admin\\Translations", "Minn\\Auth\\Capabilities", "Minn\\Content\\Site", "Minn\\Content\\Users", "Minn\\Http\\Access", "Minn\\Http\\Method", "Minn\\Http\\Policy", "Minn\\Http\\Request", "Minn\\Http\\Response", "Minn\\Http\\Route", "Minn\\RestError", "Minn\\Rest\\Caller", "Minn\\Rest\\Reply" ], "usedBy": [ "Minn\\Rest\\Api" ], "constructor": { "signature": "__construct(Minn\\Admin\\Translations $translations, Minn\\Content\\Users $users, Minn\\Content\\Site $site, Minn\\Auth\\Capabilities $capabilities, Minn\\Rest\\Caller $caller)", "doc": "", "shapes": [], "params": [ { "name": "translations", "type": "Minn\\Admin\\Translations", "shape": "", "default": null, "doc": "" }, { "name": "users", "type": "Minn\\Content\\Users", "shape": "", "default": null, "doc": "" }, { "name": "site", "type": "Minn\\Content\\Site", "shape": "", "default": null, "doc": "" }, { "name": "capabilities", "type": "Minn\\Auth\\Capabilities", "shape": "", "default": null, "doc": "" }, { "name": "caller", "type": "Minn\\Rest\\Caller", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 23, "end": 30 }, "cases": [], "constants": [], "properties": [ { "name": "translations", "type": "Minn\\Admin\\Translations", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "users", "type": "Minn\\Content\\Users", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "site", "type": "Minn\\Content\\Site", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "capabilities", "type": "Minn\\Auth\\Capabilities", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "caller", "type": "Minn\\Rest\\Caller", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [ "GET /minn-admin/v1/languages (floor edit_posts)" ], "name": "languages", "static": false, "visibility": "public", "signature": "languages(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "The languages a user may pick, installed and available.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 34, "end": 42 }, { "routes": [ "GET /minn-admin/v1/boot-locale (floor edit_posts)" ], "name": "bootLocale", "static": false, "visibility": "public", "signature": "bootLocale(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "The slice of the boot payload a language switch repaints from.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 46, "end": 59 }, { "routes": [ "POST /minn-admin/v1/me/language (floor edit_posts)" ], "name": "mine", "static": false, "visibility": "public", "signature": "mine(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "Sets the caller's own locale.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 63, "end": 66 }, { "routes": [ "POST /minn-admin/v1/users/{id:\\d+}/language (floor edit_posts)" ], "name": "user", "static": false, "visibility": "public", "signature": "user(Minn\\Http\\Request $request, string $id): Minn\\Http\\Response", "doc": "Sets another user's locale.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" }, { "name": "id", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 70, "end": 80 }, { "routes": [ "POST /minn-admin/v1/site/language (floor edit_posts + manage_options)" ], "name": "site", "static": false, "visibility": "public", "signature": "site(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "Sets the site's locale.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 84, "end": 89 }, { "routes": [], "name": "setUserLocale", "static": false, "visibility": "private", "signature": "setUserLocale(Minn\\Http\\Request $request, int $userId): Minn\\Http\\Response", "doc": "", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" }, { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 91, "end": 100 }, { "routes": [], "name": "ensure", "static": false, "visibility": "private", "signature": "ensure(Minn\\Http\\Request $request): array", "doc": "The requested locale, installed if it was not; '' means the site default. @return array{0: string, 1: bool}", "shapes": [ "@return array{0: string, 1: bool}" ], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 103, "end": 116 } ] }, { "name": "Minn\\Admin\\Notifications", "short": "Notifications", "namespace": "Minn\\Admin", "kind": "final readonly class", "file": "public/minn/src/Minn/Admin/Notifications.php", "lines": 191, "doc": "The bell feed: pending and recent comments, translation offers and a\nnewer Minn, and new registrations. Plugin and theme update rows need an\nextension inventory the engine does not have\n(a recorded gap); on the reference database those sections are empty,\nso parity holds by construction.", "implements": [], "extends": null, "uses": [ "Minn\\Admin\\ActivityFeed", "Minn\\Admin\\Format", "Minn\\Auth\\Capabilities", "Minn\\Content\\CommentRecord", "Minn\\Content\\Site", "Minn\\Content\\Texturize", "Minn\\Content\\Users", "Minn\\Db", "Minn\\Ops\\Releases", "Minn\\Ops\\Updates", "Minn\\Support\\Serialized" ], "usedBy": [ "Minn\\Admin\\V1Controller", "Minn\\Rest\\Services" ], "constructor": { "signature": "__construct(Minn\\Db $db, Minn\\Content\\Site $site, Minn\\Content\\Users $users, Minn\\Auth\\Capabilities $capabilities, Minn\\Admin\\ActivityFeed $feed, Minn\\Ops\\Updates $updates, Minn\\Ops\\Releases $releases)", "doc": "", "shapes": [], "params": [ { "name": "db", "type": "Minn\\Db", "shape": "", "default": null, "doc": "" }, { "name": "site", "type": "Minn\\Content\\Site", "shape": "", "default": null, "doc": "" }, { "name": "users", "type": "Minn\\Content\\Users", "shape": "", "default": null, "doc": "" }, { "name": "capabilities", "type": "Minn\\Auth\\Capabilities", "shape": "", "default": null, "doc": "" }, { "name": "feed", "type": "Minn\\Admin\\ActivityFeed", "shape": "", "default": null, "doc": "" }, { "name": "updates", "type": "Minn\\Ops\\Updates", "shape": "", "default": null, "doc": "" }, { "name": "releases", "type": "Minn\\Ops\\Releases", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 26, "end": 35 }, "cases": [], "constants": [], "properties": [ { "name": "db", "type": "Minn\\Db", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "site", "type": "Minn\\Content\\Site", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "users", "type": "Minn\\Content\\Users", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "capabilities", "type": "Minn\\Auth\\Capabilities", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "feed", "type": "Minn\\Admin\\ActivityFeed", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "updates", "type": "Minn\\Ops\\Updates", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "releases", "type": "Minn\\Ops\\Releases", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [], "name": "items", "static": false, "visibility": "public", "signature": "items(int $userId): array", "doc": "The bell feed for a user, newest first, grouped and marked read or unread.", "shapes": [], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 38, "end": 60 }, { "routes": [], "name": "markRead", "static": false, "visibility": "public", "signature": "markRead(int $userId, string $id): void", "doc": "An id marks one item read; an empty id marks everything read.", "shapes": [], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "id", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 174, "end": 185 }, { "routes": [], "name": "commentItems", "static": false, "visibility": "private", "signature": "commentItems(int $userId): array", "doc": "Up to five pending comments for a moderator, then the three latest\napproved ones, each only when its post is visible to the caller.", "shapes": [ "@return list" ], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 68, "end": 88 }, { "routes": [], "name": "updateItems", "static": false, "visibility": "private", "signature": "updateItems(int $userId, int $now): array", "doc": "Plugin and theme offers for a caller who may apply them, stamped with\nthe last check, then the translation total.", "shapes": [ "@return list" ], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "now", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 96, "end": 125 }, { "routes": [], "name": "updateItem", "static": true, "visibility": "private", "signature": "updateItem(string $id, string $title, int $time, array $update): array", "doc": "", "shapes": [], "params": [ { "name": "id", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "title", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "time", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "update", "type": "array", "shape": "", "default": null, "doc": "" } ], "line": 127, "end": 130 }, { "routes": [], "name": "coreItems", "static": false, "visibility": "private", "signature": "coreItems(int $userId, int $now): array", "doc": "A newer Minn on offer (Ops\\Releases). WordPress's own core offer and\nits auto-update notice are not shown: on Minn they could only speak\nof a parked copy, which is not what serves the site.", "shapes": [ "@return list" ], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "now", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 139, "end": 153 }, { "routes": [], "name": "registrationItems", "static": false, "visibility": "private", "signature": "registrationItems(int $userId, int $now, int $offset): array", "doc": "The two newest registrations of the last week, for a caller who lists users.", "shapes": [ "@return list" ], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "now", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "offset", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 160, "end": 171 }, { "routes": [], "name": "commentItem", "static": false, "visibility": "private", "signature": "commentItem(Minn\\Content\\CommentRecord|array $comment, string $template): array", "doc": "", "shapes": [], "params": [ { "name": "comment", "type": "Minn\\Content\\CommentRecord|array", "shape": "", "default": null, "doc": "" }, { "name": "template", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 187, "end": 200 }, { "routes": [], "name": "translationCount", "static": false, "visibility": "private", "signature": "translationCount(): int", "doc": "Total translation offers across the three update transients.", "shapes": [], "params": [], "line": 203, "end": 213 } ] }, { "name": "Minn\\Admin\\OverviewController", "short": "OverviewController", "namespace": "Minn\\Admin", "kind": "final readonly class", "file": "public/minn/src/Minn/Admin/OverviewController.php", "lines": 140, "doc": "The Overview of minn-admin/v1: the payload, the drill-down behind one\nchart bar, and the pick of cards, the person's own and the site's default.", "implements": [], "extends": null, "uses": [ "Minn\\Admin\\Dashboard", "Minn\\Content\\Site", "Minn\\Content\\Users", "Minn\\Db", "Minn\\Http\\Access", "Minn\\Http\\Method", "Minn\\Http\\Policy", "Minn\\Http\\Request", "Minn\\Http\\Response", "Minn\\Http\\Route", "Minn\\RestError", "Minn\\Rest\\Caller", "Minn\\Rest\\Reply", "Minn\\Support\\Serialized" ], "usedBy": [ "Minn\\Rest\\Api" ], "constructor": { "signature": "__construct(Minn\\Db $db, Minn\\Content\\Site $site, Minn\\Admin\\Dashboard $dashboard, Minn\\Content\\Users $users, Minn\\Rest\\Caller $caller)", "doc": "", "shapes": [], "params": [ { "name": "db", "type": "Minn\\Db", "shape": "", "default": null, "doc": "" }, { "name": "site", "type": "Minn\\Content\\Site", "shape": "", "default": null, "doc": "" }, { "name": "dashboard", "type": "Minn\\Admin\\Dashboard", "shape": "", "default": null, "doc": "" }, { "name": "users", "type": "Minn\\Content\\Users", "shape": "", "default": null, "doc": "" }, { "name": "caller", "type": "Minn\\Rest\\Caller", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 27, "end": 34 }, "cases": [], "constants": [], "properties": [ { "name": "db", "type": "Minn\\Db", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "site", "type": "Minn\\Content\\Site", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "dashboard", "type": "Minn\\Admin\\Dashboard", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "users", "type": "Minn\\Content\\Users", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "caller", "type": "Minn\\Rest\\Caller", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [ "GET /minn-admin/v1/overview (floor edit_posts)" ], "name": "overview", "static": false, "visibility": "public", "signature": "overview(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "The overview payload.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 38, "end": 42 }, { "routes": [ "GET /minn-admin/v1/overview/activity (floor edit_posts)" ], "name": "overviewActivity", "static": false, "visibility": "public", "signature": "overviewActivity(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "The events behind one chart bar.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 46, "end": 51 }, { "routes": [ "POST /minn-admin/v1/overview/metrics (floor edit_posts)" ], "name": "setOverviewMetrics", "static": false, "visibility": "public", "signature": "setOverviewMetrics(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "Saves the caller's pick of overview cards.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 55, "end": 65 }, { "routes": [ "POST /minn-admin/v1/overview/metric-defaults (floor edit_posts + manage_options)" ], "name": "setOverviewMetricDefaults", "static": false, "visibility": "public", "signature": "setOverviewMetricDefaults(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "Saves the site's default overview cards.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 69, "end": 79 }, { "routes": [], "name": "metricKeysFrom", "static": false, "visibility": "private", "signature": "metricKeysFrom(Minn\\Http\\Request $request): ?array", "doc": "The cleaned keys, null when the caller asked for a clear; a missing or non-list keys member refuses.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 82, "end": 96 }, { "routes": [], "name": "storedMetricLayout", "static": false, "visibility": "private", "signature": "storedMetricLayout(int $userId): array", "doc": "The stored layout, unfiltered by the catalog, so a save answers without a second Overview round trip.", "shapes": [], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 99, "end": 111 }, { "routes": [], "name": "days", "static": false, "visibility": "private", "signature": "days(Minn\\Http\\Request $request): int", "doc": "?days must be an in-range integer; the reference's parameter errors otherwise.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 114, "end": 128 }, { "routes": [], "name": "window", "static": false, "visibility": "private", "signature": "window(Minn\\Http\\Request $request): array", "doc": "Both bounds required, \"Y-m-d H:i:s\". @return array{0: string, 1: string}", "shapes": [ "@return array{0: string, 1: string}" ], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 131, "end": 155 }, { "routes": [], "name": "parameterError", "static": true, "visibility": "private", "signature": "parameterError(string $param, string $code, string $message, mixed $data): Minn\\RestError", "doc": "", "shapes": [], "params": [ { "name": "param", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "code", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "message", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "data", "type": "mixed", "shape": "", "default": null, "doc": "" } ], "line": 157, "end": 163 } ] }, { "name": "Minn\\Admin\\PackagesController", "short": "PackagesController", "namespace": "Minn\\Admin", "kind": "final readonly class", "file": "public/minn/src/Minn/Admin/PackagesController.php", "lines": 113, "doc": "Adding and removing themes and extensions from the Extensions view.", "implements": [], "extends": null, "uses": [ "Minn\\Content\\Site", "Minn\\Http\\Access", "Minn\\Http\\Method", "Minn\\Http\\Policy", "Minn\\Http\\Request", "Minn\\Http\\Response", "Minn\\Http\\Route", "Minn\\Json", "Minn\\Ops\\Packages", "Minn\\RestError", "Minn\\Rest\\Caller", "Minn\\Rest\\Reply", "Minn\\Runtime\\Runtime", "Minn\\Runtime\\ThemeSwitch" ], "usedBy": [ "Minn\\Rest\\Api" ], "constructor": { "signature": "__construct(Minn\\Ops\\Packages $packages, Minn\\Content\\Site $site, Minn\\Rest\\Caller $caller)", "doc": "", "shapes": [], "params": [ { "name": "packages", "type": "Minn\\Ops\\Packages", "shape": "", "default": null, "doc": "" }, { "name": "site", "type": "Minn\\Content\\Site", "shape": "", "default": null, "doc": "" }, { "name": "caller", "type": "Minn\\Rest\\Caller", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 25, "end": 27 }, "cases": [], "constants": [], "properties": [ { "name": "packages", "type": "Minn\\Ops\\Packages", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "site", "type": "Minn\\Content\\Site", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "caller", "type": "Minn\\Rest\\Caller", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [ "GET /minn-admin/v1/themes/search (floor edit_posts + install_themes)" ], "name": "searchThemes", "static": false, "visibility": "public", "signature": "searchThemes(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "Searches the theme directory.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 31, "end": 34 }, { "routes": [ "POST /minn-admin/v1/themes/install (floor edit_posts + install_themes)" ], "name": "installTheme", "static": false, "visibility": "public", "signature": "installTheme(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "Installs a theme from the directory by slug.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 38, "end": 42 }, { "routes": [ "POST /minn-admin/v1/themes/upload (floor edit_posts + install_themes)" ], "name": "uploadTheme", "static": false, "visibility": "public", "signature": "uploadTheme(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "Installs a theme from an uploaded zip.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 46, "end": 50 }, { "routes": [ "POST /minn-admin/v1/themes/delete (floor edit_posts + delete_themes)" ], "name": "deleteTheme", "static": false, "visibility": "public", "signature": "deleteTheme(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "Deletes an inactive theme.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 54, "end": 67 }, { "routes": [ "POST /minn-admin/v1/plugins/upload (floor edit_posts + install_plugins)" ], "name": "uploadPlugin", "static": false, "visibility": "public", "signature": "uploadPlugin(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "A plugin zip: a WordPress plugin or a Minn extension.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 71, "end": 75 }, { "routes": [ "POST /minn-admin/v1/plugins/install-url (floor edit_posts + install_plugins)" ], "name": "installFromUrl", "static": false, "visibility": "public", "signature": "installFromUrl(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "A zip URL, or a GitHub owner/repo whose latest release carries a zip asset.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 79, "end": 107 }, { "routes": [ "GET /minn-admin/v1/plugins/search (floor edit_posts + install_plugins)" ], "name": "searchPlugins", "static": false, "visibility": "public", "signature": "searchPlugins(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "Searches the plugin directory.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 111, "end": 114 }, { "routes": [ "GET /minn-admin/v1/plugins/info (floor edit_posts + install_plugins)" ], "name": "pluginInfo", "static": false, "visibility": "public", "signature": "pluginInfo(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "One directory plugin's details.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 118, "end": 121 }, { "routes": [], "name": "uploaded", "static": false, "visibility": "private", "signature": "uploaded(Minn\\Http\\Request $request, string $kind): string", "doc": "", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" }, { "name": "kind", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 123, "end": 133 } ] }, { "name": "Minn\\Admin\\PostListMarkup", "short": "PostListMarkup", "namespace": "Minn\\Admin", "kind": "final class", "file": "public/minn/src/Minn/Admin/PostListMarkup.php", "lines": 39, "doc": "The markup a post list writes beside each post, as the reference writes\nit (probe placeholders-admin): the states after a title (an em dash,\nthen each state in its span, a comma inside every span but the last),\nand the hidden fields quick edit reads, one div each, in its order.", "implements": [], "extends": null, "uses": [], "usedBy": [], "constructor": null, "cases": [], "constants": [], "properties": [], "methods": [ { "routes": [], "name": "states", "static": true, "visibility": "public", "signature": "states(array $states): string", "doc": "The states after a post's title, or nothing when it has none.", "shapes": [ "@param array $states" ], "params": [ { "name": "states", "type": "array", "shape": "array", "default": null, "doc": "" } ], "line": 20, "end": 31 }, { "routes": [], "name": "inline", "static": true, "visibility": "public", "signature": "inline(int $id, array $post, string $more): string", "doc": "The quick edit fields: the escaped title and slug, the author, the two\ndiscussion statuses, the status, the date in its six parts and the\npassword, then what the caller adds (parent, template, order, terms,\nsticky, format) unbroken, and the closing tag.", "shapes": [ "@param array{title: string, name: string, author: int, comments: string, pings: string, status: string, date: string, password: string} $post" ], "params": [ { "name": "id", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "post", "type": "array", "shape": "array{title: string, name: string, author: int, comments: string, pings: string, status: string, date: string, password: string}", "default": null, "doc": "" }, { "name": "more", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 41, "end": 50 } ] }, { "name": "Minn\\Admin\\PreferencesController", "short": "PreferencesController", "namespace": "Minn\\Admin", "kind": "final readonly class", "file": "public/minn/src/Minn/Admin/PreferencesController.php", "lines": 115, "doc": "A person's own settings in minn-admin/v1: their appearance, the views\nthey hid, and an administrator's reach into another person's, for the\nuser edit page.", "implements": [], "extends": null, "uses": [ "Minn\\Admin\\Appearance", "Minn\\Admin\\HiddenIntegrations", "Minn\\Http\\Access", "Minn\\Http\\Method", "Minn\\Http\\Policy", "Minn\\Http\\Request", "Minn\\Http\\Response", "Minn\\Http\\Route", "Minn\\RestError", "Minn\\Rest\\Caller", "Minn\\Rest\\Reply" ], "usedBy": [ "Minn\\Rest\\Api" ], "constructor": { "signature": "__construct(Minn\\Admin\\Appearance $appearance, Minn\\Admin\\HiddenIntegrations $hiddenIntegrations, Minn\\Rest\\Caller $caller)", "doc": "", "shapes": [], "params": [ { "name": "appearance", "type": "Minn\\Admin\\Appearance", "shape": "", "default": null, "doc": "" }, { "name": "hiddenIntegrations", "type": "Minn\\Admin\\HiddenIntegrations", "shape": "", "default": null, "doc": "" }, { "name": "caller", "type": "Minn\\Rest\\Caller", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 24, "end": 29 }, "cases": [], "constants": [], "properties": [ { "name": "appearance", "type": "Minn\\Admin\\Appearance", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "hiddenIntegrations", "type": "Minn\\Admin\\HiddenIntegrations", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "caller", "type": "Minn\\Rest\\Caller", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [ "GET /minn-admin/v1/me/appearance (floor edit_posts)" ], "name": "myAppearance", "static": false, "visibility": "public", "signature": "myAppearance(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "The caller's appearance.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 33, "end": 36 }, { "routes": [ "POST /minn-admin/v1/me/appearance (floor edit_posts)" ], "name": "saveMyAppearance", "static": false, "visibility": "public", "signature": "saveMyAppearance(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "Saves the caller's appearance.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 40, "end": 43 }, { "routes": [ "GET /minn-admin/v1/users/{id:\\d+}/appearance (cap edit_user on {id})" ], "name": "userAppearance", "static": false, "visibility": "public", "signature": "userAppearance(Minn\\Http\\Request $request, string $id): Minn\\Http\\Response", "doc": "A user's appearance, for one who may edit them.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" }, { "name": "id", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 47, "end": 50 }, { "routes": [ "POST /minn-admin/v1/users/{id:\\d+}/appearance (cap edit_user on {id})" ], "name": "saveUserAppearance", "static": false, "visibility": "public", "signature": "saveUserAppearance(Minn\\Http\\Request $request, string $id): Minn\\Http\\Response", "doc": "Saves a user's appearance.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" }, { "name": "id", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 54, "end": 57 }, { "routes": [ "GET /minn-admin/v1/users/{id:\\d+}/hidden (cap edit_user on {id})" ], "name": "hidden", "static": false, "visibility": "public", "signature": "hidden(Minn\\Http\\Request $request, string $id): Minn\\Http\\Response", "doc": "The target user's restore list, for the user edit page.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" }, { "name": "id", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 61, "end": 64 }, { "routes": [ "POST /minn-admin/v1/users/{id:\\d+}/integrations/unhide (cap edit_user on {id})" ], "name": "unhideForUser", "static": false, "visibility": "public", "signature": "unhideForUser(Minn\\Http\\Request $request, string $id): Minn\\Http\\Response", "doc": "An administrator restores something another person hid; hiding stays that person's own choice.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" }, { "name": "id", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 68, "end": 77 }, { "routes": [ "POST /minn-admin/v1/integrations/hide (floor edit_posts)" ], "name": "hide", "static": false, "visibility": "public", "signature": "hide(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "Hides a view for the caller.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 81, "end": 88 }, { "routes": [ "POST /minn-admin/v1/integrations/unhide (floor edit_posts)" ], "name": "unhide", "static": false, "visibility": "public", "signature": "unhide(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "Shows a view again for the caller.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 92, "end": 97 }, { "routes": [], "name": "integrationId", "static": false, "visibility": "private", "signature": "integrationId(Minn\\Http\\Request $request): string", "doc": "", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 99, "end": 106 }, { "routes": [], "name": "integrationState", "static": false, "visibility": "private", "signature": "integrationState(int $userId): array", "doc": "The boot slices a hide or unhide repaints from. The engine registers no\nplugin surfaces, editor panels, design sources, or block forms.", "shapes": [], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 112, "end": 124 }, { "routes": [], "name": "appearanceBody", "static": false, "visibility": "private", "signature": "appearanceBody(Minn\\Http\\Request $request): array", "doc": "", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 126, "end": 130 }, { "routes": [], "name": "editableUser", "static": false, "visibility": "private", "signature": "editableUser(string $id): int", "doc": "", "shapes": [], "params": [ { "name": "id", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 132, "end": 135 } ] }, { "name": "Minn\\Admin\\RenderController", "short": "RenderController", "namespace": "Minn\\Admin", "kind": "final readonly class", "file": "public/minn/src/Minn/Admin/RenderController.php", "lines": 52, "doc": "The editor's island previews: block markup rendered by the same\nrenderer the public site uses, with the stylesheets that site loads\n(the engine's block stylesheet, the theme's, and the theme.json rules)\nso a preview looks like the page will.", "implements": [], "extends": null, "uses": [ "Minn\\Content\\Blocks", "Minn\\Content\\Posts", "Minn\\Content\\Site", "Minn\\Db", "Minn\\Front\\Permalinks", "Minn\\Http\\Access", "Minn\\Http\\Method", "Minn\\Http\\Policy", "Minn\\Http\\Request", "Minn\\Http\\Response", "Minn\\Http\\Route", "Minn\\RestError", "Minn\\Rest\\Caller", "Minn\\Rest\\Reply", "Minn\\Theme\\GlobalStyles", "Minn\\Theme\\Templates", "Minn\\Theme\\Theme" ], "usedBy": [ "Minn\\Rest\\Api" ], "constructor": { "signature": "__construct(Minn\\Db $db, Minn\\Content\\Site $site, Minn\\Content\\Posts $posts, Minn\\Front\\Permalinks $permalinks, Minn\\Rest\\Caller $caller, string $themesDir)", "doc": "", "shapes": [], "params": [ { "name": "db", "type": "Minn\\Db", "shape": "", "default": null, "doc": "" }, { "name": "site", "type": "Minn\\Content\\Site", "shape": "", "default": null, "doc": "" }, { "name": "posts", "type": "Minn\\Content\\Posts", "shape": "", "default": null, "doc": "" }, { "name": "permalinks", "type": "Minn\\Front\\Permalinks", "shape": "", "default": null, "doc": "" }, { "name": "caller", "type": "Minn\\Rest\\Caller", "shape": "", "default": null, "doc": "" }, { "name": "themesDir", "type": "string", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 33, "end": 41 }, "cases": [], "constants": [], "properties": [ { "name": "db", "type": "Minn\\Db", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "site", "type": "Minn\\Content\\Site", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "posts", "type": "Minn\\Content\\Posts", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "permalinks", "type": "Minn\\Front\\Permalinks", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "caller", "type": "Minn\\Rest\\Caller", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "themesDir", "type": "string", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [ "POST /minn-admin/v1/render-blocks (floor edit_posts)" ], "name": "render", "static": false, "visibility": "public", "signature": "render(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "Renders blocks for the editor's preview.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 45, "end": 56 }, { "routes": [ "GET /minn-admin/v1/editor-styles (floor edit_posts)" ], "name": "editorStyles", "static": false, "visibility": "public", "signature": "editorStyles(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "The stylesheets previews are scoped under: the engine's own, the theme's, and theme.json inline.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 60, "end": 63 }, { "routes": [], "name": "styles", "static": false, "visibility": "private", "signature": "styles(): array", "doc": "", "shapes": [ "@return array{urls: list, inline: string}" ], "params": [], "line": 66, "end": 80 } ] }, { "name": "Minn\\Admin\\SessionsController", "short": "SessionsController", "namespace": "Minn\\Admin", "kind": "final readonly class", "file": "public/minn/src/Minn/Admin/SessionsController.php", "lines": 72, "doc": "A person's sign-in sessions, read from the same session_tokens store\nthe login endpoint writes. Verifiers are the store's keys (the sha256\nof each cookie token), so the app can name one without ever seeing\nthe token. Expired rows are skipped, not garbage-collected here.", "implements": [], "extends": null, "uses": [ "Minn\\Auth\\Sessions", "Minn\\Content\\Users", "Minn\\Http\\Access", "Minn\\Http\\Method", "Minn\\Http\\Policy", "Minn\\Http\\Request", "Minn\\Http\\Response", "Minn\\Http\\Route", "Minn\\RestError", "Minn\\Rest\\Caller", "Minn\\Rest\\Fields", "Minn\\Rest\\Reply" ], "usedBy": [ "Minn\\Rest\\Api" ], "constructor": { "signature": "__construct(Minn\\Content\\Users $users, Minn\\Auth\\Sessions $sessions, Minn\\Rest\\Caller $caller)", "doc": "", "shapes": [], "params": [ { "name": "users", "type": "Minn\\Content\\Users", "shape": "", "default": null, "doc": "" }, { "name": "sessions", "type": "Minn\\Auth\\Sessions", "shape": "", "default": null, "doc": "" }, { "name": "caller", "type": "Minn\\Rest\\Caller", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 28, "end": 33 }, "cases": [], "constants": [], "properties": [ { "name": "users", "type": "Minn\\Content\\Users", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "sessions", "type": "Minn\\Auth\\Sessions", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "caller", "type": "Minn\\Rest\\Caller", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [ "GET /minn-admin/v1/users/{id:\\d+}/sessions (cap edit_user on {id})" ], "name": "list", "static": false, "visibility": "public", "signature": "list(Minn\\Http\\Request $request, string $id): Minn\\Http\\Response", "doc": "A user's sessions, the caller's own marked.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" }, { "name": "id", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 37, "end": 59 }, { "routes": [ "DELETE /minn-admin/v1/users/{id:\\d+}/sessions (cap edit_user on {id})" ], "name": "destroyAll", "static": false, "visibility": "public", "signature": "destroyAll(Minn\\Http\\Request $request, string $id): Minn\\Http\\Response", "doc": "Signs the person out everywhere; a caller acting on themselves keeps the session they are using.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" }, { "name": "id", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 63, "end": 72 }, { "routes": [ "DELETE /minn-admin/v1/users/{id:\\d+}/sessions/{verifier:[a-f0-9]{40,64}} (cap edit_user on {id})" ], "name": "destroy", "static": false, "visibility": "public", "signature": "destroy(Minn\\Http\\Request $request, string $id, string $verifier): Minn\\Http\\Response", "doc": "Signs one session out.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" }, { "name": "id", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "verifier", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 76, "end": 83 }, { "routes": [], "name": "target", "static": false, "visibility": "private", "signature": "target(string $id): int", "doc": "The user from the path: the caller themselves, or anyone the caller may edit.", "shapes": [], "params": [ { "name": "id", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 86, "end": 96 } ] }, { "name": "Minn\\Admin\\SiteController", "short": "SiteController", "namespace": "Minn\\Admin", "kind": "final readonly class", "file": "public/minn/src/Minn/Admin/SiteController.php", "lines": 90, "doc": "The small Settings-view routes of minn-admin/v1: the site logo, the\npermalink structure, the spam queue, and the months the library spans.", "implements": [], "extends": null, "uses": [ "Minn\\Content\\Posts", "Minn\\Content\\Site", "Minn\\Db", "Minn\\Front\\Permalinks", "Minn\\Http\\Access", "Minn\\Http\\Method", "Minn\\Http\\Policy", "Minn\\Http\\Request", "Minn\\Http\\Response", "Minn\\Http\\Route", "Minn\\Media\\Metadata", "Minn\\Rest\\Caller", "Minn\\Rest\\Reply", "Minn\\Support\\Serialized", "Minn\\Theme\\Theme" ], "usedBy": [ "Minn\\Rest\\Api" ], "constructor": { "signature": "__construct(Minn\\Db $db, Minn\\Content\\Site $site, Minn\\Content\\Posts $posts, Minn\\Front\\Permalinks $permalinks, Minn\\Rest\\Caller $caller)", "doc": "", "shapes": [], "params": [ { "name": "db", "type": "Minn\\Db", "shape": "", "default": null, "doc": "" }, { "name": "site", "type": "Minn\\Content\\Site", "shape": "", "default": null, "doc": "" }, { "name": "posts", "type": "Minn\\Content\\Posts", "shape": "", "default": null, "doc": "" }, { "name": "permalinks", "type": "Minn\\Front\\Permalinks", "shape": "", "default": null, "doc": "" }, { "name": "caller", "type": "Minn\\Rest\\Caller", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 29, "end": 36 }, "cases": [], "constants": [], "properties": [ { "name": "db", "type": "Minn\\Db", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "site", "type": "Minn\\Content\\Site", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "posts", "type": "Minn\\Content\\Posts", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "permalinks", "type": "Minn\\Front\\Permalinks", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "caller", "type": "Minn\\Rest\\Caller", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [ "GET /minn-admin/v1/site-logo (floor edit_posts)" ], "name": "siteLogo", "static": false, "visibility": "public", "signature": "siteLogo(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "The site logo attachment.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 40, "end": 53 }, { "routes": [ "GET /minn-admin/v1/permalinks (floor edit_posts)" ], "name": "permalinks", "static": false, "visibility": "public", "signature": "permalinks(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "The permalink structure.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 70, "end": 84 }, { "routes": [ "GET /minn-admin/v1/spam (floor edit_posts)" ], "name": "spam", "static": false, "visibility": "public", "signature": "spam(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "The spam settings.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 88, "end": 104 }, { "routes": [ "GET /minn-admin/v1/media/months (floor edit_posts)" ], "name": "mediaMonths", "static": false, "visibility": "public", "signature": "mediaMonths(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "The months the library has uploads in.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 108, "end": 115 }, { "routes": [], "name": "logoUrl", "static": false, "visibility": "private", "signature": "logoUrl(int $id): string", "doc": "The custom logo's medium rendition, the size the app's card shows.", "shapes": [], "params": [ { "name": "id", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 56, "end": 66 } ] }, { "name": "Minn\\Admin\\StructureController", "short": "StructureController", "namespace": "Minn\\Admin", "kind": "final readonly class", "file": "public/minn/src/Minn/Admin/StructureController.php", "lines": 131, "doc": "The Structure view of minn-admin/v1: post types, taxonomies, and the\nterms switcher, each with its live counts, answered from the registries.", "implements": [], "extends": null, "uses": [ "Minn\\Db", "Minn\\Http\\Access", "Minn\\Http\\Method", "Minn\\Http\\Policy", "Minn\\Http\\Request", "Minn\\Http\\Response", "Minn\\Http\\Route", "Minn\\Json", "Minn\\Rest\\Caller", "Minn\\Rest\\Reply", "Minn\\Rest\\Taxonomies", "Minn\\Rest\\Types" ], "usedBy": [ "Minn\\Rest\\Api" ], "constructor": { "signature": "__construct(Minn\\Db $db, Minn\\Rest\\Types $types, Minn\\Rest\\Taxonomies $taxonomies, Minn\\Rest\\Caller $caller)", "doc": "", "shapes": [], "params": [ { "name": "db", "type": "Minn\\Db", "shape": "", "default": null, "doc": "" }, { "name": "types", "type": "Minn\\Rest\\Types", "shape": "", "default": null, "doc": "" }, { "name": "taxonomies", "type": "Minn\\Rest\\Taxonomies", "shape": "", "default": null, "doc": "" }, { "name": "caller", "type": "Minn\\Rest\\Caller", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 26, "end": 32 }, "cases": [], "constants": [], "properties": [ { "name": "db", "type": "Minn\\Db", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "types", "type": "Minn\\Rest\\Types", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "taxonomies", "type": "Minn\\Rest\\Taxonomies", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "caller", "type": "Minn\\Rest\\Caller", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [ "GET /minn-admin/v1/term-taxonomies (floor edit_posts)" ], "name": "termTaxonomies", "static": false, "visibility": "public", "signature": "termTaxonomies(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "The taxonomies of each public type, for the Structure view.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 36, "end": 66 }, { "routes": [ "GET /minn-admin/v1/post-types (floor edit_posts)" ], "name": "postTypes", "static": false, "visibility": "public", "signature": "postTypes(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "The Structure view's post types: core and site-declared, with their live counts.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 70, "end": 108 }, { "routes": [ "GET /minn-admin/v1/taxonomies (floor edit_posts)" ], "name": "taxonomies", "static": false, "visibility": "public", "signature": "taxonomies(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "Every taxonomy with its counts.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 112, "end": 134 }, { "routes": [], "name": "publicTypes", "static": false, "visibility": "private", "signature": "publicTypes(): array", "doc": "", "shapes": [ "@return list" ], "params": [], "line": 137, "end": 140 }, { "routes": [], "name": "termCount", "static": false, "visibility": "private", "signature": "termCount(string $taxonomy): int", "doc": "", "shapes": [], "params": [ { "name": "taxonomy", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 142, "end": 145 }, { "routes": [], "name": "postCount", "static": false, "visibility": "private", "signature": "postCount(string $type): int", "doc": "", "shapes": [], "params": [ { "name": "type", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 147, "end": 153 } ] }, { "name": "Minn\\Admin\\SystemController", "short": "SystemController", "namespace": "Minn\\Admin", "kind": "final readonly class", "file": "public/minn/src/Minn/Admin/SystemController.php", "lines": 73, "doc": "The System view: diagnostics, the scheduled-post list, autoloaded options, and the logs.", "implements": [], "extends": null, "uses": [ "Minn\\Http\\Access", "Minn\\Http\\Method", "Minn\\Http\\Policy", "Minn\\Http\\Request", "Minn\\Http\\Response", "Minn\\Http\\Route", "Minn\\Ops\\Diagnostics", "Minn\\Ops\\Logs", "Minn\\RestError", "Minn\\Rest\\Caller", "Minn\\Rest\\Reply" ], "usedBy": [ "Minn\\Rest\\Api" ], "constructor": { "signature": "__construct(Minn\\Ops\\Diagnostics $diagnostics, Minn\\Ops\\Logs $logs, Minn\\Rest\\Caller $caller)", "doc": "", "shapes": [], "params": [ { "name": "diagnostics", "type": "Minn\\Ops\\Diagnostics", "shape": "", "default": null, "doc": "" }, { "name": "logs", "type": "Minn\\Ops\\Logs", "shape": "", "default": null, "doc": "" }, { "name": "caller", "type": "Minn\\Rest\\Caller", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 22, "end": 24 }, "cases": [], "constants": [], "properties": [ { "name": "diagnostics", "type": "Minn\\Ops\\Diagnostics", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "logs", "type": "Minn\\Ops\\Logs", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "caller", "type": "Minn\\Rest\\Caller", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [ "GET /minn-admin/v1/system (cap manage_options)" ], "name": "system", "static": false, "visibility": "public", "signature": "system(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "The System view's payload.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 28, "end": 31 }, { "routes": [ "GET /minn-admin/v1/system/cron (cap manage_options)" ], "name": "cron", "static": false, "visibility": "public", "signature": "cron(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "The scheduled posts.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 35, "end": 38 }, { "routes": [ "GET /minn-admin/v1/system/autoload (cap manage_options)" ], "name": "autoload", "static": false, "visibility": "public", "signature": "autoload(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "The autoloaded options.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 42, "end": 45 }, { "routes": [ "POST /minn-admin/v1/system/config (cap manage_options)" ], "name": "config", "static": false, "visibility": "public", "signature": "config(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "The engine never rewrites wp-config.php; the file is the site's, edited by hand.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 49, "end": 52 }, { "routes": [ "GET /minn-admin/v1/system/logs (cap manage_options)" ], "name": "logs", "static": false, "visibility": "public", "signature": "logs(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "The logs list.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 56, "end": 59 }, { "routes": [ "GET /minn-admin/v1/system/logs/{id:[a-zA-Z0-9:_.\\-]+} (cap manage_options)" ], "name": "log", "static": false, "visibility": "public", "signature": "log(Minn\\Http\\Request $request, string $id): Minn\\Http\\Response", "doc": "One log's tail.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" }, { "name": "id", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 63, "end": 66 }, { "routes": [ "DELETE /minn-admin/v1/system/logs/{id:[a-zA-Z0-9:_.\\-]+} (cap manage_options)" ], "name": "clearLog", "static": false, "visibility": "public", "signature": "clearLog(Minn\\Http\\Request $request, string $id): Minn\\Http\\Response", "doc": "Empties one log.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" }, { "name": "id", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 70, "end": 74 }, { "routes": [ "GET /minn-admin/v1/system/debug-log (cap manage_options)" ], "name": "debugLog", "static": false, "visibility": "public", "signature": "debugLog(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "The debug log's tail.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 78, "end": 81 }, { "routes": [ "DELETE /minn-admin/v1/system/debug-log (cap manage_options)" ], "name": "clearDebugLog", "static": false, "visibility": "public", "signature": "clearDebugLog(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "Empties the debug log.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 85, "end": 89 } ] }, { "name": "Minn\\Admin\\ThemesController", "short": "ThemesController", "namespace": "Minn\\Admin", "kind": "final readonly class", "file": "public/minn/src/Minn/Admin/ThemesController.php", "lines": 99, "doc": "The theme inventory of minn-admin/v1: every theme on disk with its\nheaders, screenshot, and update offer, and the switch of the active one.", "implements": [], "extends": null, "uses": [ "Minn\\Content\\Site", "Minn\\Front\\Permalinks", "Minn\\Http\\Access", "Minn\\Http\\Method", "Minn\\Http\\Policy", "Minn\\Http\\Request", "Minn\\Http\\Response", "Minn\\Http\\Route", "Minn\\Ops\\AutoUpdates", "Minn\\Ops\\Updates", "Minn\\RestError", "Minn\\Rest\\Caller", "Minn\\Rest\\Reply", "Minn\\Runtime\\Runtime", "Minn\\Support\\FileHeaders" ], "usedBy": [ "Minn\\Rest\\Api" ], "constructor": { "signature": "__construct(Minn\\Content\\Site $site, Minn\\Front\\Permalinks $permalinks, Minn\\Ops\\Updates $updates, Minn\\Rest\\Caller $caller, string $contentDir)", "doc": "", "shapes": [], "params": [ { "name": "site", "type": "Minn\\Content\\Site", "shape": "", "default": null, "doc": "" }, { "name": "permalinks", "type": "Minn\\Front\\Permalinks", "shape": "", "default": null, "doc": "" }, { "name": "updates", "type": "Minn\\Ops\\Updates", "shape": "", "default": null, "doc": "" }, { "name": "caller", "type": "Minn\\Rest\\Caller", "shape": "", "default": null, "doc": "" }, { "name": "contentDir", "type": "string", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 29, "end": 36 }, "cases": [], "constants": [], "properties": [ { "name": "site", "type": "Minn\\Content\\Site", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "permalinks", "type": "Minn\\Front\\Permalinks", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "updates", "type": "Minn\\Ops\\Updates", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "caller", "type": "Minn\\Rest\\Caller", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "contentDir", "type": "string", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [ "GET /minn-admin/v1/themes (floor edit_posts)" ], "name": "themes", "static": false, "visibility": "public", "signature": "themes(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "Every theme on disk with the active one marked.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 40, "end": 67 }, { "routes": [ "POST /minn-admin/v1/themes/activate (floor edit_posts + switch_themes)" ], "name": "activateTheme", "static": false, "visibility": "public", "signature": "activateTheme(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "Switches the active theme.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 71, "end": 91 }, { "routes": [], "name": "themeText", "static": true, "visibility": "private", "signature": "themeText(string $value): string", "doc": "A theme header as the reference serves it: tags stripped, a bare ampersand entity-encoded.", "shapes": [], "params": [ { "name": "value", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 94, "end": 97 }, { "routes": [], "name": "themeFolders", "static": false, "visibility": "private", "signature": "themeFolders(): array", "doc": "", "shapes": [ "@return array> slug => style.css headers" ], "params": [], "line": 100, "end": 114 }, { "routes": [], "name": "screenshot", "static": false, "visibility": "private", "signature": "screenshot(string $slug): string", "doc": "", "shapes": [], "params": [ { "name": "slug", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 116, "end": 124 } ] }, { "name": "Minn\\Admin\\Translations", "short": "Translations", "namespace": "Minn\\Admin", "kind": "final readonly class", "file": "public/minn/src/Minn/Admin/Translations.php", "lines": 237, "doc": "Languages for the admin. A person's locale is their `locale` user meta,\nelse the site's WPLANG, else en_US, exactly as the reference resolves it.\nThe app translates itself from a map of its source strings, read from the\nJED catalogs Minn Admin's language packs install under\nwp-content/languages/plugins (the bundle's own languages folder is the\nfallback). Installing a pack fetches the release asset the bundle's\nmanifest names for that locale, checks its hash, and unpacks only that\nlocale's files, so an eject leaves the files WordPress would have written.", "implements": [], "extends": null, "uses": [ "Minn\\Admin\\App", "Minn\\Content\\Site", "Minn\\Content\\Users", "Minn\\Http", "Minn\\Http\\Download", "Minn\\Json", "Minn\\RestError" ], "usedBy": [ "Minn\\Admin\\BootPayload", "Minn\\Admin\\LanguageController", "Minn\\Engine", "Minn\\Rest\\Services" ], "constructor": { "signature": "__construct(Minn\\Content\\Users $users, Minn\\Content\\Site $site, Minn\\Admin\\App $app, string $contentDir, Minn\\Http $http = \\Minn\\Http::__set_state(array( 'within' => array ( ), 'fake' => NULL, 'refusal' => NULL, )))", "doc": "", "shapes": [], "params": [ { "name": "users", "type": "Minn\\Content\\Users", "shape": "", "default": null, "doc": "" }, { "name": "site", "type": "Minn\\Content\\Site", "shape": "", "default": null, "doc": "" }, { "name": "app", "type": "Minn\\Admin\\App", "shape": "", "default": null, "doc": "" }, { "name": "contentDir", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "http", "type": "Minn\\Http", "shape": "", "default": "\\Minn\\Http::__set_state(array( 'within' => array ( ), 'fake' => NULL, 'refusal' => NULL, ))", "doc": "" } ], "visibility": "public", "line": 28, "end": 35 }, "cases": [], "constants": [ { "name": "RTL", "value": "array ( 0 => 'ar', 1 => 'ary', 2 => 'azb', 3 => 'ckb', 4 => 'dv', 5 => 'fa_AF', 6 => 'fa_IR', 7 => 'haz', 8 => 'he_IL', 9 => 'ps', 10 => 'skr', 11 => 'ug_CN', 12 => 'ur', )", "doc": "", "visibility": "private" } ], "properties": [ { "name": "users", "type": "Minn\\Content\\Users", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "site", "type": "Minn\\Content\\Site", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "app", "type": "Minn\\Admin\\App", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "contentDir", "type": "string", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "http", "type": "Minn\\Http", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [], "name": "localeOf", "static": false, "visibility": "public", "signature": "localeOf(int $userId): string", "doc": "The locale a person reads the admin in.", "shapes": [], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 38, "end": 45 }, { "routes": [], "name": "siteLocale", "static": false, "visibility": "public", "signature": "siteLocale(): string", "doc": "The site's locale from WPLANG, en_US by default.", "shapes": [], "params": [], "line": 48, "end": 52 }, { "routes": [], "name": "isRtl", "static": true, "visibility": "public", "signature": "isRtl(string $locale): bool", "doc": "Whether a locale reads right to left.", "shapes": [], "params": [ { "name": "locale", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 55, "end": 58 }, { "routes": [], "name": "catalog", "static": false, "visibility": "public", "signature": "catalog(string $locale): array", "doc": "The app's translation map for a locale: source string => translation,\nor the plural forms as a list. Later folders win, so the installed\npack lands over the bundle's fallback.", "shapes": [ "@return array{0: array>, 1: string} map and the Plural-Forms rule" ], "params": [ { "name": "locale", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 67, "end": 87 }, { "routes": [], "name": "isInstalled", "static": false, "visibility": "public", "signature": "isInstalled(string $locale): bool", "doc": "Whether a locale has any files on this site: a core pack or Minn Admin's own.", "shapes": [], "params": [ { "name": "locale", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 90, "end": 93 }, { "routes": [], "name": "installed", "static": false, "visibility": "public", "signature": "installed(): array", "doc": "The locales with a pack on disk, the two defaults first.", "shapes": [ "@return list the site-default row, en_US, then every installed locale" ], "params": [], "line": 100, "end": 108 }, { "routes": [], "name": "payload", "static": false, "visibility": "public", "signature": "payload(int $forUser): array", "doc": "The languages route's payload; `current` is the raw meta of the user asked about.", "shapes": [], "params": [ { "name": "forUser", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 111, "end": 114 }, { "routes": [], "name": "readOnlyPayload", "static": false, "visibility": "public", "signature": "readOnlyPayload(int $forUser): array", "doc": "The same payload for a caller who may switch languages but not install one: no available list.", "shapes": [], "params": [ { "name": "forUser", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 117, "end": 120 }, { "routes": [], "name": "install", "static": false, "visibility": "public", "signature": "install(string $locale): bool", "doc": "Fetches and unpacks Minn Admin's language pack for a locale from the\nrelease the bundle's manifest names. True when files were written;\nfalse when the manifest offers no pack for the locale.", "shapes": [], "params": [ { "name": "locale", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 147, "end": 204 }, { "routes": [], "name": "languages", "static": false, "visibility": "private", "signature": "languages(int $forUser, bool $canInstall): array", "doc": "", "shapes": [], "params": [ { "name": "forUser", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "canInstall", "type": "bool", "shape": "", "default": null, "doc": "" } ], "line": 122, "end": 140 }, { "routes": [], "name": "catalogFiles", "static": false, "visibility": "private", "signature": "catalogFiles(string $locale): array", "doc": "", "shapes": [ "@return list" ], "params": [ { "name": "locale", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 207, "end": 216 }, { "routes": [], "name": "installedCodes", "static": false, "visibility": "private", "signature": "installedCodes(): array", "doc": "", "shapes": [ "@return list locale codes with a core pack or a Minn Admin pack on disk, sorted" ], "params": [], "line": 219, "end": 237 }, { "routes": [], "name": "names", "static": false, "visibility": "private", "signature": "names(): array", "doc": "Native names for every locale the registry lists, from the captured catalog. @return array", "shapes": [ "@return array" ], "params": [], "line": 240, "end": 250 }, { "routes": [], "name": "download", "static": false, "visibility": "private", "signature": "download(string $url): string", "doc": "", "shapes": [], "params": [ { "name": "url", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 252, "end": 259 } ] }, { "name": "Minn\\Admin\\UpdatesController", "short": "UpdatesController", "namespace": "Minn\\Admin", "kind": "final readonly class", "file": "public/minn/src/Minn/Admin/UpdatesController.php", "lines": 129, "doc": "The minn-admin/v1 update routes: offers, directory meta, the check, the installs, the auto-update lists.", "implements": [], "extends": null, "uses": [ "Minn\\Http\\Access", "Minn\\Http\\Method", "Minn\\Http\\Policy", "Minn\\Http\\Request", "Minn\\Http\\Response", "Minn\\Http\\Route", "Minn\\Ops\\AutoUpdates", "Minn\\Ops\\CoreStatus", "Minn\\Ops\\Updates", "Minn\\RestError", "Minn\\Rest\\Caller", "Minn\\Rest\\Reply" ], "usedBy": [ "Minn\\Rest\\Api" ], "constructor": { "signature": "__construct(Minn\\Ops\\Updates $updates, Minn\\Ops\\CoreStatus $core, Minn\\Rest\\Caller $caller)", "doc": "", "shapes": [], "params": [ { "name": "updates", "type": "Minn\\Ops\\Updates", "shape": "", "default": null, "doc": "" }, { "name": "core", "type": "Minn\\Ops\\CoreStatus", "shape": "", "default": null, "doc": "" }, { "name": "caller", "type": "Minn\\Rest\\Caller", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 23, "end": 25 }, "cases": [], "constants": [], "properties": [ { "name": "updates", "type": "Minn\\Ops\\Updates", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "core", "type": "Minn\\Ops\\CoreStatus", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "caller", "type": "Minn\\Rest\\Caller", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [ "GET /minn-admin/v1/plugin-updates (signed in)" ], "name": "pluginUpdates", "static": false, "visibility": "public", "signature": "pluginUpdates(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "The plugin update offers.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 29, "end": 40 }, { "routes": [ "GET /minn-admin/v1/plugin-meta (signed in)" ], "name": "pluginMeta", "static": false, "visibility": "public", "signature": "pluginMeta(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "Icons and details for the installed plugins.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 44, "end": 48 }, { "routes": [ "POST /minn-admin/v1/check-updates (signed in)" ], "name": "check", "static": false, "visibility": "public", "signature": "check(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "Asks the Minn update service again, now: for plugin and theme offers, and for Minn itself (its status answered as core).", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 52, "end": 78 }, { "routes": [ "POST /minn-admin/v1/plugins/update (signed in)" ], "name": "updatePlugin", "static": false, "visibility": "public", "signature": "updatePlugin(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "Updates one plugin.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 82, "end": 93 }, { "routes": [ "POST /minn-admin/v1/plugins/update-all (signed in)" ], "name": "updateAll", "static": false, "visibility": "public", "signature": "updateAll(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "Updates every plugin with an offer.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 97, "end": 114 }, { "routes": [ "POST /minn-admin/v1/themes/update (signed in)" ], "name": "updateTheme", "static": false, "visibility": "public", "signature": "updateTheme(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "Updates one theme.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 118, "end": 126 }, { "routes": [ "POST /minn-admin/v1/auto-updates" ], "name": "autoUpdates", "static": false, "visibility": "public", "signature": "autoUpdates(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "Turns auto-updates on or off for one asset.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 130, "end": 147 } ] }, { "name": "Minn\\Admin\\UploadsSize", "short": "UploadsSize", "namespace": "Minn\\Admin", "kind": "final readonly class", "file": "public/minn/src/Minn/Admin/UploadsSize.php", "lines": 93, "doc": "How much the uploads folder holds, as Minn Admin 0.43 works it out and\nshares it through the minn_admin_uploads_size transient: the cached\nfigure in either shape it has had ({bytes, partial}, or a bare count from\nbefore the budget), else a walk only an administrator may start, one at a\ntime behind a two-minute lock, stopped after four seconds and kept as\npartial for an hour instead of twelve.", "implements": [], "extends": null, "uses": [ "Minn\\Admin\\Format", "Minn\\Auth\\Capabilities", "Minn\\Content\\Site", "Minn\\Support\\Serialized" ], "usedBy": [ "Minn\\Admin\\Dashboard" ], "constructor": { "signature": "__construct(Minn\\Content\\Site $site, Minn\\Auth\\Capabilities $capabilities, string $dir)", "doc": "", "shapes": [], "params": [ { "name": "site", "type": "Minn\\Content\\Site", "shape": "", "default": null, "doc": "" }, { "name": "capabilities", "type": "Minn\\Auth\\Capabilities", "shape": "", "default": null, "doc": "" }, { "name": "dir", "type": "string", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 26, "end": 28 }, "cases": [], "constants": [ { "name": "CACHE", "value": "'_transient_minn_admin_uploads_size'", "doc": "", "visibility": "private" }, { "name": "EXPIRES", "value": "'_transient_timeout_minn_admin_uploads_size'", "doc": "", "visibility": "private" }, { "name": "LOCK", "value": "'minn_admin_uploads_size_lock'", "doc": "", "visibility": "private" }, { "name": "BUDGET", "value": "4.0", "doc": "", "visibility": "private" } ], "properties": [ { "name": "site", "type": "Minn\\Content\\Site", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "capabilities", "type": "Minn\\Auth\\Capabilities", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "dir", "type": "string", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [], "name": "label", "static": false, "visibility": "public", "signature": "label(int $userId): string", "doc": "The Media card's \"N used\" line, \"over N used\" for a walk cut short, or \"\" when the size is not known.", "shapes": [], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 31, "end": 38 }, { "routes": [], "name": "measure", "static": false, "visibility": "public", "signature": "measure(int $userId): ?array", "doc": "The uploads size, cached or walked now.", "shapes": [ "@return array{bytes: int, partial: bool}|null null when nothing is known and this caller may not find out" ], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 45, "end": 59 }, { "routes": [], "name": "cached", "static": false, "visibility": "private", "signature": "cached(): ?array", "doc": "", "shapes": [ "@return array{bytes: int, partial: bool}|null" ], "params": [], "line": 62, "end": 74 }, { "routes": [], "name": "lock", "static": false, "visibility": "private", "signature": "lock(): bool", "doc": "Whether this request may walk: no other has started one in the last two minutes.", "shapes": [], "params": [], "line": 77, "end": 85 }, { "routes": [], "name": "walk", "static": false, "visibility": "private", "signature": "walk(): array", "doc": "", "shapes": [ "@return array{bytes: int, partial: bool}" ], "params": [], "line": 88, "end": 110 } ] }, { "name": "Minn\\Admin\\V1Controller", "short": "V1Controller", "namespace": "Minn\\Admin", "kind": "final readonly class", "file": "public/minn/src/Minn/Admin/V1Controller.php", "lines": 80, "doc": "The boot burst of minn-admin/v1: the bell feed and its read marker, the\ncore status, and the one-round-trip boot-status the app starts from.\nEvery route sits behind the same capability floor (edit_posts) the\nplugin declares.", "implements": [], "extends": null, "uses": [ "Minn\\Admin\\AdminTypes", "Minn\\Admin\\Notifications", "Minn\\Db", "Minn\\Http\\Access", "Minn\\Http\\Method", "Minn\\Http\\Policy", "Minn\\Http\\Request", "Minn\\Http\\Response", "Minn\\Http\\Route", "Minn\\Ops\\CoreStatus", "Minn\\Rest\\Caller", "Minn\\Rest\\Reply" ], "usedBy": [ "Minn\\Rest\\Api" ], "constructor": { "signature": "__construct(Minn\\Db $db, Minn\\Admin\\Notifications $notifications, Minn\\Ops\\CoreStatus $core, Minn\\Admin\\AdminTypes $types, Minn\\Rest\\Caller $caller)", "doc": "", "shapes": [], "params": [ { "name": "db", "type": "Minn\\Db", "shape": "", "default": null, "doc": "" }, { "name": "notifications", "type": "Minn\\Admin\\Notifications", "shape": "", "default": null, "doc": "" }, { "name": "core", "type": "Minn\\Ops\\CoreStatus", "shape": "", "default": null, "doc": "" }, { "name": "types", "type": "Minn\\Admin\\AdminTypes", "shape": "", "default": null, "doc": "" }, { "name": "caller", "type": "Minn\\Rest\\Caller", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 26, "end": 33 }, "cases": [], "constants": [], "properties": [ { "name": "db", "type": "Minn\\Db", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "notifications", "type": "Minn\\Admin\\Notifications", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "core", "type": "Minn\\Ops\\CoreStatus", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "types", "type": "Minn\\Admin\\AdminTypes", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "caller", "type": "Minn\\Rest\\Caller", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [ "GET /minn-admin/v1/notifications (floor edit_posts)" ], "name": "notifications", "static": false, "visibility": "public", "signature": "notifications(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "The bell feed.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 37, "end": 40 }, { "routes": [ "POST /minn-admin/v1/notifications/read (floor edit_posts)" ], "name": "notificationsRead", "static": false, "visibility": "public", "signature": "notificationsRead(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "Body {id} marks one read; {} marks all read.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 44, "end": 50 }, { "routes": [ "GET /minn-admin/v1/core (floor edit_posts)" ], "name": "core", "static": false, "visibility": "public", "signature": "core(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "Minn's version and any newer release; a day-old check of the update service runs once the answer is sent.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 54, "end": 58 }, { "routes": [ "POST /minn-admin/v1/core/update (floor edit_posts + update_core)" ], "name": "coreUpdate", "static": false, "visibility": "public", "signature": "coreUpdate(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "Replaces the running engine with the release on offer.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 62, "end": 65 }, { "routes": [ "GET /minn-admin/v1/boot-status (floor edit_posts)" ], "name": "bootStatus", "static": false, "visibility": "public", "signature": "bootStatus(Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "The app's one-round-trip boot burst. Absent sections are the\ncontract's own fallback: the client loads a missing section\nstandalone. The engine serves what it can honestly answer and omits\nthe plugin-inventory sections it has no installation for.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 74, "end": 90 }, { "routes": [], "name": "checkingReleases", "static": false, "visibility": "private", "signature": "checkingReleases(Minn\\Http\\Response $response): Minn\\Http\\Response", "doc": "The answer, with the update service asked about Minn's releases after it is sent when the last check is a day old.", "shapes": [], "params": [ { "name": "response", "type": "Minn\\Http\\Response", "shape": "", "default": null, "doc": "" } ], "line": 93, "end": 102 } ] }, { "name": "Minn\\Auth\\ApplicationPasswords", "short": "ApplicationPasswords", "namespace": "Minn\\Auth", "kind": "final readonly class", "file": "public/minn/src/Minn/Auth/ApplicationPasswords.php", "lines": 153, "doc": "Application passwords as the reference stores them: a serialized list in\nthe user's _application_passwords meta, each entry uuid, app_id, name,\npassword (a hash), created, last_used, last_ip. New passwords are 24\ncharacters shown in groups of four; the stored hash is the reference's\nown ($generic$, FastHash), so a password made on either stack works on\nthe other. Older hashes still verify, as the reference verifies them:\nphpass (WordPress before 6.8, and the engine before this) and $wp$.", "implements": [], "extends": null, "uses": [ "Minn\\Auth\\FastHash", "Minn\\Auth\\Password", "Minn\\Auth\\PortableHash", "Minn\\Content\\Users", "Minn\\Support\\Serialized" ], "usedBy": [ "Minn\\Auth\\Authenticator", "Minn\\Rest\\ApplicationPasswordsController", "Minn\\Rest\\Services", "Minn\\Runtime\\ApplicationPasswordEvents", "Minn\\Runtime\\ApplicationPasswordSignIn" ], "constructor": { "signature": "__construct(Minn\\Content\\Users $users)", "doc": "", "shapes": [], "params": [ { "name": "users", "type": "Minn\\Content\\Users", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 23, "end": 25 }, "cases": [], "constants": [ { "name": "META", "value": "'_application_passwords'", "doc": "", "visibility": "public" } ], "properties": [ { "name": "users", "type": "Minn\\Content\\Users", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [], "name": "all", "static": false, "visibility": "public", "signature": "all(int $userId): array", "doc": "Every application password of a user, as stored records without the hash's plain text.", "shapes": [ "@return list>" ], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 32, "end": 40 }, { "routes": [], "name": "find", "static": false, "visibility": "public", "signature": "find(int $userId, string $uuid): ?array", "doc": "One record by uuid, or null.", "shapes": [ "@return array|null" ], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "uuid", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 47, "end": 55 }, { "routes": [], "name": "create", "static": false, "visibility": "public", "signature": "create(int $userId, string $name, string $appId): array", "doc": "Mints a password, stores its hash, and returns the record with the plain text once.", "shapes": [ "@return array{0: array, 1: string} the stored record and the one-time plaintext" ], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "name", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "appId", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 62, "end": 70 }, { "routes": [], "name": "rename", "static": false, "visibility": "public", "signature": "rename(int $userId, string $uuid, string $name): ?array", "doc": "Renames one password; null when the uuid is unknown.", "shapes": [], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "uuid", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "name", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 73, "end": 76 }, { "routes": [], "name": "touch", "static": false, "visibility": "public", "signature": "touch(int $userId, string $uuid, string $ip): ?array", "doc": "Records a use: the time and the address it came from.", "shapes": [], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "uuid", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "ip", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 79, "end": 82 }, { "routes": [], "name": "delete", "static": false, "visibility": "public", "signature": "delete(int $userId, string $uuid): ?array", "doc": "Removes one password and returns its record; null when unknown.", "shapes": [], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "uuid", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 85, "end": 100 }, { "routes": [], "name": "deleteAll", "static": false, "visibility": "public", "signature": "deleteAll(int $userId): int", "doc": "Removes every application password of a user and returns how many.", "shapes": [], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 107, "end": 112 }, { "routes": [], "name": "verify", "static": false, "visibility": "public", "signature": "verify(int $userId, string $password): ?array", "doc": "The record a plaintext (spaces ignored) unlocks for the user, or null.", "shapes": [], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "password", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 115, "end": 125 }, { "routes": [], "name": "generate", "static": true, "visibility": "public", "signature": "generate(): string", "doc": "Twenty-four letters and digits.", "shapes": [], "params": [], "line": 128, "end": 136 }, { "routes": [], "name": "chunked", "static": true, "visibility": "public", "signature": "chunked(string $plain): string", "doc": "The plaintext as shown once: groups of four, space separated.", "shapes": [], "params": [ { "name": "plain", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 139, "end": 142 }, { "routes": [], "name": "change", "static": false, "visibility": "private", "signature": "change(int $userId, string $uuid, array $fields): ?array", "doc": "", "shapes": [], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "uuid", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "fields", "type": "array", "shape": "", "default": null, "doc": "" } ], "line": 144, "end": 157 }, { "routes": [], "name": "save", "static": false, "visibility": "private", "signature": "save(int $userId, array $list): void", "doc": "", "shapes": [], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "list", "type": "array", "shape": "", "default": null, "doc": "" } ], "line": 159, "end": 162 }, { "routes": [], "name": "uuid", "static": true, "visibility": "private", "signature": "uuid(): string", "doc": "", "shapes": [], "params": [], "line": 164, "end": 170 } ] }, { "name": "Minn\\Auth\\AuthCookies", "short": "AuthCookies", "namespace": "Minn\\Auth", "kind": "final readonly class", "file": "public/minn/src/Minn/Auth/AuthCookies.php", "lines": 107, "doc": "The three cookies a sign-in sets: the auth cookie on the admin and\nplugins paths (the secure variant over HTTPS, keyed off that scheme's\nsalt) and the logged_in cookie on the site root, which is the one REST\nreads. Every value shares the username|expiration|token|hmac shape.", "implements": [], "extends": null, "uses": [ "Minn\\Auth\\Cookie", "Minn\\Auth\\Password", "Minn\\Content\\UserRecord", "Minn\\Db", "Minn\\Http\\Response" ], "usedBy": [ "Minn\\Auth\\SignIn", "Minn\\Engine" ], "constructor": { "signature": "__construct(Minn\\Db $db, Minn\\Auth\\Cookie $cookie)", "doc": "", "shapes": [], "params": [ { "name": "db", "type": "Minn\\Db", "shape": "", "default": null, "doc": "" }, { "name": "cookie", "type": "Minn\\Auth\\Cookie", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 23, "end": 27 }, "cases": [], "constants": [ { "name": "DAY", "value": "86400", "doc": "", "visibility": "private" }, { "name": "HOUR", "value": "3600", "doc": "", "visibility": "private" } ], "properties": [ { "name": "db", "type": "Minn\\Db", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "cookie", "type": "Minn\\Auth\\Cookie", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [], "name": "hash", "static": false, "visibility": "public", "signature": "hash(): string", "doc": "The hash suffixed onto every cookie name: md5 of the siteurl option.", "shapes": [], "params": [], "line": 30, "end": 33 }, { "routes": [], "name": "settle", "static": false, "visibility": "public", "signature": "settle(Minn\\Content\\UserRecord $user, int $days, bool $secure, bool $https, string $token = ''): array", "doc": "The sign-in cookies as the reference settles them (suite login-hooks):\ntheir life through auth_cookie_expiration (two days, or fourteen when\nremembered, the cookies then kept twelve hours past it); the auth\ncookie's security through secure_auth_cookie, and the logged-in\ncookie's through secure_logged_in_cookie (secure only over HTTPS); a\nsession made for that life when none is given; then set_auth_cookie\nand set_logged_in_cookie told the values, and send_auth_cookies asked\nwhether to send them. Signing in always runs under the booted\nruntime (its sessions are WordPress's), so the hooks always run.", "shapes": [ "@return array{expiration: int, expire: int, secure: bool, secureLoggedIn: bool, scheme: string, token: string, auth: string, loggedIn: string, send: bool}" ], "params": [ { "name": "user", "type": "Minn\\Content\\UserRecord", "shape": "", "default": null, "doc": "" }, { "name": "days", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "secure", "type": "bool", "shape": "", "default": null, "doc": "" }, { "name": "https", "type": "bool", "shape": "", "default": null, "doc": "" }, { "name": "token", "type": "string", "shape": "", "default": "''", "doc": "" } ], "line": 48, "end": 64 }, { "routes": [], "name": "attach", "static": false, "visibility": "public", "signature": "attach(Minn\\Http\\Response $response, array $plan): Minn\\Http\\Response", "doc": "The response with the settled cookies on it: the auth cookie on the\nadmin and plugins paths, the logged-in cookie on the site root; none\nwhen send_auth_cookies said not to.", "shapes": [ "@param array{expire: int, secure: bool, secureLoggedIn: bool, auth: string, loggedIn: string, send: bool} $plan from settle()" ], "params": [ { "name": "response", "type": "Minn\\Http\\Response", "shape": "", "default": null, "doc": "" }, { "name": "plan", "type": "array", "shape": "array{expire: int, secure: bool, secureLoggedIn: bool, auth: string, loggedIn: string, send: bool}", "default": null, "doc": "from settle()" } ], "line": 73, "end": 86 }, { "routes": [], "name": "clearing", "static": false, "visibility": "public", "signature": "clearing(): bool", "doc": "Whether signing out clears the cookies: clear_auth_cookie told, then\nsend_auth_cookies asked with no cookie in hand, as the reference asks\nthem (suite login-hooks).", "shapes": [], "params": [], "line": 93, "end": 97 }, { "routes": [], "name": "clear", "static": false, "visibility": "public", "signature": "clear(Minn\\Http\\Response $response): Minn\\Http\\Response", "doc": "The response with every sign-in cookie expired.", "shapes": [], "params": [ { "name": "response", "type": "Minn\\Http\\Response", "shape": "", "default": null, "doc": "" } ], "line": 100, "end": 114 }, { "routes": [], "name": "mint", "static": true, "visibility": "public", "signature": "mint(Minn\\Content\\UserRecord $user, int $expiration, string $token, string $scheme): string", "doc": "A cookie value under any scheme's salt (auth, secure_auth, logged_in).", "shapes": [], "params": [ { "name": "user", "type": "Minn\\Content\\UserRecord", "shape": "", "default": null, "doc": "" }, { "name": "expiration", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "token", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "scheme", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 117, "end": 122 } ] }, { "name": "Minn\\Auth\\AuthFailure", "short": "AuthFailure", "namespace": "Minn\\Auth", "kind": "final readonly class", "file": "public/minn/src/Minn/Auth/AuthFailure.php", "lines": 26, "doc": "Why a request is not authenticated, as the reference's error code: a\nmissing or invalid cookie, or a good one sent without a nonce, is\nrest_not_logged_in (the request is simply anonymous); a good cookie with\na nonce that does not verify is rest_cookie_invalid_nonce. The reason\ntells a good cookie sent without its nonce apart: that request is\nnobody, whoever plugin code then names.", "implements": [], "extends": null, "uses": [], "usedBy": [ "Minn\\Auth\\Authenticator", "Minn\\Rest\\Caller" ], "constructor": { "signature": "__construct(string $code, string $reason = '')", "doc": "", "shapes": [], "params": [ { "name": "code", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "reason", "type": "string", "shape": "", "default": "''", "doc": "" } ], "visibility": "public", "line": 19, "end": 21 }, "cases": [], "constants": [ { "name": "COOKIE_WITHOUT_NONCE", "value": "'a sign-in cookie without its nonce'", "doc": "", "visibility": "public" } ], "properties": [ { "name": "code", "type": "string", "readonly": true, "static": false, "doc": "", "visibility": "public", "promoted": true }, { "name": "reason", "type": "string", "readonly": true, "static": false, "doc": "", "visibility": "public", "promoted": true } ], "methods": [ { "routes": [], "name": "cookieWithoutNonce", "static": true, "visibility": "public", "signature": "cookieWithoutNonce(): self", "doc": "A good sign-in cookie sent without the nonce that would let it vouch for its user.", "shapes": [], "params": [], "line": 24, "end": 27 }, { "routes": [], "name": "notLoggedIn", "static": true, "visibility": "public", "signature": "notLoggedIn(): self", "doc": "No usable session.", "shapes": [], "params": [], "line": 30, "end": 33 }, { "routes": [], "name": "invalidNonce", "static": true, "visibility": "public", "signature": "invalidNonce(): self", "doc": "A session whose nonce did not verify.", "shapes": [], "params": [], "line": 36, "end": 39 } ] }, { "name": "Minn\\Auth\\Authenticated", "short": "Authenticated", "namespace": "Minn\\Auth", "kind": "final readonly class", "file": "public/minn/src/Minn/Auth/Authenticated.php", "lines": 16, "doc": "A validated session: the user row and the raw session token behind it.", "implements": [], "extends": null, "uses": [ "Minn\\Content\\UserRecord" ], "usedBy": [ "Minn\\Admin\\AppController", "Minn\\Admin\\BootPayload", "Minn\\Auth\\Authenticator", "Minn\\Auth\\Cookie", "Minn\\Auth\\SignIn", "Minn\\Engine", "Minn\\Front\\AdminBar", "Minn\\Login\\LoginController", "Minn\\Rest\\Api", "Minn\\Rest\\Caller" ], "constructor": { "signature": "__construct(Minn\\Content\\UserRecord $user, string $token, ?array $applicationPassword = NULL)", "doc": "", "shapes": [ "@param array|null $applicationPassword the record that authenticated this call, when Basic auth did" ], "params": [ { "name": "user", "type": "Minn\\Content\\UserRecord", "shape": "", "default": null, "doc": "" }, { "name": "token", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "applicationPassword", "type": "?array", "shape": "array|null", "default": "NULL", "doc": "the record that authenticated this call, when Basic auth did" } ], "visibility": "public", "line": 13, "end": 18 }, "cases": [], "constants": [], "properties": [ { "name": "user", "type": "Minn\\Content\\UserRecord", "readonly": true, "static": false, "doc": "", "visibility": "public", "promoted": true }, { "name": "token", "type": "string", "readonly": true, "static": false, "doc": "", "visibility": "public", "promoted": true }, { "name": "applicationPassword", "type": "?array", "readonly": true, "static": false, "doc": "", "visibility": "public", "promoted": true } ], "methods": [ { "routes": [], "name": "id", "static": false, "visibility": "public", "signature": "id(): int", "doc": "The signed-in user's id.", "shapes": [], "params": [], "line": 21, "end": 24 } ] }, { "name": "Minn\\Auth\\Authenticator", "short": "Authenticator", "namespace": "Minn\\Auth", "kind": "final readonly class", "file": "public/minn/src/Minn/Auth/Authenticator.php", "lines": 149, "doc": "Resolves the current user two ways. A page load carries the cookie alone;\na REST call must also carry a nonce bound to the same session.", "implements": [], "extends": null, "uses": [ "Minn\\Auth\\ApplicationPasswords", "Minn\\Auth\\AuthFailure", "Minn\\Auth\\Authenticated", "Minn\\Auth\\Cookie", "Minn\\Auth\\Nonce", "Minn\\Auth\\Password", "Minn\\Auth\\Sessions", "Minn\\Content\\UserRecord", "Minn\\Content\\Users", "Minn\\Db", "Minn\\Http\\Request", "Minn\\Runtime\\Runtime" ], "usedBy": [ "Minn\\Admin\\AppController", "Minn\\Engine", "Minn\\Login\\LoginController", "Minn\\Rest\\ApplicationPasswordsController", "Minn\\Rest\\Caller", "Minn\\Rest\\IndexController", "Minn\\Rest\\Services" ], "constructor": { "signature": "__construct(Minn\\Auth\\Cookie $cookie, Minn\\Content\\Users $users)", "doc": "", "shapes": [], "params": [ { "name": "cookie", "type": "Minn\\Auth\\Cookie", "shape": "", "default": null, "doc": "" }, { "name": "users", "type": "Minn\\Content\\Users", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 19, "end": 23 }, "cases": [], "constants": [ { "name": "NOBODY", "value": "'$wp$2y$10$q/tQZiHVAKXuCoJIeZTH0.rb6Otms4vDKv0NrPeGKdvracPiLPy4W'", "doc": "A real hash of a password nobody knows, checked against when the user does not exist so the answer takes as long either way.", "visibility": "private" } ], "properties": [ { "name": "cookie", "type": "Minn\\Auth\\Cookie", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "users", "type": "Minn\\Content\\Users", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [], "name": "fromDb", "static": true, "visibility": "public", "signature": "fromDb(Minn\\Db $db): self", "doc": "An authenticator over the shared database door.", "shapes": [], "params": [ { "name": "db", "type": "Minn\\Db", "shape": "", "default": null, "doc": "" } ], "line": 26, "end": 30 }, { "routes": [], "name": "session", "static": false, "visibility": "public", "signature": "session(array $cookies): Minn\\Auth\\Authenticated|Minn\\Auth\\AuthFailure", "doc": "The session the cookie jar carries, or why there is none.", "shapes": [ "@param array $cookies" ], "params": [ { "name": "cookies", "type": "array", "shape": "array", "default": null, "doc": "" } ], "line": 37, "end": 44 }, { "routes": [], "name": "rest", "static": false, "visibility": "public", "signature": "rest(array $cookies, ?string $nonce): Minn\\Auth\\Authenticated|Minn\\Auth\\AuthFailure", "doc": "The session for a REST call: the cookie, then the nonce. A cookie sent\nwithout a nonce is no sign-in at all (the request goes on signed out,\nas the reference's cookie check makes it); one with a nonce that does\nnot verify is refused (suite auth, checked against the reference).", "shapes": [ "@param array $cookies" ], "params": [ { "name": "cookies", "type": "array", "shape": "array", "default": null, "doc": "" }, { "name": "nonce", "type": "?string", "shape": "", "default": null, "doc": "" } ], "line": 54, "end": 67 }, { "routes": [], "name": "restFromRequest", "static": false, "visibility": "public", "signature": "restFromRequest(Minn\\Http\\Request $request): Minn\\Auth\\Authenticated|Minn\\Auth\\AuthFailure", "doc": "A REST caller: the cookie session with its nonce first; failing that,\nHTTP Basic credentials carrying an application password, which need no\nnonce. A wrong Basic pair is reported as not logged in.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 74, "end": 81 }, { "routes": [], "name": "applicationPassword", "static": false, "visibility": "public", "signature": "applicationPassword(Minn\\Http\\Request $request): ?Minn\\Auth\\Authenticated", "doc": "The user an Authorization: Basic header's application password unlocks, with the use recorded.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 84, "end": 105 }, { "routes": [], "name": "basicCredentials", "static": true, "visibility": "public", "signature": "basicCredentials(Minn\\Http\\Request $request): ?array", "doc": "The login and password an Authorization: Basic header carries, or null.", "shapes": [ "@return array{0: string, 1: string}|null" ], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 112, "end": 124 }, { "routes": [], "name": "applicationPasswordsAvailable", "static": true, "visibility": "public", "signature": "applicationPasswordsAvailable(Minn\\Http\\Request $request): bool", "doc": "Application passwords need HTTPS, unless plugin code says otherwise through the reference's filter.", "shapes": [], "params": [ { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 127, "end": 134 }, { "routes": [], "name": "applicationPasswordsAvailableFor", "static": true, "visibility": "public", "signature": "applicationPasswordsAvailableFor(Minn\\Content\\UserRecord $user): bool", "doc": "Whether Basic auth may sign this user in; the runtime's filter has the last word.", "shapes": [ "@param array $user" ], "params": [ { "name": "user", "type": "Minn\\Content\\UserRecord", "shape": "array", "default": null, "doc": "" } ], "line": 141, "end": 147 }, { "routes": [], "name": "login", "static": false, "visibility": "public", "signature": "login(string $username, string $password): ?Minn\\Content\\UserRecord", "doc": "Username and password to a user row, an outdated hash replaced as the sign-in succeeds; no session is created here.", "shapes": [], "params": [ { "name": "username", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "password", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 153, "end": 164 } ] }, { "name": "Minn\\Auth\\Capabilities", "short": "Capabilities", "namespace": "Minn\\Auth", "kind": "final readonly class", "file": "public/minn/src/Minn/Auth/Capabilities.php", "lines": 277, "doc": "The capability engine: a user's roles from {prefix}capabilities usermeta,\nwhat those roles and the user's own capabilities grant, and the meta-capability mapping for\nedit_post, delete_post, and read_post.", "implements": [], "extends": null, "uses": [ "Minn\\Auth\\RegisteredCaps", "Minn\\Auth\\Roles", "Minn\\Auth\\TypeCapabilities", "Minn\\Content\\Posts", "Minn\\Content\\RowCache", "Minn\\Content\\Users", "Minn\\Db", "Minn\\Runtime\\Runtime", "Minn\\Support\\Serialized" ], "usedBy": [ "Minn\\Admin\\ActivityFeed", "Minn\\Admin\\AdminTypes", "Minn\\Admin\\AppController", "Minn\\Admin\\BootPayload", "Minn\\Admin\\Dashboard", "Minn\\Admin\\HiddenIntegrations", "Minn\\Admin\\LanguageController", "Minn\\Admin\\Notifications", "Minn\\Admin\\UploadsSize", "Minn\\Cli\\Runtime", "Minn\\Content\\Reader", "Minn\\Context", "Minn\\Engine", "Minn\\Front\\AdminBar", "Minn\\Rest\\Caller", "Minn\\Rest\\Services", "Minn\\Runtime\\Runtime" ], "constructor": { "signature": "__construct(Minn\\Db $db, Minn\\Content\\Users $users, Minn\\Auth\\Roles $roles)", "doc": "", "shapes": [], "params": [ { "name": "db", "type": "Minn\\Db", "shape": "", "default": null, "doc": "" }, { "name": "users", "type": "Minn\\Content\\Users", "shape": "", "default": null, "doc": "" }, { "name": "roles", "type": "Minn\\Auth\\Roles", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 21, "end": 26 }, "cases": [], "constants": [], "properties": [ { "name": "db", "type": "Minn\\Db", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "users", "type": "Minn\\Content\\Users", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "roles", "type": "Minn\\Auth\\Roles", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [], "name": "fromDb", "static": true, "visibility": "public", "signature": "fromDb(Minn\\Db $db): self", "doc": "The capability engine over the shared database door.", "shapes": [], "params": [ { "name": "db", "type": "Minn\\Db", "shape": "", "default": null, "doc": "" } ], "line": 29, "end": 32 }, { "routes": [], "name": "roles", "static": false, "visibility": "public", "signature": "roles(): Minn\\Auth\\Roles", "doc": "The role definitions.", "shapes": [], "params": [], "line": 35, "end": 38 }, { "routes": [], "name": "capsOf", "static": false, "visibility": "public", "signature": "capsOf(int $userId): array", "doc": "The capabilities stored on the user, as stored: role names and the\ncapabilities granted (or taken away) one by one.", "shapes": [ "@return array" ], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 46, "end": 51 }, { "routes": [], "name": "rolesOf", "static": false, "visibility": "public", "signature": "rolesOf(int $userId): array", "doc": "The role slugs a user holds: each stored capability that names a\nregistered role, whatever it is set to (probe: the reference counts\n'editor' => false as a role). One a plugin granted but never\nregistered does not count.", "shapes": [ "@return list role slugs" ], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 61, "end": 65 }, { "routes": [], "name": "allcapsOf", "static": false, "visibility": "public", "signature": "allcapsOf(int $userId): array", "doc": "Everything a user holds, as the reference's allcaps: each role's\ncapabilities in turn, then the user's own over them, role names\nincluded, so a capability taken away one by one stays away and\ncurrent_user_can('administrator') is true for an administrator.\nValues are as stored.", "shapes": [ "@return array" ], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 76, "end": 90 }, { "routes": [], "name": "can", "static": false, "visibility": "public", "signature": "can(int $userId, string $capability, ?int $postId = NULL): bool", "doc": "Does the user hold every primitive the (possibly meta) capability maps to?", "shapes": [], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "capability", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "postId", "type": "?int", "shape": "", "default": "NULL", "doc": "" } ], "line": 99, "end": 113 }, { "routes": [], "name": "map", "static": false, "visibility": "public", "signature": "map(string $capability, int $userId, ?int $postId = NULL): array", "doc": "The primitives a capability requires, all of which must be held.", "shapes": [ "@return list" ], "params": [ { "name": "capability", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "postId", "type": "?int", "shape": "", "default": "NULL", "doc": "" } ], "line": 120, "end": 136 }, { "routes": [], "name": "fileModsAllowed", "static": true, "visibility": "private", "signature": "fileModsAllowed(string $context): bool", "doc": "Whether file changes are allowed for a capability check, as wp_is_file_mod_allowed() answers: DISALLOW_FILE_MODS, through file_mod_allowed with the check's context.", "shapes": [], "params": [ { "name": "context", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 93, "end": 96 }, { "routes": [], "name": "mapMore", "static": false, "visibility": "private", "signature": "mapMore(string $capability, int $userId, ?int $objectId): array", "doc": "The rest of the reference's meta capabilities (captured with\nmap_meta_cap for an administrator, an editor and an author): each\nnames the primitive that decides it, refuses outright, or maps\nthrough the object it is about. A name it does not know is its own\nprimitive.", "shapes": [ "@return list" ], "params": [ { "name": "capability", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "objectId", "type": "?int", "shape": "", "default": null, "doc": "" } ], "line": 147, "end": 180 }, { "routes": [], "name": "mapCommentCapability", "static": false, "visibility": "private", "signature": "mapCommentCapability(int $userId, int $commentId): array", "doc": "A comment is edited as its post is (as editing posts, when the post is gone); a comment that does not exist, by no one. @return list", "shapes": [ "@return list" ], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "commentId", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 183, "end": 193 }, { "routes": [], "name": "mapPostCapability", "static": false, "visibility": "private", "signature": "mapPostCapability(string $capability, int $userId, int $postId): array", "doc": "A post's meta capability as the reference maps it (probe post-caps):\nread_post needs read for a published post or one's own, the private\nread for a private one, and what editing needs for anything else\n(future, draft, pending, trash). Editing or deleting one's own post\nneeds the published capability while it is published or scheduled (or\nwas, before the trash), the plain one otherwise; someone else's, the\nothers capability, with the published one while it is published or\nscheduled and the private one while it is private. The privacy policy\npage needs manage_options as well.", "shapes": [ "@return list" ], "params": [ { "name": "capability", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "postId", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 208, "end": 250 }, { "routes": [], "name": "mapTermCapability", "static": false, "visibility": "private", "signature": "mapTermCapability(string $capability, int $userId, ?int $termId): ?array", "doc": "A term capability on a plugin's taxonomy as the reference maps it\n(probe rest-plugin-caps): the taxonomy's own name for it (edit_terms,\ndelete_terms, assign_terms), mapped in turn; nothing for a term that\ndoes not exist or a default term's deletion (in any taxonomy). Null\notherwise for the built-in taxonomies, whose mapping is fixed.", "shapes": [ "@return list|null" ], "params": [ { "name": "capability", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "termId", "type": "?int", "shape": "", "default": null, "doc": "" } ], "line": 261, "end": 276 }, { "routes": [], "name": "fold", "static": true, "visibility": "private", "signature": "fold(string $type, array $required): array", "doc": "", "shapes": [ "@param list $required", "@return list" ], "params": [ { "name": "type", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "required", "type": "array", "shape": "list", "default": null, "doc": "" } ], "line": 282, "end": 285 }, { "routes": [], "name": "trashedFrom", "static": false, "visibility": "private", "signature": "trashedFrom(int $postId): string", "doc": "", "shapes": [], "params": [ { "name": "postId", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 287, "end": 294 } ] }, { "name": "Minn\\Auth\\Cookie", "short": "Cookie", "namespace": "Minn\\Auth", "kind": "final readonly class", "file": "public/minn/src/Minn/Auth/Cookie.php", "lines": 92, "doc": "The sign-in cookies: username|expiration|token|hmac, with\nkey = HMAC-md5(username|fragment|expiration|token, the scheme's salt)\nhmac = HMAC-sha256(username|expiration|token, key)\nand the session live in the user's session_tokens store. The engine's own\nsign-in reads the logged_in one; check() judges any scheme's the way\nwp_validate_auth_cookie reports it (probe auth-cookies).", "implements": [], "extends": null, "uses": [ "Minn\\Auth\\Authenticated", "Minn\\Auth\\Password", "Minn\\Auth\\Salts", "Minn\\Auth\\Sessions", "Minn\\Content\\UserRecord", "Minn\\Content\\Users", "Minn\\Db" ], "usedBy": [ "Minn\\Auth\\AuthCookies", "Minn\\Auth\\Authenticator", "Minn\\Engine" ], "constructor": { "signature": "__construct(Minn\\Db $db, Minn\\Content\\Users $users, Minn\\Auth\\Sessions $sessions)", "doc": "", "shapes": [], "params": [ { "name": "db", "type": "Minn\\Db", "shape": "", "default": null, "doc": "" }, { "name": "users", "type": "Minn\\Content\\Users", "shape": "", "default": null, "doc": "" }, { "name": "sessions", "type": "Minn\\Auth\\Sessions", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 21, "end": 26 }, "cases": [], "constants": [], "properties": [ { "name": "db", "type": "Minn\\Db", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "users", "type": "Minn\\Content\\Users", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "sessions", "type": "Minn\\Auth\\Sessions", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [], "name": "name", "static": false, "visibility": "public", "signature": "name(): string", "doc": "The cookie name this site uses: a hash of the siteurl option.", "shapes": [], "params": [], "line": 29, "end": 32 }, { "routes": [], "name": "mint", "static": false, "visibility": "public", "signature": "mint(Minn\\Content\\UserRecord $user, int $expiration, string $token): string", "doc": "A sign-in cookie value for a user, expiry, and session token.", "shapes": [], "params": [ { "name": "user", "type": "Minn\\Content\\UserRecord", "shape": "", "default": null, "doc": "" }, { "name": "expiration", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "token", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 35, "end": 40 }, { "routes": [], "name": "validate", "static": false, "visibility": "public", "signature": "validate(string $value): ?Minn\\Auth\\Authenticated", "doc": "The session a logged_in cookie value proves, or null when any part fails.", "shapes": [], "params": [ { "name": "value", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 43, "end": 51 }, { "routes": [], "name": "check", "static": false, "visibility": "public", "signature": "check(string $username, string $expiration, string $token, string $hmac, string $scheme, int $grace = 0): array", "doc": "A cookie's parts judged under a scheme, in the reference's order:\nexpired (past its expiration plus $grace), bad_username, bad_hash (an\nunknown scheme never matches), bad_session_token, else valid with its\nuser.", "shapes": [ "@return array{string, ?UserRecord}" ], "params": [ { "name": "username", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "expiration", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "token", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "hmac", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "scheme", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "grace", "type": "int", "shape": "", "default": "0", "doc": "" } ], "line": 61, "end": 78 }, { "routes": [], "name": "fromJar", "static": false, "visibility": "public", "signature": "fromJar(array $cookies): ?string", "doc": "The logged_in cookie from a request's cookie jar: the canonical name\nfirst, then any logged_in cookie, since tooling may send a name\nderived from a different host.", "shapes": [ "@param array $cookies" ], "params": [ { "name": "cookies", "type": "array", "shape": "array", "default": null, "doc": "" } ], "line": 87, "end": 99 }, { "routes": [], "name": "signature", "static": true, "visibility": "public", "signature": "signature(string $username, string $fragment, int $expiration, string $token, string $scheme = 'logged_in'): ?string", "doc": "A cookie's hmac under a scheme's salt, or null for a scheme with none.", "shapes": [], "params": [ { "name": "username", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "fragment", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "expiration", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "token", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "scheme", "type": "string", "shape": "", "default": "'logged_in'", "doc": "" } ], "line": 102, "end": 109 } ] }, { "name": "Minn\\Auth\\FastHash", "short": "FastHash", "namespace": "Minn\\Auth", "kind": "final class", "file": "public/minn/src/Minn/Auth/FastHash.php", "lines": 23, "doc": "The reference's hash for high-entropy secrets (\"$generic$\", WordPress 6.8\nand later): a 30-byte keyed BLAKE2b digest (sodium's generic hash, keyed\nby the scheme's fixed label) in URL-safe base64 without padding. Reset\nkeys and application passwords are stored this way, so a secret minted\non either stack verifies on the other. Pinned against hashes the\nreference made (tests/unit/auth-hashes.php). Without the sodium\nextension nothing can be hashed or verified this way.", "implements": [], "extends": null, "uses": [], "usedBy": [ "Minn\\Auth\\ApplicationPasswords", "Minn\\Auth\\PasswordReset" ], "constructor": null, "cases": [], "constants": [ { "name": "PREFIX", "value": "'$generic$'", "doc": "", "visibility": "public" }, { "name": "KEY", "value": "'wp_fast_hash_6.8+'", "doc": "", "visibility": "private" } ], "properties": [], "methods": [ { "routes": [], "name": "available", "static": true, "visibility": "public", "signature": "available(): bool", "doc": "Whether this PHP can make and check these hashes (the sodium extension).", "shapes": [], "params": [], "line": 22, "end": 25 }, { "routes": [], "name": "hash", "static": true, "visibility": "public", "signature": "hash(string $secret): string", "doc": "The \"$generic$\" hash of a secret.", "shapes": [], "params": [ { "name": "secret", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 28, "end": 31 }, { "routes": [], "name": "verify", "static": true, "visibility": "public", "signature": "verify(string $secret, string $hash): bool", "doc": "Whether a secret matches a \"$generic$\" hash; false for any other kind of hash.", "shapes": [], "params": [ { "name": "secret", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "hash", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 34, "end": 37 } ] }, { "name": "Minn\\Auth\\LoginThrottle", "short": "LoginThrottle", "namespace": "Minn\\Auth", "kind": "final readonly class", "file": "public/minn/src/Minn/Auth/LoginThrottle.php", "lines": 82, "doc": "Failed sign-ins per address, so a password guesser meets a wall: twenty\nfailures in fifteen minutes and the address waits out the window. The\ncounters live in the options table (autoload off), one row per address,\nas \"window start:count\"; a successful sign-in clears the row. An IPv6\naddress counts as its /64, the block one subscriber is handed, so\nstepping through it buys no fresh tries; each failure is counted in one\nstatement, so failures arriving together are all counted.", "implements": [], "extends": null, "uses": [ "Minn\\Db", "Minn\\Runtime\\Runtime" ], "usedBy": [ "Minn\\Auth\\SignIn", "Minn\\Cron\\Cron", "Minn\\Engine" ], "constructor": { "signature": "__construct(Minn\\Db $db)", "doc": "", "shapes": [], "params": [ { "name": "db", "type": "Minn\\Db", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 25, "end": 27 }, "cases": [], "constants": [ { "name": "LIMIT", "value": "20", "doc": "", "visibility": "public" }, { "name": "WINDOW", "value": "900", "doc": "", "visibility": "public" }, { "name": "PREFIX", "value": "'minn_login_throttle_'", "doc": "", "visibility": "private" } ], "properties": [ { "name": "db", "type": "Minn\\Db", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [], "name": "retryAfter", "static": false, "visibility": "public", "signature": "retryAfter(string $address, ?int $now = NULL): ?int", "doc": "Seconds the address must wait, or null when it may try.", "shapes": [], "params": [ { "name": "address", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "now", "type": "?int", "shape": "", "default": "NULL", "doc": "" } ], "line": 30, "end": 38 }, { "routes": [], "name": "recordFailure", "static": false, "visibility": "public", "signature": "recordFailure(string $address, ?int $now = NULL): void", "doc": "Counts one failed sign-in from an address within the current window.", "shapes": [], "params": [ { "name": "address", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "now", "type": "?int", "shape": "", "default": "NULL", "doc": "" } ], "line": 41, "end": 56 }, { "routes": [], "name": "clear", "static": false, "visibility": "public", "signature": "clear(string $address): void", "doc": "Forgets an address's failures.", "shapes": [], "params": [ { "name": "address", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 59, "end": 63 }, { "routes": [], "name": "sweep", "static": true, "visibility": "public", "signature": "sweep(Minn\\Db $db, int $now): int", "doc": "Drops counters whose window has passed, at most a thousand in one\nstatement, however many addresses have failed; the number dropped.", "shapes": [], "params": [ { "name": "db", "type": "Minn\\Db", "shape": "", "default": null, "doc": "" }, { "name": "now", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 80, "end": 86 }, { "routes": [], "name": "read", "static": false, "visibility": "private", "signature": "read(string $address): array", "doc": "", "shapes": [ "@return array{0: int, 1: int} window start and failure count" ], "params": [ { "name": "address", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 66, "end": 74 }, { "routes": [], "name": "key", "static": true, "visibility": "private", "signature": "key(string $address): string", "doc": "The counter's option: the address's, or an IPv6 address's /64. An\naddress whose first 64 bits are zero (an IPv4 client a dual-stack\nserver shows as ::ffff:a.b.c.d) keeps its whole address, or every IPv4\nvisitor would share one counter.", "shapes": [], "params": [ { "name": "address", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 94, "end": 99 } ] }, { "name": "Minn\\Auth\\Nonce", "short": "Nonce", "namespace": "Minn\\Auth", "kind": "final class", "file": "public/minn/src/Minn/Auth/Nonce.php", "lines": 46, "doc": "The wp_rest nonce: ten characters of HMAC-md5(tick|wp_rest|uid|token)\nunder the nonce salt, accepted for the current tick and the one before.", "implements": [], "extends": null, "uses": [ "Minn\\Auth\\Salts", "Minn\\Runtime\\Runtime" ], "usedBy": [ "Minn\\Admin\\BootPayload", "Minn\\Auth\\Authenticator", "Minn\\Front\\AdminBar", "Minn\\Front\\Resolver", "Minn\\Login\\LoginController", "Minn\\Rest\\RevisionsController" ], "constructor": null, "cases": [], "constants": [ { "name": "LIFETIME", "value": "86400", "doc": "", "visibility": "private" } ], "properties": [], "methods": [ { "routes": [], "name": "lifetime", "static": true, "visibility": "public", "signature": "lifetime(string|int $action): int", "doc": "How long a nonce for an action lives, in seconds (nonce_life, handed\nthe action as the caller gave it; probe filter-inputs-3). A plugin's\nfilter reaches every nonce the engine makes and checks once plugins\nhave loaded; a lifetime under a second keeps the default.", "shapes": [], "params": [ { "name": "action", "type": "string|int", "shape": "", "default": null, "doc": "" } ], "line": 23, "end": 27 }, { "routes": [], "name": "tick", "static": true, "visibility": "public", "signature": "tick(string|int $action = -1): float", "doc": "The current half-life tick a nonce for an action is bound to.", "shapes": [], "params": [ { "name": "action", "type": "string|int", "shape": "", "default": "-1", "doc": "" } ], "line": 30, "end": 33 }, { "routes": [], "name": "create", "static": true, "visibility": "public", "signature": "create(int $userId, string $token, string|int $action = 'wp_rest'): string", "doc": "A wp_rest nonce for a user and session token at the current tick.", "shapes": [], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "token", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "action", "type": "string|int", "shape": "", "default": "'wp_rest'", "doc": "" } ], "line": 36, "end": 39 }, { "routes": [], "name": "verify", "static": true, "visibility": "public", "signature": "verify(string $nonce, int $userId, string $token, string $action = 'wp_rest'): bool", "doc": "Whether a nonce is valid at this tick or the one before.", "shapes": [], "params": [ { "name": "nonce", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "token", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "action", "type": "string", "shape": "", "default": "'wp_rest'", "doc": "" } ], "line": 42, "end": 51 }, { "routes": [], "name": "at", "static": true, "visibility": "public", "signature": "at(float $tick, int $userId, string $token, string $action): string", "doc": "The nonce for a given tick.", "shapes": [], "params": [ { "name": "tick", "type": "float", "shape": "", "default": null, "doc": "" }, { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "token", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "action", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 54, "end": 57 } ] }, { "name": "Minn\\Auth\\Password", "short": "Password", "namespace": "Minn\\Auth", "kind": "final class", "file": "public/minn/src/Minn/Auth/Password.php", "lines": 71, "doc": "The stored password scheme. A modern \"$wp$2y$...\" value is bcrypt over\nbase64(HMAC-sha384(password, \"wp-sha384\")) at PHP's default cost (10 up\nto PHP 8.3, 12 from 8.4) unless the site's options say otherwise; under\nanother algorithm (argon2id) the hash is that algorithm's own. Legacy\nphpass \"$P$\" hashes and any other password_hash() value still verify, and\na sign-in replaces whatever needsRehash() says is outdated (probe\npassword-rehash).", "implements": [], "extends": null, "uses": [ "Minn\\Auth\\PortableHash" ], "usedBy": [ "Minn\\Auth\\ApplicationPasswords", "Minn\\Auth\\AuthCookies", "Minn\\Auth\\Authenticator", "Minn\\Auth\\Cookie", "Minn\\Cli\\UserCommand", "Minn\\Content\\Users", "Minn\\Rest\\UsersController" ], "constructor": null, "cases": [], "constants": [], "properties": [], "methods": [ { "routes": [], "name": "verify", "static": true, "visibility": "public", "signature": "verify(string $password, string $hash): bool", "doc": "Whether a password matches a stored hash: the \"$wp$\" scheme, legacy\nphpass, or any hash password_hash() makes. A password over 4,096\ncharacters never matches and costs no hashing.", "shapes": [], "params": [ { "name": "password", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "hash", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 23, "end": 35 }, { "routes": [], "name": "hash", "static": true, "visibility": "public", "signature": "hash(string $password, string $algorithm = Minn\\Auth\\PASSWORD_BCRYPT, array $options = array ( )): string", "doc": "A stored hash: bcrypt in the \"$wp$\" scheme over the pre-hash, or, under\nany other algorithm, that algorithm's own hash of the password.", "shapes": [ "@param array $options password_hash() options (cost, ...); PHP's defaults when empty" ], "params": [ { "name": "password", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "algorithm", "type": "string", "shape": "", "default": "Minn\\Auth\\PASSWORD_BCRYPT", "doc": "" }, { "name": "options", "type": "array", "shape": "array", "default": "array ( )", "doc": "password_hash() options (cost, ...); PHP's defaults when empty" } ], "line": 43, "end": 52 }, { "routes": [], "name": "needsRehash", "static": true, "visibility": "public", "signature": "needsRehash(string $hash, string $algorithm = Minn\\Auth\\PASSWORD_BCRYPT, array $options = array ( )): bool", "doc": "Whether a stored hash is not the one these settings would make: under\nbcrypt, anything outside the \"$wp$\" scheme or at another cost; under\nanother algorithm, whatever PHP says is outdated for it.", "shapes": [ "@param array $options" ], "params": [ { "name": "hash", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "algorithm", "type": "string", "shape": "", "default": "Minn\\Auth\\PASSWORD_BCRYPT", "doc": "" }, { "name": "options", "type": "array", "shape": "array", "default": "array ( )", "doc": "" } ], "line": 61, "end": 67 }, { "routes": [], "name": "fragment", "static": true, "visibility": "public", "signature": "fragment(string $hash): string", "doc": "The four characters of the hash the cookie key is derived from:\noffset 8 for legacy phpass (\"$P$\") and plain bcrypt (\"$2y$\"), the LAST\nfour for anything else (\"$wp$\", argon2, whose offset 8 is the same for\nevery password). Getting this wrong yields a cookie that verifies\nnowhere while every other check passes, so the branches are pinned by\nthe auth suite and the 2026-10-13 audit's probe.", "shapes": [], "params": [ { "name": "hash", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 82, "end": 85 }, { "routes": [], "name": "prehash", "static": true, "visibility": "private", "signature": "prehash(string $password): string", "doc": "", "shapes": [], "params": [ { "name": "password", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 69, "end": 72 } ] }, { "name": "Minn\\Auth\\PasswordReset", "short": "PasswordReset", "namespace": "Minn\\Auth", "kind": "final readonly class", "file": "public/minn/src/Minn/Auth/PasswordReset.php", "lines": 78, "doc": "Password reset keys in the reference's storage shape: user_activation_key\nholds \"time:hash\", the key itself travels in the email link and is good\nfor a day. The hash is the reference's own ($generic$, FastHash), so a\nlink either stack sent works on the other. Older shapes still verify: a\nphpass hash (WordPress before 6.8) and the engine's former $minn$ HMAC.\nA matching key stored without its time (or, older still, stored as\nitself) is expired, as the reference treats it.", "implements": [], "extends": null, "uses": [ "Minn\\Auth\\FastHash", "Minn\\Auth\\PortableHash", "Minn\\Auth\\Salts", "Minn\\Content\\UserRecord", "Minn\\Content\\Users", "Minn\\Runtime\\Runtime" ], "usedBy": [ "Minn\\Cli\\UserCommand", "Minn\\Engine", "Minn\\Login\\LoginController" ], "constructor": { "signature": "__construct(Minn\\Content\\Users $users)", "doc": "", "shapes": [], "params": [ { "name": "users", "type": "Minn\\Content\\Users", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 24, "end": 26 }, "cases": [], "constants": [ { "name": "LIFETIME", "value": "86400", "doc": "", "visibility": "public" } ], "properties": [ { "name": "users", "type": "Minn\\Content\\Users", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [], "name": "issue", "static": false, "visibility": "public", "signature": "issue(Minn\\Content\\UserRecord $user): string", "doc": "Mints a key, stores its hash, returns the key for the link.", "shapes": [], "params": [ { "name": "user", "type": "Minn\\Content\\UserRecord", "shape": "", "default": null, "doc": "" } ], "line": 29, "end": 34 }, { "routes": [], "name": "mint", "static": true, "visibility": "public", "signature": "mint(): array", "doc": "A new key and the value that stores it (the time it was issued and its\nhash), for a caller that saves it itself.", "shapes": [ "@return array{0: string, 1: string}" ], "params": [], "line": 42, "end": 46 }, { "routes": [], "name": "verify", "static": false, "visibility": "public", "signature": "verify(Minn\\Content\\UserRecord $user, string $key): bool", "doc": "True when the key matches the stored hash and has not expired: a day, or what password_reset_expiration makes it.", "shapes": [], "params": [ { "name": "user", "type": "Minn\\Content\\UserRecord", "shape": "", "default": null, "doc": "" }, { "name": "key", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 49, "end": 52 }, { "routes": [], "name": "status", "static": false, "visibility": "public", "signature": "status(Minn\\Content\\UserRecord $user, string $key, int $lifetime = self::LIFETIME): string", "doc": "\"valid\", \"expired\" (a matching key past its lifetime, a day unless\ngiven), \"unstamped\" (a matching key stored without a time, which the\nreference counts expired after asking password_reset_key_expired), or\n\"invalid\".", "shapes": [], "params": [ { "name": "user", "type": "Minn\\Content\\UserRecord", "shape": "", "default": null, "doc": "" }, { "name": "key", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "lifetime", "type": "int", "shape": "", "default": "self::LIFETIME", "doc": "" } ], "line": 60, "end": 75 }, { "routes": [], "name": "clear", "static": false, "visibility": "public", "signature": "clear(Minn\\Content\\UserRecord $user): void", "doc": "Forgets a user's reset key.", "shapes": [], "params": [ { "name": "user", "type": "Minn\\Content\\UserRecord", "shape": "", "default": null, "doc": "" } ], "line": 78, "end": 81 }, { "routes": [], "name": "hash", "static": true, "visibility": "private", "signature": "hash(string $key): string", "doc": "The stored hash for a new key: the reference's own, or phpass (which it also reads) without sodium.", "shapes": [], "params": [ { "name": "key", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 84, "end": 87 }, { "routes": [], "name": "matches", "static": true, "visibility": "private", "signature": "matches(string $key, string $hash): bool", "doc": "", "shapes": [], "params": [ { "name": "key", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "hash", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 89, "end": 96 } ] }, { "name": "Minn\\Auth\\PortableHash", "short": "PortableHash", "namespace": "Minn\\Auth", "kind": "final class", "file": "public/minn/src/Minn/Auth/PortableHash.php", "lines": 86, "doc": "The portable phpass hash (\"$P$\"), from the published algorithm: an\niteration count character, an eight character salt, and MD5 iterated\nover salt and password, encoded in phpass's own base64 alphabet. The\nreference stores it in the post-password cookie (2^13 iterations, and it\naccepts nothing weaker there), and still verifies it for application\npasswords and reset keys made before its fast hash, which is why both\ndirections of each are accepted. Its pieces are public for phpass's own\nclass, PasswordHash (probe identity-internals): the base64 encoding,\nboth kinds of salt, and the hash with phpass's failure markers.", "implements": [], "extends": null, "uses": [], "usedBy": [ "Minn\\Auth\\ApplicationPasswords", "Minn\\Auth\\Password", "Minn\\Auth\\PasswordReset", "Minn\\Content\\PasswordGate", "Minn\\Login\\LoginController" ], "constructor": null, "cases": [], "constants": [ { "name": "ALPHABET", "value": "'./0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz'", "doc": "", "visibility": "public" }, { "name": "BLOWFISH_ALPHABET", "value": "'./ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'", "doc": "bcrypt's own base64 alphabet.", "visibility": "private" }, { "name": "MAX_LENGTH", "value": "4096", "doc": "The longest password hashed; a longer one is refused before any work, as the reference refuses it.", "visibility": "public" } ], "properties": [], "methods": [ { "routes": [], "name": "hash", "static": true, "visibility": "public", "signature": "hash(string $password, int $countLog2 = 13): string", "doc": "A portable hash of a password, 2^$countLog2 iterations (the reference's cookies carry 2^13); \"*\" for one too long.", "shapes": [], "params": [ { "name": "password", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "countLog2", "type": "int", "shape": "", "default": "13", "doc": "" } ], "line": 29, "end": 35 }, { "routes": [], "name": "salt", "static": true, "visibility": "public", "signature": "salt(string $input, int $countLog2): string", "doc": "A portable setting: \"$P$\", the count's character, and six bytes of salt encoded.", "shapes": [], "params": [ { "name": "input", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "countLog2", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 38, "end": 41 }, { "routes": [], "name": "blowfishSalt", "static": true, "visibility": "public", "signature": "blowfishSalt(string $input, int $countLog2): string", "doc": "A bcrypt setting: \"$2a$\", the two-digit cost, and the first sixteen bytes in bcrypt's base64.", "shapes": [], "params": [ { "name": "input", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "countLog2", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 44, "end": 55 }, { "routes": [], "name": "verify", "static": true, "visibility": "public", "signature": "verify(string $password, string $hash): bool", "doc": "Whether a password matches a portable hash from the published algorithm.", "shapes": [], "params": [ { "name": "password", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "hash", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 58, "end": 64 }, { "routes": [], "name": "crypt", "static": true, "visibility": "public", "signature": "crypt(string $password, string $setting): string", "doc": "The hash for a setting; for a setting it cannot use (\"$P$\" or \"$H$\",\na count from 7 to 30, eight characters of salt) phpass's marker \"*0\",\nor \"*1\" when the setting is itself \"*0\".", "shapes": [], "params": [ { "name": "password", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "setting", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 71, "end": 85 }, { "routes": [], "name": "encode", "static": true, "visibility": "public", "signature": "encode(string $input, int $count): string", "doc": "phpass's base64: little-endian groups of three bytes, $count bytes of the input.", "shapes": [], "params": [ { "name": "input", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "count", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 88, "end": 102 } ] }, { "name": "Minn\\Auth\\RegisteredCaps", "short": "RegisteredCaps", "namespace": "Minn\\Auth", "kind": "final class", "file": "public/minn/src/Minn/Auth/RegisteredCaps.php", "lines": 24, "doc": "The capability names a plugin's post type or taxonomy registered, read\nfrom the runtime's registry once plugins are loaded (probe\nrest-plugin-caps): a type's cap object (create_posts, edit_posts,\npublish_posts...) and whether it maps meta capabilities, a taxonomy's\nterm capabilities. A built-in type's too (patterns, menu items,\ntemplates), all but posts and pages, whose families the engine knows;\nnull for those and when no runtime is up.", "implements": [], "extends": null, "uses": [ "Minn\\Runtime\\Runtime" ], "usedBy": [ "Minn\\Auth\\Capabilities", "Minn\\Auth\\TypeCapabilities", "Minn\\Rest\\TermsController" ], "constructor": null, "cases": [], "constants": [], "properties": [], "methods": [ { "routes": [], "name": "ofType", "static": true, "visibility": "public", "signature": "ofType(string $type): ?WP_Post_Type", "doc": "A post type's registered object (any but post and page), or null.", "shapes": [], "params": [ { "name": "type", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 21, "end": 30 }, { "routes": [], "name": "ofTaxonomy", "static": true, "visibility": "public", "signature": "ofTaxonomy(string $taxonomy): ?WP_Taxonomy", "doc": "A plugin's taxonomy, or null.", "shapes": [], "params": [ { "name": "taxonomy", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 33, "end": 40 } ] }, { "name": "Minn\\Auth\\Roles", "short": "Roles", "namespace": "Minn\\Auth", "kind": "final class", "file": "public/minn/src/Minn/Auth/Roles.php", "lines": 68, "doc": "Role definitions from the site's {prefix}user_roles option, parsed by a\nbounded scan of the serialized blob, with the seeded contract copy as the\nfallback for a fresh install.", "implements": [], "extends": null, "uses": [ "Minn\\Db", "Minn\\Json" ], "usedBy": [ "Minn\\Auth\\Capabilities", "Minn\\Cli\\UserCommand", "Minn\\Content\\Users", "Minn\\Rest\\UsersController" ], "constructor": { "signature": "__construct(Minn\\Db $db)", "doc": "", "shapes": [], "params": [ { "name": "db", "type": "Minn\\Db", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 21, "end": 23 }, "cases": [], "constants": [ { "name": "LEVELS", "value": "array ( 'administrator' => 10, 'editor' => 7, 'author' => 2, 'contributor' => 1, 'subscriber' => 0, )", "doc": "", "visibility": "private" } ], "properties": [ { "name": "roles", "type": "?array", "readonly": false, "static": false, "doc": "", "visibility": "private", "promoted": false }, { "name": "db", "type": "Minn\\Db", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [], "name": "level", "static": true, "visibility": "public", "signature": "level(string $role): int", "doc": "The wp_user_level stored beside the capabilities meta.", "shapes": [], "params": [ { "name": "role", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 28, "end": 31 }, { "routes": [], "name": "serializeSingle", "static": true, "visibility": "public", "signature": "serializeSingle(string $role): string", "doc": "The {role: true} capabilities meta in its serialized form.", "shapes": [], "params": [ { "name": "role", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 34, "end": 37 }, { "routes": [], "name": "forget", "static": false, "visibility": "public", "signature": "forget(): void", "doc": "Drops the parsed map so the next read sees a rewritten option.", "shapes": [], "params": [], "line": 40, "end": 43 }, { "routes": [], "name": "all", "static": false, "visibility": "public", "signature": "all(): array", "doc": "Every role with its name and capabilities, from the option or the shipped defaults.", "shapes": [], "params": [], "line": 50, "end": 54 }, { "routes": [], "name": "parse", "static": true, "visibility": "public", "signature": "parse(?string $blob): ?array", "doc": "Each role is a string key over a two-entry array of \"name\" and\n\"capabilities\"; the capabilities map is {cap: bool}. Null when the\nblob has another shape, so the caller can fall back.", "shapes": [], "params": [ { "name": "blob", "type": "?string", "shape": "", "default": null, "doc": "" } ], "line": 63, "end": 83 } ] }, { "name": "Minn\\Auth\\Salts", "short": "Salts", "namespace": "Minn\\Auth", "kind": "final class", "file": "public/minn/src/Minn/Auth/Salts.php", "lines": 41, "doc": "The site's own secret material, read from the constants wp-config.php\ndefines, so the engine keys off exactly what the install used.", "implements": [], "extends": null, "uses": [], "usedBy": [ "Minn\\Auth\\Cookie", "Minn\\Auth\\Nonce", "Minn\\Auth\\PasswordReset", "Minn\\Engine" ], "constructor": null, "cases": [], "constants": [ { "name": "SCHEMES", "value": "array ( 'logged_in' => array ( 0 => 'LOGGED_IN_KEY', 1 => 'LOGGED_IN_SALT', ), 'nonce' => array ( 0 => 'NONCE_KEY', 1 => 'NONCE_SALT', ), 'auth' => array ( 0 => 'AUTH_KEY', 1 => 'AUTH_SALT', ), 'secure_auth' => array ( 0 => 'SECURE_AUTH_KEY', 1 => 'SECURE_AUTH_SALT', ), )", "doc": "", "visibility": "private" } ], "properties": [], "methods": [ { "routes": [], "name": "configured", "static": true, "visibility": "public", "signature": "configured(): bool", "doc": "True when every key and salt is defined and none is the installer's placeholder.", "shapes": [], "params": [], "line": 21, "end": 31 }, { "routes": [], "name": "knows", "static": true, "visibility": "public", "signature": "knows(string $scheme): bool", "doc": "Whether a scheme has a key and salt of its own (auth, secure_auth, logged_in, nonce).", "shapes": [], "params": [ { "name": "scheme", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 34, "end": 37 }, { "routes": [], "name": "for", "static": true, "visibility": "public", "signature": "for(string $scheme): string", "doc": "The key and salt of a scheme joined, as the reference feeds them to its HMACs.", "shapes": [], "params": [ { "name": "scheme", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 40, "end": 44 }, { "routes": [], "name": "hash", "static": true, "visibility": "public", "signature": "hash(string $data, string $scheme): string", "doc": "HMAC-md5 under the scheme's salt: the primitive every cookie and nonce is built from.", "shapes": [], "params": [ { "name": "data", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "scheme", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 47, "end": 50 } ] }, { "name": "Minn\\Auth\\Sessions", "short": "Sessions", "namespace": "Minn\\Auth", "kind": "final readonly class", "file": "public/minn/src/Minn/Auth/Sessions.php", "lines": 173, "doc": "The session_tokens usermeta store: {sha256(token): {expiration, ip, ua,\nlogin}}. Read by a bounded scan of the serialized blob and written by\nserializing it ourselves, so stored data is never executed.", "implements": [], "extends": null, "uses": [ "Minn\\Content\\Users" ], "usedBy": [ "Minn\\Admin\\SessionsController", "Minn\\Auth\\Authenticator", "Minn\\Auth\\Cookie", "Minn\\Engine", "Minn\\Rest\\Services" ], "constructor": { "signature": "__construct(Minn\\Content\\Users $users)", "doc": "", "shapes": [], "params": [ { "name": "users", "type": "Minn\\Content\\Users", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 16, "end": 18 }, "cases": [], "constants": [], "properties": [ { "name": "users", "type": "Minn\\Content\\Users", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [], "name": "generateToken", "static": true, "visibility": "public", "signature": "generateToken(): string", "doc": "A 43-character token; only sha256(token) is ever stored or compared.", "shapes": [], "params": [], "line": 21, "end": 24 }, { "routes": [], "name": "isLive", "static": false, "visibility": "public", "signature": "isLive(int $userId, string $token): bool", "doc": "Whether a session token is still stored and unexpired for a user.", "shapes": [], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "token", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 27, "end": 54 }, { "routes": [], "name": "create", "static": false, "visibility": "public", "signature": "create(int $userId, int $expiration, string $ip, string $userAgent): string", "doc": "Creates a session, pruning expired ones, and returns the raw token.", "shapes": [], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "expiration", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "ip", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "userAgent", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 57, "end": 67 }, { "routes": [], "name": "plain", "static": true, "visibility": "public", "signature": "plain(string $value): string", "doc": "A request-supplied field (the address, the user agent) as the store\nkeeps it: the store is read back by shape, so it carries nothing that\nlooks like the shape, and no more than 255 characters.", "shapes": [], "params": [ { "name": "value", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 74, "end": 77 }, { "routes": [], "name": "destroyAll", "static": false, "visibility": "public", "signature": "destroyAll(int $userId): void", "doc": "Ends every session of the user (a password change).", "shapes": [], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 80, "end": 83 }, { "routes": [], "name": "destroy", "static": false, "visibility": "public", "signature": "destroy(int $userId, string $token): bool", "doc": "Removes one session; true when it existed.", "shapes": [], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "token", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 86, "end": 89 }, { "routes": [], "name": "destroyKey", "static": false, "visibility": "public", "signature": "destroyKey(int $userId, string $key): bool", "doc": "Removes the session stored under a key (the sha256 of its token); true when it existed.", "shapes": [], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "key", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 92, "end": 101 }, { "routes": [], "name": "destroyOthers", "static": false, "visibility": "public", "signature": "destroyOthers(int $userId, string $keepKey): void", "doc": "Ends every session of the user except the one stored under the given key.", "shapes": [], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "keepKey", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 104, "end": 108 }, { "routes": [], "name": "read", "static": false, "visibility": "public", "signature": "read(int $userId): array", "doc": "Every stored session of a user, keyed by token hash. Each entry keeps\nits stored text under raw, so writing the store back leaves sessions\nthis request did not make exactly as they were, including anything a\nplugin attached to them.", "shapes": [ "@return array" ], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 118, "end": 131 }, { "routes": [], "name": "serialize", "static": true, "visibility": "public", "signature": "serialize(array $sessions): string", "doc": "The map in PHP's serialized form: stored entries as they were read, new ones key by key in the order given.", "shapes": [], "params": [ { "name": "sessions", "type": "array", "shape": "", "default": null, "doc": "" } ], "line": 163, "end": 170 }, { "routes": [], "name": "parseEntry", "static": true, "visibility": "private", "signature": "parseEntry(string $inner): array", "doc": "", "shapes": [], "params": [ { "name": "inner", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 133, "end": 149 }, { "routes": [], "name": "prune", "static": false, "visibility": "private", "signature": "prune(array $sessions): array", "doc": "", "shapes": [], "params": [ { "name": "sessions", "type": "array", "shape": "", "default": null, "doc": "" } ], "line": 151, "end": 155 }, { "routes": [], "name": "write", "static": false, "visibility": "private", "signature": "write(int $userId, array $sessions): void", "doc": "", "shapes": [], "params": [ { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "sessions", "type": "array", "shape": "", "default": null, "doc": "" } ], "line": 157, "end": 160 }, { "routes": [], "name": "entry", "static": true, "visibility": "private", "signature": "entry(array $entry): string", "doc": "One new session: integers for the times, strings for the rest. @param array $entry", "shapes": [ "@param array $entry" ], "params": [ { "name": "entry", "type": "array", "shape": "array", "default": null, "doc": "" } ], "line": 173, "end": 180 }, { "routes": [], "name": "string", "static": true, "visibility": "private", "signature": "string(string $value): string", "doc": "", "shapes": [], "params": [ { "name": "value", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 182, "end": 185 } ] }, { "name": "Minn\\Auth\\SignIn", "short": "SignIn", "namespace": "Minn\\Auth", "kind": "final readonly class", "file": "public/minn/src/Minn/Auth/SignIn.php", "lines": 65, "doc": "The door itself: what a sign-in surface needs beyond checking a\npassword. Sessions are minted here, the three cookies ride out on the\nresponse, and the failure counter behind the throttle is kept in one\nplace with the session store and the cookie jar it protects.", "implements": [], "extends": null, "uses": [ "Minn\\Auth\\AuthCookies", "Minn\\Auth\\Authenticated", "Minn\\Auth\\LoginThrottle", "Minn\\Content\\UserRecord", "Minn\\Http\\Request", "Minn\\Http\\Response" ], "usedBy": [ "Minn\\Engine", "Minn\\Login\\LoginController" ], "constructor": { "signature": "__construct(Minn\\Auth\\AuthCookies $cookies, Minn\\Auth\\LoginThrottle $throttle)", "doc": "", "shapes": [], "params": [ { "name": "cookies", "type": "Minn\\Auth\\AuthCookies", "shape": "", "default": null, "doc": "" }, { "name": "throttle", "type": "Minn\\Auth\\LoginThrottle", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 19, "end": 23 }, "cases": [], "constants": [], "properties": [ { "name": "cookies", "type": "Minn\\Auth\\AuthCookies", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "throttle", "type": "Minn\\Auth\\LoginThrottle", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [], "name": "retryAfter", "static": false, "visibility": "public", "signature": "retryAfter(string $address): ?int", "doc": "Seconds this address must wait before another attempt, or null when it may try now.", "shapes": [], "params": [ { "name": "address", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 26, "end": 29 }, { "routes": [], "name": "recordFailure", "static": false, "visibility": "public", "signature": "recordFailure(string $address): void", "doc": "Counts one failed attempt from an address.", "shapes": [], "params": [ { "name": "address", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 32, "end": 35 }, { "routes": [], "name": "hash", "static": false, "visibility": "public", "signature": "hash(): string", "doc": "The cookie-name hash the sign-in cookies, the postpass cookie, and the reset cookie share.", "shapes": [], "params": [], "line": 38, "end": 41 }, { "routes": [], "name": "establish", "static": false, "visibility": "public", "signature": "establish(Minn\\Http\\Response $response, Minn\\Content\\UserRecord $user, Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "Signs a user in for two days: a new session, and the response with the cookies attached for the browser session.", "shapes": [], "params": [ { "name": "response", "type": "Minn\\Http\\Response", "shape": "", "default": null, "doc": "" }, { "name": "user", "type": "Minn\\Content\\UserRecord", "shape": "", "default": null, "doc": "" }, { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 44, "end": 47 }, { "routes": [], "name": "remember", "static": false, "visibility": "public", "signature": "remember(Minn\\Http\\Response $response, Minn\\Content\\UserRecord $user, Minn\\Http\\Request $request): Minn\\Http\\Response", "doc": "Signs a user in for fourteen days, the cookies kept past the browser session: \"remember me\", and the one-time login link.", "shapes": [], "params": [ { "name": "response", "type": "Minn\\Http\\Response", "shape": "", "default": null, "doc": "" }, { "name": "user", "type": "Minn\\Content\\UserRecord", "shape": "", "default": null, "doc": "" }, { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" } ], "line": 50, "end": 53 }, { "routes": [], "name": "end", "static": false, "visibility": "public", "signature": "end(Minn\\Http\\Response $response, Minn\\Auth\\Authenticated $session): Minn\\Http\\Response", "doc": "Ends one session and clears the cookies from the response, unless send_auth_cookies says not to (AuthCookies::clearing).", "shapes": [], "params": [ { "name": "response", "type": "Minn\\Http\\Response", "shape": "", "default": null, "doc": "" }, { "name": "session", "type": "Minn\\Auth\\Authenticated", "shape": "", "default": null, "doc": "" } ], "line": 63, "end": 67 }, { "routes": [], "name": "endAll", "static": false, "visibility": "public", "signature": "endAll(Minn\\Http\\Response $response, int $userId): Minn\\Http\\Response", "doc": "Ends every session of a user (a password reset) and clears the cookies from the response.", "shapes": [], "params": [ { "name": "response", "type": "Minn\\Http\\Response", "shape": "", "default": null, "doc": "" }, { "name": "userId", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 70, "end": 74 }, { "routes": [], "name": "clear", "static": false, "visibility": "public", "signature": "clear(Minn\\Http\\Response $response): Minn\\Http\\Response", "doc": "The response with the sign-in cookies cleared.", "shapes": [], "params": [ { "name": "response", "type": "Minn\\Http\\Response", "shape": "", "default": null, "doc": "" } ], "line": 77, "end": 80 }, { "routes": [], "name": "open", "static": false, "visibility": "private", "signature": "open(Minn\\Http\\Response $response, Minn\\Content\\UserRecord $user, Minn\\Http\\Request $request, int $days): Minn\\Http\\Response", "doc": "A session longer than the two-day default is one to keep past the browser session, as the reference's remember-me does.", "shapes": [], "params": [ { "name": "response", "type": "Minn\\Http\\Response", "shape": "", "default": null, "doc": "" }, { "name": "user", "type": "Minn\\Content\\UserRecord", "shape": "", "default": null, "doc": "" }, { "name": "request", "type": "Minn\\Http\\Request", "shape": "", "default": null, "doc": "" }, { "name": "days", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 56, "end": 60 } ] }, { "name": "Minn\\Auth\\TypeCapabilities", "short": "TypeCapabilities", "namespace": "Minn\\Auth", "kind": "final readonly class", "file": "public/minn/src/Minn/Auth/TypeCapabilities.php", "lines": 51, "doc": "The capability names a post type's permissions are built from. Posts and\npages own their families (edit_posts, edit_others_pages, ...). Navigation\nmenus fold every one of them onto edit_theme_options, which is why an\neditor may read a menu and only an administrator may change one; the\nreference's own registration says the same thing. A plugin's type\nanswers with the names it registered.", "implements": [], "extends": null, "uses": [ "Minn\\Auth\\RegisteredCaps" ], "usedBy": [ "Minn\\Auth\\Capabilities", "Minn\\Rest\\PolicyGate", "Minn\\Rest\\PostObject", "Minn\\Rest\\PostsController", "Minn\\Rest\\PostsWriteController" ], "constructor": null, "cases": [], "constants": [ { "name": "FOLDED", "value": "array ( 'wp_navigation' => 'edit_theme_options', )", "doc": "Types whose whole cap family collapses to a single name.", "visibility": "private" } ], "properties": [], "methods": [ { "routes": [], "name": "of", "static": true, "visibility": "public", "signature": "of(string $type, string $capability): string", "doc": "A cap name built from the post/page family, folded when the type folds, or the plugin type's own name for it (probe rest-plugin-caps).", "shapes": [], "params": [ { "name": "type", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "capability", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 21, "end": 28 }, { "routes": [], "name": "create", "static": true, "visibility": "public", "signature": "create(string $type): string", "doc": "The capability creating a post of the type needs: the edit capability, or a plugin type's create_posts.", "shapes": [], "params": [ { "name": "type", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 31, "end": 34 }, { "routes": [], "name": "plural", "static": true, "visibility": "public", "signature": "plural(string $type): string", "doc": "The capability stem of a type: pages for page, posts for everything else.", "shapes": [], "params": [ { "name": "type", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 37, "end": 40 }, { "routes": [], "name": "edit", "static": true, "visibility": "public", "signature": "edit(string $type): string", "doc": "The edit capability of a type.", "shapes": [], "params": [ { "name": "type", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 43, "end": 46 }, { "routes": [], "name": "editOthers", "static": true, "visibility": "public", "signature": "editOthers(string $type): string", "doc": "The edit-others capability of a type.", "shapes": [], "params": [ { "name": "type", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 49, "end": 52 }, { "routes": [], "name": "publish", "static": true, "visibility": "public", "signature": "publish(string $type): string", "doc": "The publish capability of a type.", "shapes": [], "params": [ { "name": "type", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 55, "end": 58 }, { "routes": [], "name": "readPrivate", "static": true, "visibility": "public", "signature": "readPrivate(string $type): string", "doc": "The read-private capability of a type.", "shapes": [], "params": [ { "name": "type", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 61, "end": 64 } ] }, { "name": "Minn\\Autoloader", "short": "Autoloader", "namespace": "Minn", "kind": "final class", "file": "public/minn/src/Minn/Autoloader.php", "lines": 16, "doc": "PSR-4 for the Minn namespace: Minn\\Http\\Request lives at src/Minn/Http/Request.php.", "implements": [], "extends": null, "uses": [ "Minn\\Http\\Request" ], "usedBy": [], "constructor": null, "cases": [], "constants": [], "properties": [], "methods": [ { "routes": [], "name": "register", "static": true, "visibility": "public", "signature": "register(): void", "doc": "Registers the PSR-4 loader for the Minn namespace.", "shapes": [], "params": [], "line": 11, "end": 22 } ] }, { "name": "Minn\\Blocks\\Attributes", "short": "Attributes", "namespace": "Minn\\Blocks", "kind": "final readonly class", "file": "public/minn/src/Minn/Blocks/Attributes.php", "lines": 30, "doc": "The JSON object a block delimiter carries, read in place. Rewriting one\nblock's attributes must not disturb the rest of the markup, so callers\ntake the object's exact substring rather than reserializing the document.", "implements": [], "extends": null, "uses": [], "usedBy": [ "Minn\\Theme\\TemplatePartTheme", "Minn\\Theme\\TemplatePatterns" ], "constructor": null, "cases": [], "constants": [], "properties": [], "methods": [ { "routes": [], "name": "objectAt", "static": true, "visibility": "public", "signature": "objectAt(string $markup, int $at): ?string", "doc": "The JSON object starting at $at, brace-matched through any strings; null when there is none.", "shapes": [], "params": [ { "name": "markup", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "at", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 15, "end": 40 } ] }, { "name": "Minn\\Blocks\\Bindings", "short": "Bindings", "namespace": "Minn\\Blocks", "kind": "final class", "file": "public/minn/src/Minn/Blocks/Bindings.php", "lines": 138, "doc": "Block bindings (probe block-bindings): a block attribute bound to a\nsource registered with register_block_bindings_source takes the source's\nvalue as the block renders. Only the attributes a block supports bind\n(SUPPORTED, widened by block_bindings_supported_attributes and its\nper-block form); a \"__default\" pattern-overrides binding stands for every\none of them. A static block's saved HTML takes the values (rich text,\nkses'd, inside the element its definition selects; plain values set as\nthe selected element's attribute); a dynamic block renders with them.", "implements": [], "extends": null, "uses": [ "Minn\\Blocks\\Block", "Minn\\Runtime\\Runtime" ], "usedBy": [ "Minn\\Blocks\\Renderer" ], "constructor": null, "cases": [], "constants": [ { "name": "SUPPORTED", "value": "array ( 'core/paragraph' => array ( 0 => 'content', ), 'core/heading' => array ( 0 => 'content', ), 'core/image' => array ( 0 => 'id', 1 => 'url', 2 => 'title', 3 => 'alt', 4 => 'caption', ), 'core/button' => array ( 0 => 'url', 1 => 'text', 2 => 'linkTarget', 3 => 'rel', ), 'core/post-date' => array ( 0 => 'datetime', ), 'core/navigation-link' => array ( 0 => 'url', ), 'core/navigation-submenu' => array ( 0 => 'url', ), )", "doc": "", "visibility": "public" } ], "properties": [], "methods": [ { "routes": [], "name": "supported", "static": true, "visibility": "public", "signature": "supported(string $name): array", "doc": "The attributes a block may bind (get_block_bindings_supported_attributes). @return list", "shapes": [ "@return list" ], "params": [ { "name": "name", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 32, "end": 37 }, { "routes": [], "name": "values", "static": true, "visibility": "public", "signature": "values(Minn\\Blocks\\Block $block, array $context): array", "doc": "The bound attributes' values for a block about to render, as the\nsources answer them for a WP_Block made with the context given (each\nsource also seeing the context it uses); the expanded bindings ride\nalong under metadata for a pattern-overrides default. Empty when\nnothing is bound or nothing answered.", "shapes": [ "@param array $context", "@return array" ], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "context", "type": "array", "shape": "array", "default": null, "doc": "" } ], "line": 49, "end": 80 }, { "routes": [], "name": "html", "static": true, "visibility": "public", "signature": "html(string $html, string $blockName, array $values): string", "doc": "A static block's HTML with the bound values in place, by its type's\nattribute definitions: rich text and html replace what the selected\nelement holds; an attribute source sets the selected element's\nattribute; anything else is left alone.", "shapes": [ "@param array $values" ], "params": [ { "name": "html", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "blockName", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "values", "type": "array", "shape": "array", "default": null, "doc": "" } ], "line": 90, "end": 103 }, { "routes": [], "name": "inner", "static": true, "visibility": "private", "signature": "inner(string $html, array $selectors, string $value): string", "doc": "What the first element matching a selector holds (the block's first element counts), replaced. @param list $selectors", "shapes": [ "@param list $selectors" ], "params": [ { "name": "html", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "selectors", "type": "array", "shape": "list", "default": null, "doc": "" }, { "name": "value", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 106, "end": 124 }, { "routes": [], "name": "closing", "static": true, "visibility": "private", "signature": "closing(string $html, string $tag, int $from): ?int", "doc": "Where the element opened before $from closes: the offset of its \" $block", "shapes": [ "@param array $block" ], "params": [ { "name": "block", "type": "array", "shape": "array", "default": null, "doc": "" } ], "line": 33, "end": 42 }, { "routes": [], "name": "withAttrs", "static": false, "visibility": "public", "signature": "withAttrs(array $attrs): self", "doc": "The same block with other attributes. @param array $attrs", "shapes": [ "@param array $attrs" ], "params": [ { "name": "attrs", "type": "array", "shape": "array", "default": null, "doc": "" } ], "line": 45, "end": 48 }, { "routes": [], "name": "toArray", "static": false, "visibility": "public", "signature": "toArray(): array", "doc": "The block as parse_blocks hands it to plugin code.", "shapes": [ "@return array{blockName: ?string, attrs: array, innerBlocks: list>, innerHTML: string, innerContent: list}" ], "params": [], "line": 55, "end": 64 }, { "routes": [], "name": "attr", "static": false, "visibility": "public", "signature": "attr(string $key, mixed $default = NULL): mixed", "doc": "One attribute, or the default.", "shapes": [], "params": [ { "name": "key", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "default", "type": "mixed", "shape": "", "default": "NULL", "doc": "" } ], "line": 67, "end": 70 }, { "routes": [], "name": "className", "static": false, "visibility": "public", "signature": "className(): string", "doc": "The class names declared on the block's own attributes (className).", "shapes": [], "params": [], "line": 73, "end": 76 } ] }, { "name": "Minn\\Blocks\\BlockName", "short": "BlockName", "namespace": "Minn\\Blocks", "kind": "final class", "file": "public/minn/src/Minn/Blocks/BlockName.php", "lines": 17, "doc": "The block name rules: a string, lower-case, `namespace/name`.", "implements": [], "extends": null, "uses": [ "Minn\\Runtime\\Refusal" ], "usedBy": [], "constructor": null, "cases": [], "constants": [], "properties": [], "methods": [ { "routes": [], "name": "refuse", "static": true, "visibility": "public", "signature": "refuse(mixed $name): ?Minn\\Runtime\\Refusal", "doc": "Why a block name is invalid, or null when it is fine.", "shapes": [], "params": [ { "name": "name", "type": "mixed", "shape": "", "default": null, "doc": "" } ], "line": 13, "end": 25 } ] }, { "name": "Minn\\Blocks\\BlockStream", "short": "BlockStream", "namespace": "Minn\\Blocks", "kind": "final class", "file": "public/minn/src/Minn/Blocks/BlockStream.php", "lines": 285, "doc": "Block markup read one token at a time, as the reference's streaming\nblock processor reads it (probe block-processor). A delimiter is an HTML\ncomment: whitespace after \"\" or \"/-->\"\n(void). Any other comment is HTML. The HTML between delimiters comes out\nas its own token, reported as void (freeform at the top, inner HTML in a\nblock) before the delimiter that ends it, which is already read, so the\nclosing flag shows that delimiter's. Quirks kept on purpose:\n- trailing HTML after the last delimiter is dropped when it holds a\ncomment;\n- an unterminated comment is incomplete input only when it could\nstill become a delimiter, otherwise reading just stops;\n- attributes are parsed only when asked, and only that sets the JSON\nerror.", "implements": [], "extends": null, "uses": [ "Minn\\Json" ], "usedBy": [], "constructor": { "signature": "__construct(string $text)", "doc": "A stream over block markup, before its first token.", "shapes": [], "params": [ { "name": "text", "type": "string", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 54, "end": 56 }, "cases": [], "constants": [ { "name": "CLOSER", "value": "'closer'", "doc": "", "visibility": "public" }, { "name": "OPENER", "value": "'opener'", "doc": "", "visibility": "public" }, { "name": "VOID", "value": "'void'", "doc": "", "visibility": "public" }, { "name": "READY", "value": "'processor-ready'", "doc": "", "visibility": "public" }, { "name": "MATCHED", "value": "'processor-matched'", "doc": "", "visibility": "public" }, { "name": "HTML_SPAN", "value": "'processor-html-span'", "doc": "", "visibility": "public" }, { "name": "INCOMPLETE_INPUT", "value": "'incomplete-input'", "doc": "", "visibility": "public" }, { "name": "COMPLETE", "value": "'processor-complete'", "doc": "", "visibility": "public" }, { "name": "WHITESPACE", "value": "' \t \r\f'", "doc": "", "visibility": "private" }, { "name": "DELIMITER", "value": "'#^[ \\\\t\\\\n\\\\r\\\\f]+(/)?wp:([a-z][a-z0-9_-]*(?:/[a-z][a-z0-9_-]*)?)[ \\\\t\\\\n\\\\r\\\\f]+(?:(\\\\{.*\\\\})[ \\\\t\\\\n\\\\r\\\\f]+)?(/)?$#s'", "doc": "", "visibility": "private" } ], "properties": [ { "name": "state", "type": "string", "readonly": false, "static": false, "doc": "", "visibility": "private", "promoted": false }, { "name": "error", "type": "?string", "readonly": false, "static": false, "doc": "", "visibility": "private", "promoted": false }, { "name": "jsonError", "type": "int", "readonly": false, "static": false, "doc": "", "visibility": "private", "promoted": false }, { "name": "cursor", "type": "int", "readonly": false, "static": false, "doc": "", "visibility": "private", "promoted": false }, { "name": "delimiter", "type": "array", "readonly": false, "static": false, "doc": "", "visibility": "private", "promoted": false }, { "name": "html", "type": "array", "readonly": false, "static": false, "doc": "", "visibility": "private", "promoted": false }, { "name": "delimiterWaiting", "type": "bool", "readonly": false, "static": false, "doc": "", "visibility": "private", "promoted": false }, { "name": "popNext", "type": "bool", "readonly": false, "static": false, "doc": "", "visibility": "private", "promoted": false }, { "name": "open", "type": "array", "readonly": false, "static": false, "doc": "", "visibility": "private", "promoted": false }, { "name": "text", "type": "string", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [], "name": "normalize", "static": true, "visibility": "public", "signature": "normalize(string $name): string", "doc": "The name with core/ in front when it has no namespace.", "shapes": [], "params": [ { "name": "name", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 59, "end": 62 }, { "routes": [], "name": "next", "static": false, "visibility": "public", "signature": "next(): bool", "doc": "Moves to the next token, HTML or delimiter; false at the end or on incomplete input.", "shapes": [], "params": [], "line": 65, "end": 79 }, { "routes": [], "name": "state", "static": false, "visibility": "public", "signature": "state(): string", "doc": "The current token's state: one of the class constants.", "shapes": [], "params": [], "line": 82, "end": 85 }, { "routes": [], "name": "error", "static": false, "visibility": "public", "signature": "error(): ?string", "doc": "incomplete-input when the text ran out inside what could be a delimiter, else null.", "shapes": [], "params": [], "line": 88, "end": 91 }, { "routes": [], "name": "jsonError", "static": false, "visibility": "public", "signature": "jsonError(): int", "doc": "The JSON error from the last time attributes were asked for.", "shapes": [], "params": [], "line": 94, "end": 97 }, { "routes": [], "name": "delimiterType", "static": false, "visibility": "public", "signature": "delimiterType(): ?string", "doc": "opener, closer or void for a delimiter, void for HTML, null otherwise.", "shapes": [], "params": [], "line": 100, "end": 107 }, { "routes": [], "name": "closing", "static": false, "visibility": "public", "signature": "closing(): bool", "doc": "The last delimiter read had the closing flag.", "shapes": [], "params": [], "line": 110, "end": 113 }, { "routes": [], "name": "blockType", "static": false, "visibility": "public", "signature": "blockType(): ?string", "doc": "The delimiter's block type, null for anything else.", "shapes": [], "params": [], "line": 116, "end": 119 }, { "routes": [], "name": "printableType", "static": false, "visibility": "public", "signature": "printableType(): ?string", "doc": "The block type, or core/freeform for top-level HTML and #innerHTML for HTML inside a block.", "shapes": [], "params": [], "line": 122, "end": 129 }, { "routes": [], "name": "isHtml", "static": false, "visibility": "public", "signature": "isHtml(): bool", "doc": "Whether the token is HTML between delimiters.", "shapes": [], "params": [], "line": 132, "end": 135 }, { "routes": [], "name": "htmlContent", "static": false, "visibility": "public", "signature": "htmlContent(): ?string", "doc": "The HTML span's text, null for anything else.", "shapes": [], "params": [], "line": 138, "end": 141 }, { "routes": [], "name": "nonWhitespaceHtml", "static": false, "visibility": "public", "signature": "nonWhitespaceHtml(): bool", "doc": "Whether the token is HTML with something other than whitespace in it.", "shapes": [], "params": [], "line": 144, "end": 147 }, { "routes": [], "name": "breadcrumbs", "static": false, "visibility": "public", "signature": "breadcrumbs(): array", "doc": "The open block types, outermost first, with #html for an HTML span. @return list", "shapes": [ "@return list" ], "params": [], "line": 150, "end": 153 }, { "routes": [], "name": "opens", "static": false, "visibility": "public", "signature": "opens(?string $type): bool", "doc": "Whether this token opens a block (of the type, when given): never after a closer, and HTML only at the top.", "shapes": [], "params": [ { "name": "type", "type": "?string", "shape": "", "default": null, "doc": "" } ], "line": 156, "end": 165 }, { "routes": [], "name": "isType", "static": false, "visibility": "public", "signature": "isType(string $type): bool", "doc": "Whether the token is of the type; * matches anything.", "shapes": [], "params": [ { "name": "type", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 168, "end": 175 }, { "routes": [], "name": "span", "static": false, "visibility": "public", "signature": "span(): ?array", "doc": "The token's start and length in the text, null when there is no token. @return array{0: int, 1: int}|null", "shapes": [ "@return array{0: int, 1: int}|null" ], "params": [], "line": 178, "end": 185 }, { "routes": [], "name": "attributes", "static": false, "visibility": "public", "signature": "attributes(): ?array", "doc": "The delimiter's attributes, parsed now (setting the JSON error), or null. @return array|null", "shapes": [ "@return array|null" ], "params": [], "line": 188, "end": 203 }, { "routes": [], "name": "scan", "static": false, "visibility": "private", "signature": "scan(): bool", "doc": "From where the last token ended: the HTML before the next delimiter, the delimiter, or the end.", "shapes": [], "params": [], "line": 206, "end": 222 }, { "routes": [], "name": "emitHtml", "static": false, "visibility": "private", "signature": "emitHtml(int $at, int $length): bool", "doc": "", "shapes": [], "params": [ { "name": "at", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "length", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 224, "end": 232 }, { "routes": [], "name": "matchDelimiter", "static": false, "visibility": "private", "signature": "matchDelimiter(): bool", "doc": "", "shapes": [], "params": [], "line": 234, "end": 245 }, { "routes": [], "name": "finish", "static": false, "visibility": "private", "signature": "finish(?string $error): bool", "doc": "", "shapes": [], "params": [ { "name": "error", "type": "?string", "shape": "", "default": null, "doc": "" } ], "line": 247, "end": 252 }, { "routes": [], "name": "nextDelimiter", "static": false, "visibility": "private", "signature": "nextDelimiter(int $from): array|false|null", "doc": "The next delimiter from a position; null when there is none and no\ncomment came first (the rest is HTML), false when reading stops there\n(a comment came first, or one is cut off; cut off where a delimiter\ncould still begin is incomplete input).", "shapes": [ "@return array{at: int, length: int, type: string, closing: bool, name: string, json: ?string}|false|null" ], "params": [ { "name": "from", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 262, "end": 279 }, { "routes": [], "name": "commentEnd", "static": false, "visibility": "private", "signature": "commentEnd(int $at): ?int", "doc": "Where a comment starting here ends (just past it), or null when it never does.", "shapes": [], "params": [ { "name": "at", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 282, "end": 291 }, { "routes": [], "name": "couldBeDelimiter", "static": false, "visibility": "private", "signature": "couldBeDelimiter(int $at): bool", "doc": "Whether a comment cut off by the end of the text could still have become a delimiter.", "shapes": [], "params": [ { "name": "at", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 294, "end": 310 } ] }, { "name": "Minn\\Blocks\\Context", "short": "Context", "namespace": "Minn\\Blocks", "kind": "final class", "file": "public/minn/src/Minn/Blocks/Context.php", "lines": 76, "doc": "What the template blocks render against: the resolution, the main\nquery's posts, and a stack of \"current post\" frames pushed by post\ntemplates and comment templates as they loop.", "implements": [], "extends": null, "uses": [ "Minn\\Content\\CommentRecord", "Minn\\Content\\PostRecord", "Minn\\Front\\Kind", "Minn\\Front\\Resolution" ], "usedBy": [ "Minn\\Blocks\\Renderer", "Minn\\Front\\FeedController", "Minn\\Theme\\PageRenderer" ], "constructor": { "signature": "__construct(Minn\\Front\\Resolution $resolution, array $posts, int $total, int $perPage, bool $front)", "doc": "", "shapes": [ "@param list $posts the main query's page of posts" ], "params": [ { "name": "resolution", "type": "Minn\\Front\\Resolution", "shape": "", "default": null, "doc": "" }, { "name": "posts", "type": "array", "shape": "list", "default": null, "doc": "the main query's page of posts" }, { "name": "total", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "perPage", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "front", "type": "bool", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 26, "end": 33 }, "cases": [], "constants": [], "properties": [ { "name": "postStack", "type": "array", "readonly": false, "static": false, "doc": "", "visibility": "private", "promoted": false }, { "name": "comment", "type": "?Minn\\Content\\CommentRecord", "readonly": false, "static": false, "doc": "", "visibility": "private", "promoted": false }, { "name": "resolution", "type": "Minn\\Front\\Resolution", "readonly": true, "static": false, "doc": "", "visibility": "public", "promoted": true }, { "name": "posts", "type": "array", "readonly": true, "static": false, "doc": "", "visibility": "public", "promoted": true }, { "name": "total", "type": "int", "readonly": true, "static": false, "doc": "", "visibility": "public", "promoted": true }, { "name": "perPage", "type": "int", "readonly": true, "static": false, "doc": "", "visibility": "public", "promoted": true }, { "name": "front", "type": "bool", "readonly": true, "static": false, "doc": "", "visibility": "public", "promoted": true } ], "methods": [ { "routes": [], "name": "forRest", "static": true, "visibility": "public", "signature": "forRest(): self", "doc": "A context for rendering outside a page: the home resolution and no posts.", "shapes": [], "params": [], "line": 36, "end": 39 }, { "routes": [], "name": "post", "static": false, "visibility": "public", "signature": "post(): ?Minn\\Content\\PostRecord", "doc": "The post being rendered, innermost first.", "shapes": [], "params": [], "line": 42, "end": 49 }, { "routes": [], "name": "pushPost", "static": false, "visibility": "public", "signature": "pushPost(Minn\\Content\\PostRecord $post): void", "doc": "Enters a post's scope.", "shapes": [], "params": [ { "name": "post", "type": "Minn\\Content\\PostRecord", "shape": "", "default": null, "doc": "" } ], "line": 52, "end": 55 }, { "routes": [], "name": "popPost", "static": false, "visibility": "public", "signature": "popPost(): void", "doc": "Leaves the innermost post's scope.", "shapes": [], "params": [], "line": 58, "end": 61 }, { "routes": [], "name": "inLoop", "static": false, "visibility": "public", "signature": "inLoop(): bool", "doc": "Inside a post template loop (as opposed to the singular view).", "shapes": [], "params": [], "line": 64, "end": 67 }, { "routes": [], "name": "comment", "static": false, "visibility": "public", "signature": "comment(): ?Minn\\Content\\CommentRecord", "doc": "The comment being rendered, if any.", "shapes": [], "params": [], "line": 70, "end": 73 }, { "routes": [], "name": "withComment", "static": false, "visibility": "public", "signature": "withComment(?Minn\\Content\\CommentRecord $comment): void", "doc": "Enters or leaves a comment's scope.", "shapes": [], "params": [ { "name": "comment", "type": "?Minn\\Content\\CommentRecord", "shape": "", "default": null, "doc": "" } ], "line": 76, "end": 79 }, { "routes": [], "name": "paged", "static": false, "visibility": "public", "signature": "paged(): int", "doc": "The page number being rendered.", "shapes": [], "params": [], "line": 82, "end": 85 }, { "routes": [], "name": "totalPages", "static": false, "visibility": "public", "signature": "totalPages(): int", "doc": "How many pages the listing makes.", "shapes": [], "params": [], "line": 88, "end": 91 } ] }, { "name": "Minn\\Blocks\\CoreBlocks", "short": "CoreBlocks", "namespace": "Minn\\Blocks", "kind": "final class", "file": "public/minn/src/Minn/Blocks/CoreBlocks.php", "lines": 26, "doc": "The core block types' metadata as the reference registers them\n(data/blocks.json): their supports and selectors, read once.", "implements": [], "extends": null, "uses": [ "Minn\\Json" ], "usedBy": [ "Minn\\Blocks\\Layout", "Minn\\Blocks\\Renderer", "Minn\\Theme\\GlobalStyles", "Minn\\Theme\\TreeStyles" ], "constructor": null, "cases": [], "constants": [], "properties": [ { "name": "metadata", "type": "?array", "readonly": false, "static": true, "doc": "", "visibility": "private", "promoted": false } ], "methods": [ { "routes": [], "name": "metadata", "static": true, "visibility": "public", "signature": "metadata(string $name): array", "doc": "A core block type's registered metadata; empty for a name core does not register.", "shapes": [ "@return array" ], "params": [ { "name": "name", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 23, "end": 27 }, { "routes": [], "name": "supports", "static": true, "visibility": "public", "signature": "supports(string $name): array", "doc": "A core block type's supports.", "shapes": [ "@return array" ], "params": [ { "name": "name", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 34, "end": 37 } ] }, { "name": "Minn\\Blocks\\Duotone", "short": "Duotone", "namespace": "Minn\\Blocks", "kind": "final class", "file": "public/minn/src/Minn/Blocks/Duotone.php", "lines": 79, "doc": "Duotone filters (probe block-supports): a CSS color read into its red,\ngreen, blue (0 to 255) and alpha (0 to 1, to two places) channels, and\nthe hidden SVG filter that maps an image's shades onto a list of colors,\none table of values per channel.", "implements": [], "extends": null, "uses": [ "Minn\\Html" ], "usedBy": [], "constructor": null, "cases": [], "constants": [ { "name": "SVG", "value": "''", "doc": "", "visibility": "private" } ], "properties": [], "methods": [ { "routes": [], "name": "svg", "static": true, "visibility": "public", "signature": "svg(string $filterId, array $colors): string", "doc": "The filter for a list of colors; colors that do not parse are left out.", "shapes": [ "@param list $colors" ], "params": [ { "name": "filterId", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "colors", "type": "array", "shape": "list", "default": null, "doc": "" } ], "line": 24, "end": 38 }, { "routes": [], "name": "parse", "static": true, "visibility": "public", "signature": "parse(string $input): ?array", "doc": "A color's channels: hex (3, 4, 6 or 8 digits), rgb()/rgba() and hsl()/hsla().", "shapes": [ "@return array{r: float, g: float, b: float, a: float}|null" ], "params": [ { "name": "input", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 45, "end": 61 }, { "routes": [], "name": "alpha", "static": true, "visibility": "private", "signature": "alpha(?string $value, string $pct): float", "doc": "", "shapes": [], "params": [ { "name": "value", "type": "?string", "shape": "", "default": null, "doc": "" }, { "name": "pct", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 63, "end": 69 }, { "routes": [], "name": "hsl", "static": true, "visibility": "private", "signature": "hsl(float $hue, float $saturation, float $lightness): array", "doc": "", "shapes": [ "@return array{r: float, g: float, b: float} hue in degrees, saturation and lightness in percent" ], "params": [ { "name": "hue", "type": "float", "shape": "", "default": null, "doc": "" }, { "name": "saturation", "type": "float", "shape": "", "default": null, "doc": "" }, { "name": "lightness", "type": "float", "shape": "", "default": null, "doc": "" } ], "line": 72, "end": 92 } ] }, { "name": "Minn\\Blocks\\Dynamic\\Archives", "short": "Archives", "namespace": "Minn\\Blocks\\Dynamic", "kind": "final readonly class", "file": "public/minn/src/Minn/Blocks/Dynamic/Archives.php", "lines": 29, "doc": "core/archives: the months that have published posts, newest first, with their counts when asked (showPostCounts).", "implements": [], "extends": null, "uses": [ "Minn\\Blocks\\Block", "Minn\\Blocks\\Renderer", "Minn\\Db", "Minn\\Front\\Permalinks" ], "usedBy": [ "Minn\\Blocks\\Renderer" ], "constructor": { "signature": "__construct(Minn\\Db $db, Minn\\Front\\Permalinks $permalinks)", "doc": "", "shapes": [], "params": [ { "name": "db", "type": "Minn\\Db", "shape": "", "default": null, "doc": "" }, { "name": "permalinks", "type": "Minn\\Front\\Permalinks", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 16, "end": 20 }, "cases": [], "constants": [], "properties": [ { "name": "db", "type": "Minn\\Db", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "permalinks", "type": "Minn\\Front\\Permalinks", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [], "name": "render", "static": false, "visibility": "public", "signature": "render(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "The block's HTML.", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 23, "end": 41 } ] }, { "name": "Minn\\Blocks\\Dynamic\\Dates", "short": "Dates", "namespace": "Minn\\Blocks\\Dynamic", "kind": "final class", "file": "public/minn/src/Minn/Blocks/Dynamic/Dates.php", "lines": 15, "doc": "Site-local dates the way the dynamic blocks print them.", "implements": [], "extends": null, "uses": [ "Minn\\Content\\Site", "Minn\\I18n\\LocalDates" ], "usedBy": [ "Minn\\Blocks\\Dynamic\\LatestComments", "Minn\\Blocks\\Dynamic\\LatestPosts", "Minn\\Blocks\\Dynamic\\Theme\\Comments", "Minn\\Blocks\\Dynamic\\Theme\\PostBlocks" ], "constructor": null, "cases": [], "constants": [], "properties": [], "methods": [ { "routes": [], "name": "iso", "static": true, "visibility": "public", "signature": "iso(Minn\\Content\\Site $site, string $local): string", "doc": "ISO 8601 with the site's offset at that date (summer or winter time), from a site-local MySQL datetime.", "shapes": [], "params": [ { "name": "site", "type": "Minn\\Content\\Site", "shape": "", "default": null, "doc": "" }, { "name": "local", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 16, "end": 19 }, { "routes": [], "name": "format", "static": true, "visibility": "public", "signature": "format(Minn\\Content\\Site $site, string $local, string $format = ''): string", "doc": "A site-local MySQL datetime in the format given, else the date_format option, in the site's language.", "shapes": [], "params": [ { "name": "site", "type": "Minn\\Content\\Site", "shape": "", "default": null, "doc": "" }, { "name": "local", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "format", "type": "string", "shape": "", "default": "''", "doc": "" } ], "line": 22, "end": 26 } ] }, { "name": "Minn\\Blocks\\Dynamic\\LatestComments", "short": "LatestComments", "namespace": "Minn\\Blocks\\Dynamic", "kind": "final readonly class", "file": "public/minn/src/Minn/Blocks/Dynamic/LatestComments.php", "lines": 71, "doc": "core/latest-comments: the newest approved comments with avatar, meta, and a 20-word excerpt.", "implements": [], "extends": null, "uses": [ "Minn\\Blocks\\Block", "Minn\\Blocks\\Dynamic\\Dates", "Minn\\Blocks\\Renderer", "Minn\\Content\\CommentRecord", "Minn\\Content\\Posts", "Minn\\Content\\Site", "Minn\\Db", "Minn\\Front\\Permalinks", "Minn\\Html", "Minn\\I18n\\Gettext", "Minn\\Rest\\UserObject", "Minn\\Support\\Kses" ], "usedBy": [ "Minn\\Blocks\\Renderer" ], "constructor": { "signature": "__construct(Minn\\Db $db, Minn\\Content\\Site $site, Minn\\Content\\Posts $posts, Minn\\Front\\Permalinks $permalinks)", "doc": "", "shapes": [], "params": [ { "name": "db", "type": "Minn\\Db", "shape": "", "default": null, "doc": "" }, { "name": "site", "type": "Minn\\Content\\Site", "shape": "", "default": null, "doc": "" }, { "name": "posts", "type": "Minn\\Content\\Posts", "shape": "", "default": null, "doc": "" }, { "name": "permalinks", "type": "Minn\\Front\\Permalinks", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 21, "end": 27 }, "cases": [], "constants": [], "properties": [ { "name": "db", "type": "Minn\\Db", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "site", "type": "Minn\\Content\\Site", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "posts", "type": "Minn\\Content\\Posts", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "permalinks", "type": "Minn\\Front\\Permalinks", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [], "name": "render", "static": false, "visibility": "public", "signature": "render(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "The block's HTML.", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 30, "end": 78 }, { "routes": [], "name": "excerpt", "static": true, "visibility": "private", "signature": "excerpt(string $content): string", "doc": "The first twenty words, with an ellipsis when there were more.", "shapes": [], "params": [ { "name": "content", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 81, "end": 88 } ] }, { "name": "Minn\\Blocks\\Dynamic\\LatestPosts", "short": "LatestPosts", "namespace": "Minn\\Blocks\\Dynamic", "kind": "final readonly class", "file": "public/minn/src/Minn/Blocks/Dynamic/LatestPosts.php", "lines": 34, "doc": "core/latest-posts: the newest published posts as a list, optionally dated.", "implements": [], "extends": null, "uses": [ "Minn\\Blocks\\Block", "Minn\\Blocks\\Dynamic\\Dates", "Minn\\Content\\PasswordGate", "Minn\\Content\\PostRecord", "Minn\\Content\\Site", "Minn\\Db", "Minn\\Front\\Permalinks", "Minn\\Html" ], "usedBy": [ "Minn\\Blocks\\Renderer" ], "constructor": { "signature": "__construct(Minn\\Db $db, Minn\\Content\\Site $site, Minn\\Front\\Permalinks $permalinks)", "doc": "", "shapes": [], "params": [ { "name": "db", "type": "Minn\\Db", "shape": "", "default": null, "doc": "" }, { "name": "site", "type": "Minn\\Content\\Site", "shape": "", "default": null, "doc": "" }, { "name": "permalinks", "type": "Minn\\Front\\Permalinks", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 18, "end": 23 }, "cases": [], "constants": [], "properties": [ { "name": "db", "type": "Minn\\Db", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "site", "type": "Minn\\Content\\Site", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "permalinks", "type": "Minn\\Front\\Permalinks", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [], "name": "render", "static": false, "visibility": "public", "signature": "render(Minn\\Blocks\\Block $block): string", "doc": "The block's HTML.", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" } ], "line": 26, "end": 48 } ] }, { "name": "Minn\\Blocks\\Dynamic\\Search", "short": "Search", "namespace": "Minn\\Blocks\\Dynamic", "kind": "final readonly class", "file": "public/minn/src/Minn/Blocks/Dynamic/Search.php", "lines": 48, "doc": "core/search: the site search form. The button sits outside or inside\nthe field and shows text or the search icon; the block's colour and\nfont presets land on the button (font family on the input too). The\ninput id comes from the shared request counter.", "implements": [], "extends": null, "uses": [ "Minn\\Blocks\\Block", "Minn\\Blocks\\RenderState", "Minn\\Blocks\\Renderer", "Minn\\Blocks\\Styles", "Minn\\Front\\Permalinks", "Minn\\Html", "Minn\\I18n\\Gettext" ], "usedBy": [ "Minn\\Blocks\\Renderer" ], "constructor": { "signature": "__construct(Minn\\Front\\Permalinks $permalinks)", "doc": "", "shapes": [], "params": [ { "name": "permalinks", "type": "Minn\\Front\\Permalinks", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 26, "end": 28 }, "cases": [], "constants": [ { "name": "ICON", "value": "' \t\t\t\t\t \t\t\t\t'", "doc": "", "visibility": "private" } ], "properties": [ { "name": "permalinks", "type": "Minn\\Front\\Permalinks", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [], "name": "render", "static": false, "visibility": "public", "signature": "render(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "The block's HTML.", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 31, "end": 66 } ] }, { "name": "Minn\\Blocks\\Dynamic\\SocialLinks", "short": "SocialLinks", "namespace": "Minn\\Blocks\\Dynamic", "kind": "final class", "file": "public/minn/src/Minn/Blocks/Dynamic/SocialLinks.php", "lines": 79, "doc": "core/social-links and core/social-link. The list keeps its stored\nwrapper and gains the flex layout classes; each link renders from its\nparent's icon colours and the service's icon. The icons are the\nreference's rendered output captured as data (src/data/social-icons.json,\nthe upstream set is CC0); an unknown service gets the share icon.", "implements": [], "extends": null, "uses": [ "Minn\\Blocks\\Block", "Minn\\Blocks\\Layout", "Minn\\Blocks\\Renderer", "Minn\\Blocks\\Styles", "Minn\\Html", "Minn\\Json", "Minn\\Support\\Kses" ], "usedBy": [ "Minn\\Blocks\\Renderer" ], "constructor": { "signature": "__construct(string $iconsFile)", "doc": "", "shapes": [], "params": [ { "name": "iconsFile", "type": "string", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 30, "end": 32 }, "cases": [], "constants": [ { "name": "PARENT_SETTINGS", "value": "array ( 'openInNewTab' => true, 'showLabels' => true, 'iconColor' => true, 'iconColorValue' => true, 'iconBackgroundColor' => true, 'iconBackgroundColorValue' => true, )", "doc": "What a social-links list provides its links as context.", "visibility": "private" } ], "properties": [ { "name": "icons", "type": "?array", "readonly": false, "static": false, "doc": "", "visibility": "private", "promoted": false }, { "name": "iconsFile", "type": "string", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [], "name": "register", "static": false, "visibility": "public", "signature": "register(Minn\\Blocks\\Renderer $renderer): void", "doc": "Registers the block and its links with the renderer.", "shapes": [], "params": [ { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 35, "end": 40 }, { "routes": [], "name": "list", "static": false, "visibility": "private", "signature": "list(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 42, "end": 55 }, { "routes": [], "name": "link", "static": false, "visibility": "private", "signature": "link(Minn\\Blocks\\Block $link, Minn\\Blocks\\Block $parent): string", "doc": "", "shapes": [], "params": [ { "name": "link", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "parent", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" } ], "line": 57, "end": 93 }, { "routes": [], "name": "icons", "static": false, "visibility": "private", "signature": "icons(): array", "doc": "", "shapes": [ "@return array" ], "params": [], "line": 96, "end": 99 } ] }, { "name": "Minn\\Blocks\\Dynamic\\SyncedPattern", "short": "SyncedPattern", "namespace": "Minn\\Blocks\\Dynamic", "kind": "final readonly class", "file": "public/minn/src/Minn/Blocks/Dynamic/SyncedPattern.php", "lines": 26, "doc": "core/block: a synced pattern, rendered from the wp_block post it references.", "implements": [], "extends": null, "uses": [ "Minn\\Blocks\\Block", "Minn\\Blocks\\Parser", "Minn\\Blocks\\RenderState", "Minn\\Blocks\\Renderer", "Minn\\Db" ], "usedBy": [ "Minn\\Blocks\\Renderer" ], "constructor": { "signature": "__construct(Minn\\Db $db)", "doc": "", "shapes": [], "params": [ { "name": "db", "type": "Minn\\Db", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 16, "end": 18 }, "cases": [], "constants": [], "properties": [ { "name": "db", "type": "Minn\\Db", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [], "name": "render", "static": false, "visibility": "public", "signature": "render(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "The block's HTML.", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 21, "end": 38 } ] }, { "name": "Minn\\Blocks\\Dynamic\\TagCloud", "short": "TagCloud", "namespace": "Minn\\Blocks\\Dynamic", "kind": "final readonly class", "file": "public/minn/src/Minn/Blocks/Dynamic/TagCloud.php", "lines": 36, "doc": "core/tag-cloud: non-empty tags by name, sized from 8pt to 22pt in\nproportion to their counts (every tag at 8pt when the counts are equal).", "implements": [], "extends": null, "uses": [ "Minn\\Admin\\Format", "Minn\\Blocks\\Block", "Minn\\Content\\TermRecord", "Minn\\Db", "Minn\\Front\\Permalinks", "Minn\\Html", "Minn\\I18n\\Gettext" ], "usedBy": [ "Minn\\Blocks\\Renderer" ], "constructor": { "signature": "__construct(Minn\\Db $db, Minn\\Front\\Permalinks $permalinks)", "doc": "", "shapes": [], "params": [ { "name": "db", "type": "Minn\\Db", "shape": "", "default": null, "doc": "" }, { "name": "permalinks", "type": "Minn\\Front\\Permalinks", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 21, "end": 25 }, "cases": [], "constants": [], "properties": [ { "name": "db", "type": "Minn\\Db", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "permalinks", "type": "Minn\\Front\\Permalinks", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [], "name": "render", "static": false, "visibility": "public", "signature": "render(Minn\\Blocks\\Block $block): string", "doc": "The block's HTML.", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" } ], "line": 28, "end": 53 } ] }, { "name": "Minn\\Blocks\\Dynamic\\Theme\\Comments", "short": "Comments", "namespace": "Minn\\Blocks\\Dynamic\\Theme", "kind": "final readonly class", "file": "public/minn/src/Minn/Blocks/Dynamic/Theme/Comments.php", "lines": 271, "doc": "comments, comments-title, comment-template, the comment-* blocks, and the comment form.", "implements": [], "extends": null, "uses": [ "Minn\\Admin\\Format", "Minn\\Blocks\\Block", "Minn\\Blocks\\Dynamic\\Dates", "Minn\\Blocks\\Renderer", "Minn\\Blocks\\Styles", "Minn\\Blocks\\Wrapper", "Minn\\Content\\Blocks", "Minn\\Content\\CommentRecord", "Minn\\Content\\PasswordGate", "Minn\\Content\\PostRecord", "Minn\\Content\\Posts", "Minn\\Content\\RowCache", "Minn\\Content\\Site", "Minn\\Content\\Texturize", "Minn\\Content\\Users", "Minn\\Front\\Permalinks", "Minn\\Html", "Minn\\I18n\\Gettext", "Minn\\Runtime\\Avatar", "Minn\\Runtime\\Runtime", "Minn\\Support\\Kses" ], "usedBy": [ "Minn\\Blocks\\Renderer" ], "constructor": { "signature": "__construct(Minn\\Content\\Site $site, Minn\\Front\\Permalinks $permalinks, Minn\\Content\\Posts $posts, Minn\\Content\\Users $users)", "doc": "", "shapes": [], "params": [ { "name": "site", "type": "Minn\\Content\\Site", "shape": "", "default": null, "doc": "" }, { "name": "permalinks", "type": "Minn\\Front\\Permalinks", "shape": "", "default": null, "doc": "" }, { "name": "posts", "type": "Minn\\Content\\Posts", "shape": "", "default": null, "doc": "" }, { "name": "users", "type": "Minn\\Content\\Users", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 32, "end": 38 }, "cases": [], "constants": [], "properties": [ { "name": "site", "type": "Minn\\Content\\Site", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "permalinks", "type": "Minn\\Front\\Permalinks", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "posts", "type": "Minn\\Content\\Posts", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "users", "type": "Minn\\Content\\Users", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [], "name": "register", "static": false, "visibility": "public", "signature": "register(Minn\\Blocks\\Renderer $renderer): void", "doc": "Registers this family's blocks with the renderer.", "shapes": [], "params": [ { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 41, "end": 52 }, { "routes": [], "name": "query", "static": true, "visibility": "public", "signature": "query(array $vars): WP_Comment_Query", "doc": "The comment query a comment template's vars ask for, run once a\nrequest: the template and its pagination links ask for the same one,\nand the reference answers the repeat from its cache. A comment write\ndrops it (RowCache).", "shapes": [ "@param array $vars" ], "params": [ { "name": "vars", "type": "array", "shape": "array", "default": null, "doc": "" } ], "line": 104, "end": 107 }, { "routes": [], "name": "comments", "static": false, "visibility": "private", "signature": "comments(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "Nothing at all when the post has no comments and takes none.", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 55, "end": 67 }, { "routes": [], "name": "title", "static": false, "visibility": "private", "signature": "title(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 69, "end": 94 }, { "routes": [], "name": "template", "static": false, "visibility": "private", "signature": "template(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 109, "end": 124 }, { "routes": [], "name": "records", "static": true, "visibility": "private", "signature": "records(array $comments, bool $threaded): array", "doc": "The query's comments as records, each followed by its replies when\nthey are threaded; unthreaded, every one stands at the top level.", "shapes": [ "@param list<\\WP_Comment> $comments", "@return list" ], "params": [ { "name": "comments", "type": "array", "shape": "list<\\WP_Comment>", "default": null, "doc": "" }, { "name": "threaded", "type": "bool", "shape": "", "default": null, "doc": "" } ], "line": 133, "end": 143 }, { "routes": [], "name": "count", "static": true, "visibility": "private", "signature": "count(Minn\\Content\\PostRecord $post): int", "doc": "How many comments a post shows: its count, as get_comments_number filters it.", "shapes": [], "params": [ { "name": "post", "type": "Minn\\Content\\PostRecord", "shape": "", "default": null, "doc": "" } ], "line": 146, "end": 149 }, { "routes": [], "name": "list", "static": false, "visibility": "private", "signature": "list(array $all, int $parent, int $depth, Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "", "shapes": [ "@param list $all" ], "params": [ { "name": "all", "type": "array", "shape": "list", "default": null, "doc": "" }, { "name": "parent", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "depth", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 152, "end": 180 }, { "routes": [], "name": "avatar", "static": false, "visibility": "private", "signature": "avatar(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "The comment author's avatar in a comment loop; elsewhere the post author's, linked to their posts when asked.", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 183, "end": 193 }, { "routes": [], "name": "authorAvatar", "static": false, "visibility": "private", "signature": "authorAvatar(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer, int $size): string", "doc": "", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" }, { "name": "size", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 195, "end": 208 }, { "routes": [], "name": "date", "static": false, "visibility": "private", "signature": "date(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "When the comment was written, in the format asked for (else the site's), linked to the comment unless isLink is off.", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 211, "end": 224 }, { "routes": [], "name": "commentPost", "static": false, "visibility": "private", "signature": "commentPost(Minn\\Content\\CommentRecord $comment, Minn\\Blocks\\Renderer $renderer): ?Minn\\Content\\PostRecord", "doc": "The post a comment belongs to: the loop's, or looked up when the comment came by itself (a comment block's render callback).", "shapes": [], "params": [ { "name": "comment", "type": "Minn\\Content\\CommentRecord", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 227, "end": 231 }, { "routes": [], "name": "authorName", "static": false, "visibility": "private", "signature": "authorName(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 233, "end": 245 }, { "routes": [], "name": "content", "static": false, "visibility": "private", "signature": "content(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 247, "end": 256 }, { "routes": [], "name": "replyLink", "static": false, "visibility": "private", "signature": "replyLink(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 258, "end": 269 }, { "routes": [], "name": "form", "static": false, "visibility": "private", "signature": "form(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 271, "end": 278 }, { "routes": [], "name": "commentForm", "static": false, "visibility": "private", "signature": "commentForm(int $postId, Minn\\Blocks\\Block $block): string", "doc": "The form is comment_form()'s, as the reference's block renders it: the block theme's button in its defaults, the\nblock's classes on the respond wrapper, and every comment_form hook a\nplugin uses to add its fields (a spam plugin's hidden check, a\nconsent box) fired on the way.", "shapes": [], "params": [ { "name": "postId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" } ], "line": 286, "end": 298 } ] }, { "name": "Minn\\Blocks\\Dynamic\\Theme\\Navigation", "short": "Navigation", "namespace": "Minn\\Blocks\\Dynamic\\Theme", "kind": "final readonly class", "file": "public/minn/src/Minn/Blocks/Dynamic/Theme/Navigation.php", "lines": 535, "doc": "navigation, navigation-link, page-list. A navigation block's items come\nfrom its inner blocks, the wp_navigation post it references, the newest\npublished wp_navigation post, or (when none of those exist) the first\nclassic nav_menu; a block naming a menu that is gone has none, and no\nlist. A responsive menu wraps them in the overlay markup the reference\nemits. The nav is labelled by the block's aria label, or the menu's\ntitle, made unique in the request; the list carries the aria label as\ngiven (probe loose-classes).", "implements": [], "extends": null, "uses": [ "Minn\\Blocks\\Block", "Minn\\Blocks\\Layout", "Minn\\Blocks\\Parser", "Minn\\Blocks\\RenderState", "Minn\\Blocks\\Renderer", "Minn\\Blocks\\Styles", "Minn\\Content\\Menus", "Minn\\Content\\PostRecord", "Minn\\Content\\Posts", "Minn\\Content\\Terms", "Minn\\Db", "Minn\\Front\\Kind", "Minn\\Front\\Permalinks", "Minn\\Html", "Minn\\I18n\\Gettext", "Minn\\Json", "Minn\\Runtime\\Pages", "Minn\\Runtime\\Runtime", "Minn\\Support\\Kses" ], "usedBy": [], "constructor": { "signature": "__construct(Minn\\Db $db, Minn\\Content\\Posts $posts, Minn\\Front\\Permalinks $permalinks, ?Minn\\Content\\Menus $menus = NULL)", "doc": "", "shapes": [], "params": [ { "name": "db", "type": "Minn\\Db", "shape": "", "default": null, "doc": "" }, { "name": "posts", "type": "Minn\\Content\\Posts", "shape": "", "default": null, "doc": "" }, { "name": "permalinks", "type": "Minn\\Front\\Permalinks", "shape": "", "default": null, "doc": "" }, { "name": "menus", "type": "?Minn\\Content\\Menus", "shape": "", "default": "NULL", "doc": "" } ], "visibility": "public", "line": 77, "end": 83 }, "cases": [], "constants": [ { "name": "LISTABLE", "value": "array ( 0 => 'core/site-title', 1 => 'core/site-logo', 2 => 'core/social-links', )", "doc": "The other blocks a navigation lists, each in an li (block_core_navigation_listable_blocks).", "visibility": "private" }, { "name": "SUBMENU_CONTEXT", "value": "'{ \"submenuOpenedBy\": { \"click\": false, \"hover\": false, \"focus\": false }, \"type\": \"submenu\", \"modal\": null, \"previousFocus\": null }'", "doc": "A submenu's interactivity context.", "visibility": "private" }, { "name": "SUBMENU_TOGGLE", "value": "'data-wp-bind--aria-expanded=\"state.isSubmenuOpen\" data-wp-on--click=\"actions.toggleMenuOnClick\"'", "doc": "", "visibility": "private" }, { "name": "CHEVRON", "value": "''", "doc": "The submenu toggle's chevron (block_core_navigation_link_render_submenu_icon).", "visibility": "public" }, { "name": "CLOSE_ICON", "value": "''", "doc": "", "visibility": "private" } ], "properties": [ { "name": "db", "type": "Minn\\Db", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "posts", "type": "Minn\\Content\\Posts", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "permalinks", "type": "Minn\\Front\\Permalinks", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "menus", "type": "?Minn\\Content\\Menus", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [], "name": "submenuDirectives", "static": true, "visibility": "public", "signature": "submenuDirectives(string $visibility): array", "doc": "The attributes an item with a submenu takes, in the reference's order:\nits context, the focus and key handlers, the hover ones for a submenu\nthat opens on hover, the init watcher, and its tab index.", "shapes": [ "@return array" ], "params": [ { "name": "visibility", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 54, "end": 65 }, { "routes": [], "name": "register", "static": false, "visibility": "public", "signature": "register(Minn\\Blocks\\Renderer $renderer): void", "doc": "Registers this family's blocks with the renderer.", "shapes": [], "params": [ { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 86, "end": 93 }, { "routes": [], "name": "wiring", "static": true, "visibility": "private", "signature": "wiring(string $visibility): string", "doc": "The submenu directives as attribute markup, a space after them.", "shapes": [], "params": [ { "name": "visibility", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 68, "end": 75 }, { "routes": [], "name": "navigation", "static": false, "visibility": "private", "signature": "navigation(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 95, "end": 169 }, { "routes": [], "name": "responsive", "static": false, "visibility": "private", "signature": "responsive(string $nav, string $label, string $list, int $id, bool $hasIcon, string $colors): string", "doc": "The overlay form of the menu: the open button, the modal container the\ninteractivity runtime drives, the close button, and the list inside.\nWhitespace matches the reference's template byte for byte.", "shapes": [], "params": [ { "name": "nav", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "label", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "list", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "id", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "hasIcon", "type": "bool", "shape": "", "default": null, "doc": "" }, { "name": "colors", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 176, "end": 205 }, { "routes": [], "name": "items", "static": false, "visibility": "private", "signature": "items(array $items, Minn\\Blocks\\Renderer $renderer): string", "doc": "The menu's items. Link-shaped blocks render as their own list\nitems; any other block is wrapped in a plain item.", "shapes": [ "@param list $items" ], "params": [ { "name": "items", "type": "array", "shape": "list", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 213, "end": 223 }, { "routes": [], "name": "groups", "static": false, "visibility": "private", "signature": "groups(array $items, Minn\\Blocks\\Renderer $renderer, string $open): string", "doc": "The navigation's items as the reference lays them out (probe\nhook-inputs-2): the blocks block_core_navigation_listable_blocks names\nare wrapped in an li; each run of items whose markup holds an li\n(links, submenus, a page list, a plugin's own list items) is a list of\nits own; any other block stands between the runs as it renders, and\nan item that renders nothing ends a run.", "shapes": [ "@param list $items" ], "params": [ { "name": "items", "type": "array", "shape": "list", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" }, { "name": "open", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 235, "end": 252 }, { "routes": [], "name": "filteredItems", "static": true, "visibility": "private", "signature": "filteredItems(array $items): array", "doc": "The items as block_core_navigation_render_inner_blocks leaves them,\nhanded to a plugin as the WP_Block_List the reference renders.", "shapes": [ "@param list $items", "@return list" ], "params": [ { "name": "items", "type": "array", "shape": "list", "default": null, "doc": "" } ], "line": 261, "end": 274 }, { "routes": [], "name": "linkedPosts", "static": true, "visibility": "private", "signature": "linkedPosts(array $items): array", "doc": "The posts the items link to, submenus' too, read in one query before\neach link asks for its own.", "shapes": [ "@param list $items", "@return list" ], "params": [ { "name": "items", "type": "array", "shape": "list", "default": null, "doc": "" } ], "line": 283, "end": 293 }, { "routes": [], "name": "weighLinks", "static": false, "visibility": "private", "signature": "weighLinks(array $items): void", "doc": "", "shapes": [ "@param list $items each link to a post among them, submenus' too, through linkable()" ], "params": [ { "name": "items", "type": "array", "shape": "list", "default": null, "doc": "each link to a post among them, submenus' too, through linkable()" } ], "line": 296, "end": 304 }, { "routes": [], "name": "linkable", "static": false, "visibility": "private", "signature": "linkable(Minn\\Blocks\\Block $block, int $id): bool", "doc": "Whether a link to a post renders: the post is there with a status\nrender_block_core_navigation_link_allowed_post_status allows\n(publish), asked with the link's attributes and its block.", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "id", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 311, "end": 319 }, { "routes": [], "name": "presetClasses", "static": true, "visibility": "private", "signature": "presetClasses(Minn\\Blocks\\Block $block): array", "doc": "", "shapes": [ "@return list the colour and font-size preset classes the block's attributes declare" ], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" } ], "line": 322, "end": 341 }, { "routes": [], "name": "overlayColors", "static": true, "visibility": "private", "signature": "overlayColors(Minn\\Blocks\\Block $block): string", "doc": "The overlay's colour classes, from the overlay* attributes.", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" } ], "line": 344, "end": 354 }, { "routes": [], "name": "link", "static": false, "visibility": "private", "signature": "link(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 356, "end": 383 }, { "routes": [], "name": "submenu", "static": false, "visibility": "private", "signature": "submenu(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "A submenu: its link (a button, when the navigation opens submenus on\nclick) and its items. Inside a navigation it carries the toggle and the\nInteractivity API wiring the navigation's settings ask for; on its own\nit is a plain item.", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 391, "end": 416 }, { "routes": [], "name": "overlayClose", "static": false, "visibility": "private", "signature": "overlayClose(Minn\\Blocks\\Block $block): string", "doc": "The overlay's close button: an icon (named by aria-label), its text, or both.", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" } ], "line": 419, "end": 427 }, { "routes": [], "name": "classicItems", "static": false, "visibility": "private", "signature": "classicItems(): array", "doc": "", "shapes": [ "@return list" ], "params": [], "line": 430, "end": 434 }, { "routes": [], "name": "pageList", "static": false, "visibility": "private", "signature": "pageList(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 436, "end": 447 }, { "routes": [], "name": "submenuColours", "static": true, "visibility": "private", "signature": "submenuColours(array $nav): array", "doc": "A page list's submenu items wear the navigation's overlay colours: a\nnamed one as its classes, a custom one as has-* and an inline style.", "shapes": [ "@param array $nav the navigation's context", "@return array{0: string, 1: string} the classes, each led by a space, and the style attribute" ], "params": [ { "name": "nav", "type": "array", "shape": "array", "default": null, "doc": "the navigation's context" } ], "line": 456, "end": 469 }, { "routes": [], "name": "ancestorsOf", "static": false, "visibility": "private", "signature": "ancestorsOf(array $tree, int $currentId): array", "doc": "", "shapes": [ "@return list the ids of the current page's ancestors" ], "params": [ { "name": "tree", "type": "array", "shape": "", "default": null, "doc": "" }, { "name": "currentId", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 472, "end": 487 }, { "routes": [], "name": "pageItems", "static": false, "visibility": "private", "signature": "pageItems(array $tree, int $parent, int $currentId, array $ancestors, array $submenuColors): string", "doc": "A page list dresses its items as navigation items only while it is\nrendering inside a navigation block: submenu toggles, the item\nclasses, and the interactivity directives all belong to the nav. On\nits own (wp/v2/navigation serves one that way) the reference emits\nplain list items and a bare submenu list. Submenu items wear the\nnavigation's overlay colours (submenuColours()).", "shapes": [ "@param array{0: string, 1: string} $submenuColors" ], "params": [ { "name": "tree", "type": "array", "shape": "", "default": null, "doc": "" }, { "name": "parent", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "currentId", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "ancestors", "type": "array", "shape": "", "default": null, "doc": "" }, { "name": "submenuColors", "type": "array", "shape": "array{0: string, 1: string}", "default": null, "doc": "" } ], "line": 499, "end": 527 }, { "routes": [], "name": "navParent", "static": false, "visibility": "private", "signature": "navParent(array $page, string $marker, string $home, string $link, string $children): string", "doc": "", "shapes": [ "@param array $page" ], "params": [ { "name": "page", "type": "array", "shape": "array", "default": null, "doc": "" }, { "name": "marker", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "home", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "link", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "children", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 530, "end": 537 }, { "routes": [], "name": "menuPost", "static": false, "visibility": "private", "signature": "menuPost(int $ref): array", "doc": "The menu a navigation shows, and whether it is the one the block names.\nOnly a published menu shows, as on the reference: a named menu that\nis not published (a draft, private or trashed one) gives way to the\nlatest published menu, unlabelled; a named menu that does not exist\nshows nothing; with none named, the latest published menu.", "shapes": [ "@return array{0: array|null, 1: bool}" ], "params": [ { "name": "ref", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 548, "end": 560 }, { "routes": [], "name": "enqueueView", "static": false, "visibility": "private", "signature": "enqueueView(): void", "doc": "Interactive navigation markup brings the block's view module with it, as on the reference.", "shapes": [], "params": [], "line": 563, "end": 568 } ] }, { "name": "Minn\\Blocks\\Dynamic\\Theme\\PostBlocks", "short": "PostBlocks", "namespace": "Minn\\Blocks\\Dynamic\\Theme", "kind": "final readonly class", "file": "public/minn/src/Minn/Blocks/Dynamic/Theme/PostBlocks.php", "lines": 260, "doc": "The post-* blocks: they render the context's current post.", "implements": [], "extends": null, "uses": [ "Minn\\Blocks\\Block", "Minn\\Blocks\\Dynamic\\Dates", "Minn\\Blocks\\Layout", "Minn\\Blocks\\Renderer", "Minn\\Blocks\\Styles", "Minn\\Blocks\\Wrapper", "Minn\\Content\\Blocks", "Minn\\Content\\Excerpt", "Minn\\Content\\PasswordGate", "Minn\\Content\\PostRecord", "Minn\\Content\\Posts", "Minn\\Content\\Reader", "Minn\\Content\\Site", "Minn\\Content\\TermRecord", "Minn\\Content\\Terms", "Minn\\Content\\Texturize", "Minn\\Content\\Users", "Minn\\Db", "Minn\\Extension\\Extensions", "Minn\\Front\\Kind", "Minn\\Front\\Permalinks", "Minn\\Front\\Resolution", "Minn\\Html", "Minn\\I18n\\Gettext", "Minn\\Runtime\\Runtime" ], "usedBy": [ "Minn\\Blocks\\Renderer" ], "constructor": { "signature": "__construct(Minn\\Content\\Posts $posts, Minn\\Content\\Users $users, Minn\\Content\\Site $site, Minn\\Front\\Permalinks $permalinks)", "doc": "", "shapes": [], "params": [ { "name": "posts", "type": "Minn\\Content\\Posts", "shape": "", "default": null, "doc": "" }, { "name": "users", "type": "Minn\\Content\\Users", "shape": "", "default": null, "doc": "" }, { "name": "site", "type": "Minn\\Content\\Site", "shape": "", "default": null, "doc": "" }, { "name": "permalinks", "type": "Minn\\Front\\Permalinks", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 32, "end": 38 }, "cases": [], "constants": [], "properties": [ { "name": "posts", "type": "Minn\\Content\\Posts", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "users", "type": "Minn\\Content\\Users", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "site", "type": "Minn\\Content\\Site", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "permalinks", "type": "Minn\\Front\\Permalinks", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [], "name": "register", "static": false, "visibility": "public", "signature": "register(Minn\\Blocks\\Renderer $renderer): void", "doc": "Registers this family's blocks with the renderer.", "shapes": [], "params": [ { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 41, "end": 51 }, { "routes": [], "name": "title", "static": false, "visibility": "private", "signature": "title(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 53, "end": 66 }, { "routes": [], "name": "content", "static": false, "visibility": "private", "signature": "content(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "In a loop the content stops at the more tag with a \"(more…)\" link; on its own page it runs whole.", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 69, "end": 111 }, { "routes": [], "name": "date", "static": false, "visibility": "private", "signature": "date(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 113, "end": 125 }, { "routes": [], "name": "authorName", "static": false, "visibility": "private", "signature": "authorName(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 127, "end": 139 }, { "routes": [], "name": "excerpt", "static": false, "visibility": "private", "signature": "excerpt(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 141, "end": 151 }, { "routes": [], "name": "featuredImage", "static": false, "visibility": "private", "signature": "featuredImage(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 153, "end": 191 }, { "routes": [], "name": "terms", "static": false, "visibility": "private", "signature": "terms(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 193, "end": 215 }, { "routes": [], "name": "navigationLink", "static": false, "visibility": "private", "signature": "navigationLink(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "Off a single post or page there is no neighbour to link: nothing at all.", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 218, "end": 247 }, { "routes": [], "name": "termRow", "static": false, "visibility": "private", "signature": "termRow(string $taxonomy, int $termId): ?Minn\\Content\\TermRecord", "doc": "", "shapes": [], "params": [ { "name": "taxonomy", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "termId", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 249, "end": 252 }, { "routes": [], "name": "previewSource", "static": false, "visibility": "private", "signature": "previewSource(Minn\\Content\\PostRecord $post, Minn\\Front\\Resolution $resolution): ?Minn\\Content\\PostRecord", "doc": "On a preview, the post's newest autosave, whoever wrote it, stands in for its stored fields (as _set_preview does).", "shapes": [], "params": [ { "name": "post", "type": "Minn\\Content\\PostRecord", "shape": "", "default": null, "doc": "" }, { "name": "resolution", "type": "Minn\\Front\\Resolution", "shape": "", "default": null, "doc": "" } ], "line": 261, "end": 268 }, { "routes": [], "name": "target", "static": true, "visibility": "private", "signature": "target(Minn\\Blocks\\Block $block): string", "doc": "", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" } ], "line": 270, "end": 273 }, { "routes": [], "name": "open", "static": true, "visibility": "private", "signature": "open(string $tag, array $classes, Minn\\Blocks\\Block $block, bool $styleFirst = false, bool $linkColorClass = false): string", "doc": "", "shapes": [], "params": [ { "name": "tag", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "classes", "type": "array", "shape": "", "default": null, "doc": "" }, { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "styleFirst", "type": "bool", "shape": "", "default": "false", "doc": "" }, { "name": "linkColorClass", "type": "bool", "shape": "", "default": "false", "doc": "" } ], "line": 275, "end": 288 } ] }, { "name": "Minn\\Blocks\\Dynamic\\Theme\\QueryBlocks", "short": "QueryBlocks", "namespace": "Minn\\Blocks\\Dynamic\\Theme", "kind": "final class", "file": "public/minn/src/Minn/Blocks/Dynamic/Theme/QueryBlocks.php", "lines": 283, "doc": "query, post-template, query-title, query-no-results, query-pagination, query-total.", "implements": [], "extends": null, "uses": [ "Minn\\Blocks\\Block", "Minn\\Blocks\\Layout", "Minn\\Blocks\\Renderer", "Minn\\Blocks\\Styles", "Minn\\Blocks\\Wrapper", "Minn\\Content\\Page", "Minn\\Content\\PostRecord", "Minn\\Content\\Posts", "Minn\\Content\\Site", "Minn\\Content\\TermRecord", "Minn\\Content\\Texturize", "Minn\\Front\\Kind", "Minn\\Front\\Permalinks", "Minn\\Html", "Minn\\I18n\\Gettext", "Minn\\Runtime\\Runtime", "Minn\\Support\\Serialized", "Minn\\Theme\\ArchiveTitle" ], "usedBy": [ "Minn\\Blocks\\Renderer" ], "constructor": { "signature": "__construct(Minn\\Content\\Posts $posts, Minn\\Content\\Site $site, Minn\\Front\\Permalinks $permalinks)", "doc": "", "shapes": [], "params": [ { "name": "posts", "type": "Minn\\Content\\Posts", "shape": "", "default": null, "doc": "" }, { "name": "site", "type": "Minn\\Content\\Site", "shape": "", "default": null, "doc": "" }, { "name": "permalinks", "type": "Minn\\Front\\Permalinks", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 31, "end": 36 }, "cases": [], "constants": [], "properties": [ { "name": "queries", "type": "array", "readonly": false, "static": false, "doc": "", "visibility": "private", "promoted": false }, { "name": "posts", "type": "Minn\\Content\\Posts", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "site", "type": "Minn\\Content\\Site", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "permalinks", "type": "Minn\\Front\\Permalinks", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [], "name": "register", "static": false, "visibility": "public", "signature": "register(Minn\\Blocks\\Renderer $renderer): void", "doc": "Registers this family's blocks with the renderer.", "shapes": [], "params": [ { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 39, "end": 50 }, { "routes": [], "name": "query", "static": false, "visibility": "private", "signature": "query(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "The query wrapper is stored markup; the block sets the loop its children read.", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 53, "end": 63 }, { "routes": [], "name": "queried", "static": true, "visibility": "private", "signature": "queried(Minn\\Blocks\\Block $block, array $attrs, int $page): Minn\\Content\\Page", "doc": "A query loop's posts as the reference finds them: the arguments\nbuild_query_vars_from_query_block makes of the block's query (through\nquery_loop_block_query_vars) for the page its query-{id}-page asks\nfor, run through WP_Query, so pre_get_posts and the posts_* filters\nshape it too.", "shapes": [ "@param array $attrs the block's query" ], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "attrs", "type": "array", "shape": "array", "default": null, "doc": "the block's query" }, { "name": "page", "type": "int", "shape": "", "default": null, "doc": "" } ], "line": 74, "end": 81 }, { "routes": [], "name": "loop", "static": false, "visibility": "private", "signature": "loop(Minn\\Blocks\\Block $block, array $attrs, Minn\\Blocks\\Renderer $renderer): array", "doc": "A loop as the query block sets it: the main query's page when it\ninherits, else its own query for the page its query-{id}-page asks for.", "shapes": [ "@param array $attrs the block's query", "@return array{page: Page, inherit: bool, paged: int, perPage: int}" ], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "attrs", "type": "array", "shape": "array", "default": null, "doc": "the block's query" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 90, "end": 100 }, { "routes": [], "name": "current", "static": false, "visibility": "private", "signature": "current(?Minn\\Blocks\\Renderer $renderer = NULL): array", "doc": "The innermost loop being rendered; outside one, the loop a block's context provides (a post template called by its render callback).", "shapes": [], "params": [ { "name": "renderer", "type": "?Minn\\Blocks\\Renderer", "shape": "", "default": "NULL", "doc": "" } ], "line": 103, "end": 113 }, { "routes": [], "name": "total", "static": false, "visibility": "private", "signature": "total(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "How many posts the loop found, or which of them this page shows (displayType range-display).", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 116, "end": 130 }, { "routes": [], "name": "postTemplate", "static": false, "visibility": "private", "signature": "postTemplate(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 132, "end": 163 }, { "routes": [], "name": "postClasses", "static": false, "visibility": "private", "signature": "postClasses(Minn\\Content\\PostRecord $post, bool $sticky): array", "doc": "", "shapes": [ "@return list" ], "params": [ { "name": "post", "type": "Minn\\Content\\PostRecord", "shape": "", "default": null, "doc": "" }, { "name": "sticky", "type": "bool", "shape": "", "default": null, "doc": "" } ], "line": 166, "end": 194 }, { "routes": [], "name": "queryTitle", "static": false, "visibility": "private", "signature": "queryTitle(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 196, "end": 214 }, { "routes": [], "name": "noResults", "static": false, "visibility": "private", "signature": "noResults(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 216, "end": 227 }, { "routes": [], "name": "pagination", "static": false, "visibility": "private", "signature": "pagination(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "Pagination renders only when the loop it belongs to has more than one page.", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 230, "end": 273 }, { "routes": [], "name": "paginationBase", "static": false, "visibility": "private", "signature": "paginationBase(Minn\\Blocks\\Renderer $renderer): string", "doc": "The current listing's own URL, without a page number.", "shapes": [], "params": [ { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 276, "end": 288 }, { "routes": [], "name": "numbers", "static": false, "visibility": "private", "signature": "numbers(int $paged, int $pages, callable $link): string", "doc": "", "shapes": [ "@param callable(int): string $link" ], "params": [ { "name": "paged", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "pages", "type": "int", "shape": "", "default": null, "doc": "" }, { "name": "link", "type": "callable", "shape": "callable(int): string", "default": null, "doc": "" } ], "line": 291, "end": 300 }, { "routes": [], "name": "archiveTitle", "static": false, "visibility": "private", "signature": "archiveTitle(array $type): string", "doc": "A post type archive's title: the type's label, renamed by the post_type_archive_title filter when a plugin does.", "shapes": [], "params": [ { "name": "type", "type": "array", "shape": "", "default": null, "doc": "" } ], "line": 303, "end": 307 } ] }, { "name": "Minn\\Blocks\\Dynamic\\Theme\\Structure", "short": "Structure", "namespace": "Minn\\Blocks\\Dynamic\\Theme", "kind": "final readonly class", "file": "public/minn/src/Minn/Blocks/Dynamic/Theme/Structure.php", "lines": 105, "doc": "template-part, pattern, site-title, site-tagline, site-logo.", "implements": [], "extends": null, "uses": [ "Minn\\Blocks\\Block", "Minn\\Blocks\\Parser", "Minn\\Blocks\\RenderState", "Minn\\Blocks\\Renderer", "Minn\\Blocks\\Wrapper", "Minn\\Content\\Site", "Minn\\Front\\Kind", "Minn\\Front\\Permalinks", "Minn\\Html", "Minn\\Runtime\\BlockHooks", "Minn\\Runtime\\Runtime", "Minn\\Theme\\Templates", "Minn\\Theme\\Theme" ], "usedBy": [ "Minn\\Blocks\\Renderer", "Minn\\Theme\\PageRenderer" ], "constructor": { "signature": "__construct(Minn\\Theme\\Theme $theme, Minn\\Theme\\Templates $templates, Minn\\Content\\Site $site, Minn\\Front\\Permalinks $permalinks)", "doc": "", "shapes": [], "params": [ { "name": "theme", "type": "Minn\\Theme\\Theme", "shape": "", "default": null, "doc": "" }, { "name": "templates", "type": "Minn\\Theme\\Templates", "shape": "", "default": null, "doc": "" }, { "name": "site", "type": "Minn\\Content\\Site", "shape": "", "default": null, "doc": "" }, { "name": "permalinks", "type": "Minn\\Front\\Permalinks", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 24, "end": 30 }, "cases": [], "constants": [], "properties": [ { "name": "theme", "type": "Minn\\Theme\\Theme", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "templates", "type": "Minn\\Theme\\Templates", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "site", "type": "Minn\\Content\\Site", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "permalinks", "type": "Minn\\Front\\Permalinks", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [], "name": "register", "static": false, "visibility": "public", "signature": "register(Minn\\Blocks\\Renderer $renderer): void", "doc": "Registers this family's blocks with the renderer.", "shapes": [], "params": [ { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 33, "end": 40 }, { "routes": [], "name": "templatePart", "static": false, "visibility": "private", "signature": "templatePart(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "The wrapper element follows the part's area: header, footer, or a div.", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 43, "end": 61 }, { "routes": [], "name": "announcePart", "static": true, "visibility": "private", "signature": "announcePart(Minn\\Blocks\\Block $block, string $slug, string $source, string|int $where, ?string $markup): void", "doc": "Tells plugins where a template part came from, as the reference does\nas it renders one: render_block_core_template_part_post (with the\nsaved part), _file (with the theme file's path) or _none.", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "slug", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "source", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "where", "type": "string|int", "shape": "", "default": null, "doc": "" }, { "name": "markup", "type": "?string", "shape": "", "default": null, "doc": "" } ], "line": 68, "end": 79 }, { "routes": [], "name": "pattern", "static": false, "visibility": "private", "signature": "pattern(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 81, "end": 97 }, { "routes": [], "name": "siteTitle", "static": false, "visibility": "private", "signature": "siteTitle(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 99, "end": 113 }, { "routes": [], "name": "siteTagline", "static": false, "visibility": "private", "signature": "siteTagline(Minn\\Blocks\\Block $block): string", "doc": "", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" } ], "line": 115, "end": 124 } ] }, { "name": "Minn\\Blocks\\Dynamic\\Theme\\TermBlocks", "short": "TermBlocks", "namespace": "Minn\\Blocks\\Dynamic\\Theme", "kind": "final readonly class", "file": "public/minn/src/Minn/Blocks/Dynamic/Theme/TermBlocks.php", "lines": 71, "doc": "term-name, term-count and term-description: the term a block's context\nnames (termId and taxonomy, as a terms query provides them), else the\nterm archive being viewed; nothing for neither (probe core-blocks).", "implements": [], "extends": null, "uses": [ "Minn\\Blocks\\Block", "Minn\\Blocks\\Renderer", "Minn\\Blocks\\Styles", "Minn\\Blocks\\Wrapper", "Minn\\Content\\TermRecord", "Minn\\Content\\Terms", "Minn\\Front\\Kind", "Minn\\Front\\Permalinks", "Minn\\Html" ], "usedBy": [ "Minn\\Blocks\\Renderer" ], "constructor": { "signature": "__construct(Minn\\Content\\Terms $terms, Minn\\Front\\Permalinks $permalinks)", "doc": "", "shapes": [], "params": [ { "name": "terms", "type": "Minn\\Content\\Terms", "shape": "", "default": null, "doc": "" }, { "name": "permalinks", "type": "Minn\\Front\\Permalinks", "shape": "", "default": null, "doc": "" } ], "visibility": "public", "line": 26, "end": 30 }, "cases": [], "constants": [ { "name": "BRACKETS", "value": "array ( 'round' => array ( 0 => '(', 1 => ')', ), 'square' => array ( 0 => '[', 1 => ']', ), 'curly' => array ( 0 => '{', 1 => '}', ), 'angle' => array ( 0 => '<', 1 => '>', ), 'none' => array ( 0 => '', 1 => '', ), )", "doc": "", "visibility": "private" } ], "properties": [ { "name": "terms", "type": "Minn\\Content\\Terms", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "permalinks", "type": "Minn\\Front\\Permalinks", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [], "name": "register", "static": false, "visibility": "public", "signature": "register(Minn\\Blocks\\Renderer $renderer): void", "doc": "Registers this family's blocks with the renderer.", "shapes": [], "params": [ { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 33, "end": 38 }, { "routes": [], "name": "name", "static": false, "visibility": "private", "signature": "name(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "The name, as a paragraph or the heading level asked for, linked to its archive when asked.", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 41, "end": 54 }, { "routes": [], "name": "count", "static": false, "visibility": "private", "signature": "count(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "How many posts the term holds, in the brackets asked for (round by default).", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 57, "end": 65 }, { "routes": [], "name": "description", "static": false, "visibility": "private", "signature": "description(Minn\\Blocks\\Block $block, Minn\\Blocks\\Renderer $renderer): string", "doc": "The description as written for a term in context; a term archive's as a paragraph, the way term_description gives it.", "shapes": [], "params": [ { "name": "block", "type": "Minn\\Blocks\\Block", "shape": "", "default": null, "doc": "" }, { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 68, "end": 77 }, { "routes": [], "name": "term", "static": false, "visibility": "private", "signature": "term(Minn\\Blocks\\Renderer $renderer): array", "doc": "", "shapes": [ "@return array{?TermRecord, bool} the term, and whether the block's context named it" ], "params": [ { "name": "renderer", "type": "Minn\\Blocks\\Renderer", "shape": "", "default": null, "doc": "" } ], "line": 80, "end": 91 } ] }, { "name": "Minn\\Blocks\\Elements", "short": "Elements", "namespace": "Minn\\Blocks", "kind": "final class", "file": "public/minn/src/Minn/Blocks/Elements.php", "lines": 121, "doc": "Per-block element styles (style.elements in a block's attributes, the\nlink colour most often; probe block-supports). A block whose element\nstyles set a colour gets a numbered wp-elements-N class and a rule per\nelement and state, recorded with the page's block-support styles in\nrender order: links (their text colour, plain or on hover), headings,\neach heading level and buttons (text, background or gradient). A block\ntype whose colour support skips serialization, whole or for links,\nheadings or buttons, writes none for those.", "implements": [], "extends": null, "uses": [ "Minn\\Blocks\\RenderState", "Minn\\Blocks\\Styles", "Minn\\Runtime\\Runtime" ], "usedBy": [ "Minn\\Blocks\\Renderer" ], "constructor": null, "cases": [], "constants": [ { "name": "SELECTORS", "value": "array ( 'link' => 'a:where(:not(.wp-element-button))', 'heading' => 'h1, h2, h3, h4, h5, h6', 'h1' => 'h1', 'h2' => 'h2', 'h3' => 'h3', 'h4' => 'h4', 'h5' => 'h5', 'h6' => 'h6', 'button' => '.wp-element-button, .wp-block-button__link', )", "doc": "", "visibility": "private" }, { "name": "KINDS", "value": "array ( 'link' => 'link', 'heading' => 'heading', 'h1' => 'heading', 'h2' => 'heading', 'h3' => 'heading', 'h4' => 'heading', 'h5' => 'heading', 'h6' => 'heading', 'button' => 'button', )", "doc": "The kind each element's skip answers to: every heading level is a heading.", "visibility": "private" } ], "properties": [], "methods": [ { "routes": [], "name": "className", "static": true, "visibility": "public", "signature": "className(array $attrs, array $supports): ?string", "doc": "The block's wp-elements-N class, recording its rules; null when its\nelement styles earn none.", "shapes": [ "@param array $supports the block type's supports" ], "params": [ { "name": "attrs", "type": "array", "shape": "", "default": null, "doc": "" }, { "name": "supports", "type": "array", "shape": "array", "default": null, "doc": "the block type's supports" } ], "line": 37, "end": 50 }, { "routes": [], "name": "shouldAdd", "static": true, "visibility": "public", "signature": "shouldAdd(array $elements, array $skip): bool", "doc": "Whether element styles earn a class: a link's text colour (or its\nhover's), a heading's, a heading level's or a button's text,\nbackground or gradient, for a kind not skipped.", "shapes": [ "@param array $elements", "@param array $skip by kind: link, heading, button" ], "params": [ { "name": "elements", "type": "array", "shape": "array", "default": null, "doc": "" }, { "name": "skip", "type": "array", "shape": "array", "default": null, "doc": "by kind: link, heading, button" } ], "line": 60, "end": 76 }, { "routes": [], "name": "skips", "static": true, "visibility": "public", "signature": "skips(array $supports): array", "doc": "The kinds a block type's colour support skips serializing.", "shapes": [ "@param array $supports", "@return array" ], "params": [ { "name": "supports", "type": "array", "shape": "array", "default": null, "doc": "" } ], "line": 84, "end": 92 }, { "routes": [], "name": "rules", "static": true, "visibility": "private", "signature": "rules(string $class, array $elements, array $skip): array", "doc": "", "shapes": [ "@param array $elements", "@param array $skip", "@return list}>" ], "params": [ { "name": "class", "type": "string", "shape": "", "default": null, "doc": "" }, { "name": "elements", "type": "array", "shape": "array", "default": null, "doc": "" }, { "name": "skip", "type": "array", "shape": "array", "default": null, "doc": "" } ], "line": 99, "end": 121 }, { "routes": [], "name": "declarations", "static": true, "visibility": "private", "signature": "declarations(array $styles): array", "doc": "", "shapes": [ "@return array" ], "params": [ { "name": "styles", "type": "array", "shape": "", "default": null, "doc": "" } ], "line": 124, "end": 138 } ] }, { "name": "Minn\\Blocks\\ImageTags", "short": "ImageTags", "namespace": "Minn\\Blocks", "kind": "final readonly class", "file": "public/minn/src/Minn/Blocks/ImageTags.php", "lines": 312, "doc": "The attributes the reference adds to an that carries a\nwp-image-{id} class: loading, decoding, width and height (prepended, in\nthat order), and srcset plus sizes (appended). The srcset lists the\ndisplayed size first, then every same-ratio size in stored order, then\nthe original.", "implements": [], "extends": null, "uses": [ "Minn\\Blocks\\RenderState", "Minn\\Content\\Posts", "Minn\\Html", "Minn\\Media\\Metadata", "Minn\\Media\\Uploads", "Minn\\Runtime\\Runtime" ], "usedBy": [ "Minn\\Blocks\\Renderer" ], "constructor": { "signature": "__construct(Minn\\Content\\Posts $posts, Minn\\Media\\Uploads $uploads, Closure $front)", "doc": "", "shapes": [ "@param Closure(): bool $front whether the images are on a front-end page, where the loading budget applies" ], "params": [ { "name": "posts", "type": "Minn\\Content\\Posts", "shape": "", "default": null, "doc": "" }, { "name": "uploads", "type": "Minn\\Media\\Uploads", "shape": "", "default": null, "doc": "" }, { "name": "front", "type": "Closure", "shape": "Closure(): bool", "default": null, "doc": "whether the images are on a front-end page, where the loading budget applies" } ], "visibility": "public", "line": 25, "end": 30 }, "cases": [], "constants": [], "properties": [ { "name": "posts", "type": "Minn\\Content\\Posts", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "uploads", "type": "Minn\\Media\\Uploads", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true }, { "name": "front", "type": "Closure", "readonly": true, "static": false, "doc": "", "visibility": "private", "promoted": true } ], "methods": [ { "routes": [], "name": "enrich", "static": false, "visibility": "public", "signature": "enrich(string $html): string", "doc": "Rewrites every wp-image-* in a fragment; other images pass through.", "shapes": [], "params": [ { "name": "html", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 33, "end": 36 }, { "routes": [], "name": "enrichGallery", "static": false, "visibility": "public", "signature": "enrichGallery(string $html): string", "doc": "The same for a gallery: every image also carries its data-id.", "shapes": [], "params": [ { "name": "html", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 39, "end": 42 }, { "routes": [], "name": "enrichPlugin", "static": false, "visibility": "public", "signature": "enrichPlugin(string $html): string", "doc": "The same for a plugin block's output, where the reference adds no sizes=\"auto\".", "shapes": [], "params": [ { "name": "html", "type": "string", "shape": "", "default": null, "doc": "" } ], "line": 45, "end": 48 }, { "routes": [], "name": "content", "static": false, "visibility": "public", "signature": "content(string $html, mixed $context = NULL): string", "doc": "Every and