Unofficial SMF API Documentation

./Sources/Subs-Attachments.php

• automanage_attachments_check_directory
• automanage_attachments_create_directory
• is_path_allowed
• automanage_attachments_by_space
• get_directory_tree_elements
• attachments_init_dir
• processAttachments
• attachmentChecks
• createAttachment
• assignAttachments
• parseAttachBBC
• getRawAttachInfo
• getAttachMsgInfo
• loadAttachmentContext
• prepareAttachsByMsg

automanage_attachments_check_directory

function automanage_attachments_check_directory(): void|bool

Check if the current directory is still valid or not.

If not creates the new directory

automanage_attachments_create_directory

function automanage_attachments_create_directory(string $updir): bool

Creates a directory

is_path_allowed

function is_path_allowed(string $path): bool

Check if open_basedir restrictions are in effect.

If so check if the path is allowed.

automanage_attachments_by_space

function automanage_attachments_by_space(): void|bool

Called when a directory space limit is reached.

Creates a new directory and increments the directory suffix number.

get_directory_tree_elements

function get_directory_tree_elements(string $directory): array|bool

Split a path into a list of all directories and subdirectories

attachments_init_dir

function attachments_init_dir(array &$tree, int &$count): string|bool

Return the first part of a path (i.e. c:\ or / + the first directory), used by automanage_attachments_create_directory

processAttachments

function processAttachments(): void

Moves an attachment to the proper directory and set the relevant data into $_SESSION[‘temp_attachments’]

Integration hooks

integrate_attachment_upload

attachmentChecks

function attachmentChecks(int $attachID): bool

Performs various checks on an uploaded file.

• Requires that $_SESSION[‘temp_attachments’][$attachID] be properly populated.

createAttachment

function createAttachment(array &$attachmentOptions): bool

Create an attachment, with the given array of parameters.

• Adds any additional or missing parameters to $attachmentOptions.
• Renames the temporary file.
• Creates a thumbnail if the file is an image and the option enabled.

Integration hooks

integrate_createAttachment

assignAttachments

function assignAttachments(??? $attachIDs = array(), ??? $msgID = 0): bool

Assigns the given attachments to the given message ID.

Integration hooks

integrate_assign_attachments

parseAttachBBC

function parseAttachBBC(int $attachID = 0): mixed

Gets an attach ID and tries to load all its info.

Integration hooks

integrate_pre_parseAttachBBC

integrate_post_parseAttachBBC

getRawAttachInfo

function getRawAttachInfo(array $attachIDs): array

Gets raw info directly from the attachments table.

getAttachMsgInfo

function getAttachMsgInfo(int $attachID): array

Gets all needed message data associated with an attach ID

loadAttachmentContext

function loadAttachmentContext(int $id_msg, array $attachments): array

This loads an attachment’s contextual data including, most importantly, its size if it is an image.

It requires the view_attachments permission to calculate image size. It attempts to keep the “aspect ratio” of the posted image in line, even if it has to be resized by the max_image_width and max_image_height settings.

prepareAttachsByMsg

function prepareAttachsByMsg(int $msgIDs): void

prepare the Attachment api for all messages

Suggest an edit to this page on GitHub