Unofficial SMF API Documentation

./Sources/Packages.php

Packages

function Packages(): void

This is the notoriously defunct package manager….. :/.

Integration hooks
integrate_manage_packages

PackageInstallTest

function PackageInstallTest(): void

Test install a package.

PackageInstall

function PackageInstall(): void

Apply another type of (avatar, language, etc.) package.

PackageList

function PackageList(): void

List the files in a package.

ExamineFile

function ExamineFile(): void

Display one of the files in a package.

PackageRemove

function PackageRemove(): void

Delete a package.

PackageBrowse

function PackageBrowse(): void

Browse a list of installed packages.

Integration hooks
integrate_modification_types

list_getPackages

function list_getPackages(int $start, int $items_per_page, string $sort, string $params): array

Get a listing of all the packages

Determines if the package is a mod, avatar, or language package and groups it accordingly. If a package is not recognised as one of the above, it is then put into a special group, “unknown”.

Determines whether the package has been installed or not by checking it against {@link loadInstalledPackages()}.

Type Parameter Description
int $start The item to start with (not used here)
int $items_per_page The number of items to show per page (not used here)
string $sort A string indicating how to sort the results
string $params Type of packages
Integration hooks
integrate_packages_sort_id

PackageOptions

function PackageOptions(): void

Used when a temp FTP access is needed to package functions

ViewOperations

function ViewOperations(): void

List operations

PackagePermissions

function PackagePermissions(): void

Allow the admin to reset permissions on files.

fetchPerms__recursive

function fetchPerms__recursive(string $path, array &$data, int $level): void

Checkes the permissions of all the areas that will be affected by the package

Type Parameter Description
string $path The path to the directiory to check permissions for
array $data An array of data about the directory
int $level How far deep to go

PackagePermissionsAction

function PackagePermissionsAction(): void

Actually action the permission changes they want.

PackageFTPTest

function PackageFTPTest(): void

Test an FTP connection.

Suggest an edit to this page on GitHub