Unofficial SMF API Documentation

./Sources/Subs-Package.php

• read_tgz_file
• read_tgz_data
• read_zip_data
• url_exists
• loadInstalledPackages
• getPackageInfo
• create_chmod_control
• packageRequireFTP
• parsePackageInfo
• matchHighestPackageVersion
• matchPackageVersion
• compareVersions
• parse_path
• deltree
• mktree
• copytree
• listtree
• parseModification
• parseBoardMod
• package_get_contents
• package_put_contents
• package_flush_cache
• package_chmod
• package_crypt
• package_unique_filename
• package_create_backup
• smf_crc32
• package_validate_installtest
• package_validate
• package_validate_send

read_tgz_file

function read_tgz_file(string $gzfilename, ?string $destination, bool $single_file = false, bool $overwrite = false, ?array $files_to_extract = null): array|false

Reads an archive from either a remote location or from the local filesystem.

read_tgz_data

function read_tgz_data(string $data, ?string $destination, bool $single_file = false, bool $overwrite = false, ?array $files_to_extract = null): array|false

Extracts a file or files from the .tar.gz contained in data.

detects if the file is really a .zip file, and if so returns the result of read_zip_data

if destination is null

• returns a list of files in the archive.

if single_file is true

• returns the contents of the file specified by destination, if it exists, or false.
• destination can start with * and / to signify that the file may come from any directory.
• destination should not begin with a / if single_file is true.

overwrites existing files with newer modification times if and only if overwrite is true. creates the destination directory if it doesn’t exist, and is is specified. requires zlib support be built into PHP. returns an array of the files extracted. if files_to_extract is not equal to null only extracts file within this array.

read_zip_data

function read_zip_data(string $data, ?string $destination, bool $single_file = false, bool $overwrite = false, ?array $files_to_extract = null): mixed

Extract zip data.

If single_file is true, destination can start with * and / to signify that the file may come from any directory. Destination should not begin with a / if single_file is true.

url_exists

function url_exists(string $url): bool

Checks the existence of a remote file since file_exists() does not do remote.

will return false if the file is “moved permanently” or similar.

loadInstalledPackages

function loadInstalledPackages(): array

Loads and returns an array of installed packages.

default sort order is package_installed time

getPackageInfo

function getPackageInfo(string $gzfilename): array|string

Loads a package’s information and returns a representative array.

• expects the file to be a package in Packages/.
• returns a error string if the package-info is invalid.
• otherwise returns a basic array of id, version, filename, and similar information.
• an xmlArray is available in ‘xml’.

create_chmod_control

function create_chmod_control(array $chmodFiles = array(), array $chmodOptions = array(), bool $restore_write_status = false): array

Create a chmod control for chmoding files.

packageRequireFTP

function packageRequireFTP(string $destination_url, ?array $files = null, bool $return = false): array

Use FTP functions to work with a package download/install

parsePackageInfo

function parsePackageInfo(\xmlArray &$packageXML, bool $testing_only = true, string $method = 'install', string $previous_version = ''): array

Parses the actions in package-info.xml file from packages.

• package should be an xmlArray with package-info as its base.
• testing_only should be true if the package should not actually be applied.
• method can be upgrade, install, or uninstall. Its default is install.
• previous_version should be set to the previous installed version of this package, if any.
• does not handle failure terribly well; testing first is always better.

matchHighestPackageVersion

function matchHighestPackageVersion(string $versions, bool $reset, string $the_version): string|bool

Checks if version matches any of the versions in $versions.

• supports comma separated version numbers, with or without whitespace.
• supports lower and upper bounds. (1.0-1.2)
• returns true if the version matched.

matchPackageVersion

function matchPackageVersion(string $version, string $versions): bool

Checks if the forum version matches any of the available versions from the package install xml.

• supports comma separated version numbers, with or without whitespace.
• supports lower and upper bounds. (1.0-1.2)
• returns true if the version matched.

compareVersions

function compareVersions(string $version1, string $version2): void

Compares two versions and determines if one is newer, older or the same, returns

• (-1) if version1 is lower than version2
• (0) if version1 is equal to version2
• (1) if version1 is higher than version2

parse_path

function parse_path(string $path): string

Parses special identifiers out of the specified path.

deltree

function deltree(string $dir, bool $delete_dir = true): void

Deletes a directory, and all the files and direcories inside it.

requires access to delete these files.

mktree

function mktree(string $strPath, int $mode): bool

Creates the specified tree structure with the mode specified.

creates every directory in path until it finds one that already exists.

copytree

function copytree(string $source, string $destination): void

Copies one directory structure over to another.

requires the destination to be writable.

listtree

function listtree(string $path, string $sub_path = ''): array

Create a tree listing for a given directory path

parseModification

function parseModification(string $file, bool $testing = true, bool $undo = false, array $theme_paths = array()): array

Parses a xml-style modification file (file).

parseBoardMod

function parseBoardMod(string $file, bool $testing = true, bool $undo = false, array $theme_paths = array()): array

Parses a boardmod-style (.mod) modification file

package_get_contents

function package_get_contents(string $filename): string

Get the physical contents of a packages file

package_put_contents

function package_put_contents(string $filename, string $data, bool $testing = false): int

Writes data to a file, almost exactly like the file_put_contents() function.

uses FTP to create/chmod the file when necessary and available. uses text mode for text mode file extensions. returns the number of bytes written.

package_flush_cache

function package_flush_cache(bool $trash = false): void

Flushes the cache from memory to the filesystem

package_chmod

function package_chmod(string $filename, string $perm_state = 'writable', bool $track_change = false): bool

Try to make a file writable.

package_crypt

function package_crypt(string $pass): string

Used to crypt the supplied ftp password in this session

package_unique_filename

function package_unique_filename(string $dir, string $filename, string $ext): string

package_create_backup

function package_create_backup(string $id = 'backup'): bool

Creates a backup of forum files prior to modifying them

smf_crc32

function smf_crc32(string $number): string

crc32 doesn’t work as expected on 64-bit functions - make our own.

https://php.net/crc32#79567

package_validate_installtest

function package_validate_installtest(array $package): array

Validate a package during install

package_validate

function package_validate(array $packages): array

Validate multiple packages.

package_validate_send

function package_validate_send(array $sendData): array

Sending data off to validate packages.

Suggest an edit to this page on GitHub