Packages final readonly class
Minn\Ops\Packages · public/minn/src/Minn/Ops/Packages.php · 481 lines
Putting plugins, themes and extensions on disk. Plugins and themes come from the directory (wordpress.org's, asked through the Minn update service, Ops\Directory) or an uploaded zip, and are installed through WordPress's upgraders (UpgraderRun), so plugins hear every upgrader hook; a Minn extension (a folder with a minn.json) is placed by the engine. Every archive passes Archive's checks first: exactly one top-level folder that is a plain name (never "." or ".."), no absolute or dotted paths, no symbolic links, bounded entry count and size. Removal proves the folder is a direct child of its kind's directory before anything is deleted.
Constants and properties
| private | THEMES_INFO = 'https://updates.minn.run/v1/themes/info/1.2/' | The largest archive fetched or unpacked, in bytes. |
| private | PLUGINS_INFO = 'https://updates.minn.run/v1/plugins/info/1.2/' | |
| private | INFO_OPTION = 'minn_plugin_info' | |
| private | INFO_TTL = 43200 | |
| private | readonly Minn\Content\Site $site | Promoted from the constructor. |
| private | readonly string $contentDir | Promoted from the constructor. |
| private | readonly Minn\Http $http | Promoted from the constructor. |
Public
| new | __construct(Minn\Content\Site $site, string $contentDir, Minn\Http $http = \Minn\Http::__set_state(array( 'within' => array ( ), 'fake' => NULL, 'refusal' => NULL, )))# | ||||
| method | searchThemes(string $query): array# | Directory theme search, or the popular list for an empty query. @return list<array> @return list<array> | |||
| method | searchPlugins(string $query, int $page): array# | Directory plugin search: twelve per page with icons, short descriptions, install counts, and ratings, plus which results are already installed (by folder). @return array{plugins: list<array>, page: int, pages: int, total: int} @return array{plugins: list<array>, page: int, pages: int, total: int} | |||
| method | pluginInfo(string $slug): array# | The slim card for one directory plugin, cached twelve hours per slug. | |||
| method | installPlugin(string $slug, string $version = ''): string# | Installs a directory plugin by slug, through the upgrader; returns its folder. | |||
| method | replacePlugin(string $slug, string $version = ''): string# | Installs a directory plugin over the folder already there. | |||
| method | directoryPlugin(string $slug): ?array# | One directory plugin record, or null when the slug is unknown. @return array<string, mixed>|null | |||
| method | infoAction(string $kind, string $action, array $request): ?array# | The directory's answer to a plugins_api() or themes_api() action ($kind 'plugins' or 'themes'), its request passed as given (Ops\DirectoryApi), read whatever the status: a refusal is the directory's own words ({"error": ...}); an answer that is not JSON comes back as {"unexpected": body}. Null when the service did not answer.
@return array<string, mixed>|null | |||
| method | queryThemes(string $search, int $page, int $perPage): array# | A page of directory themes for `wp theme search`. @return array{items: list<array<string, mixed>>, total: int} | |||
| method | queryPlugins(string $search, int $page, int $perPage): array# | A page of directory plugins for `wp plugin search`. @return array{items: list<array<string, mixed>>, total: int} | |||
| method | directoryTheme(string $slug): ?array# | One directory theme record, or null when the slug is unknown. @return array<string, mixed>|null | |||
| method | installTheme(string $slug, string $version = ''): string# | Installs a directory theme by slug, through the upgrader; returns its stylesheet folder. | |||
| method | replaceTheme(string $slug, string $version = ''): string# | Installs a directory theme over the folder already there. | |||
| method | unpack(string $zip, string $kind): array# | Unpacks an uploaded or downloaded archive into wp-content/themes or wp-content/plugins: a theme or a WordPress plugin through the upgrader, a Minn extension (minn.json) placed by the engine; refused when its folder is taken. @return array{folder: string, name: string, version: string, kind: string} @return array{folder: string, name: string, version: string, kind: string} | |||
| method | unpackReplacing(string $zip, string $kind): array# | Unpacks a zip over a folder already there, replacing it whole. | |||
| method | remove(string $kind, string $folder): void# | Removes a theme or plugin folder that is not in use. | |||
| method | identity(string $dir, string $kind): array# | What a folder holds by its headers; kind "unknown" when nothing identifies it. @return array{name: string, version: string, kind: string} @return array{name: string, version: string, kind: string} | |||
| method | fetch(string $url, string ...$hostPrefixes): string# | A package over https, every redirect hop included, refusing anything else; when host prefixes are given, every hop must start with one. The request names the engine, never the site's address. |
Internals 8
Private and protected methods: how the class does its work. Not a contract; they change whenever the code is tidied.
| private | pluginPackage(string $slug, string $version): string# | The download link of a directory plugin (on the update service), at a version when one is asked for. | |||
| private | plain(string $value): string# | Directory text as the app shows it: tags stripped, entities decoded. | |||
| private | themePackage(string $slug, string $version): string# | The download link of a directory theme (on the update service), at a version when one is asked for. | |||
| private | upload(string $zip, string $kind, array $args): ?array# | An archive checked by Archive and installed through the upgrader, as Minn Admin's uploads are on WordPress; null for a Minn extension, which the engine places itself.
@return array{folder: string, name: string, version: string, kind: string}|null | |||
| private | place(string $zip, string $kind, Closure $onExisting): array# | Unpacks a zip into wp-content; $onExisting decides what happens to a folder already at the destination (refuse, or clear it).
| |||
| private | contained(string $kind, string $folder): string# | The path a folder of this kind lives at, proven to be a direct child of the kind's directory. | |||
| private | identify(string $dir, string $kind): array# | What a folder is: a theme (style.css with a Theme Name), a Minn extension (minn.json), or a WordPress plugin, which is named so the refusal can say what was uploaded. @return array{name: string, version: string, kind: string} @return array{name: string, version: string, kind: string} | |||
| private | ask(string $url): string# | A directory answer from the Minn update service, every redirect hop staying on it. |
Nothing matches.