AttachmentService

Table of contents

  1. Overview
  2. Public Methods
  3. Related Components
  4. Notes


1. Overview Table of Contents

The AttachmentService class provides static methods for managing file attachments uploaded through the admin interface. It handles uploading, previewing, deleting, and metadata processing for email-related attachments.

This service ensures file integrity and security, while integrating with your framework’s upload and email systems.


Setup

use Core\Services\AttachmentService;


Common Use Cases

  • Upload and save attachment files
  • Link uploaded files to email records
  • Display previews inline in the browser
  • Safely delete attachments from both storage and database


2. Public Methods Table of Contents

A. attachmentUpload()

Generates upload object for attachments.

Parameter:

  • EmailAttachments $attachment - The attachment to upload.

Returns:

  • Uploads null The upload object if the attachment is new, otherwise we return null. 
$upload = AttachmentService::attachmentUpload($attachment);


B. attachmentUploader()

Retrieves the user who uploaded a given attachment by their user ID.

Parameter:

  • int $id - User id for uploader of attachment.

Returns:

  • Users - The user who uploaded the attachment.
$user = AttachmentService::attachmentUploader($attachment->user_id);


C. deleteAttachment()

Deletes an attachment file from the filesystem and removes the associated database record.

Parameter:

  • EmailAttachments $attachment The attachment we want to delete from the filesystem.
AttachmentService::deleteAttachment($attachment);


D. name()

Determines the filename to store in the database:

  • For new uploads, uses the sanitized filename from $_FILES.
  • For existing records, returns the saved filename.

Parameter:

  • EmailAttachments $attachment The attachment whose name is being set.

Returns:

  • string - The attachment’s name.
$filename = AttachmentService::name($attachment);


E. previewAttachment()

Outputs an attachment file inline in the browser for previewing. Automatically sets proper headers and handles 404 if missing.

Parameter:

  • int $id - The id for the attachment’s record.
AttachmentService::previewAttachment($attachmentId);

Commonly used to display file previews in a new browser tab.


F. processAttachment()

Handles the complete lifecycle of processing an uploaded attachment:

  • Accepts upload
  • Sets name, description, and user ID
  • Saves metadata
  • Moves file to the correct upload path
  • Sets MIME type and final file path

Parameters:

  • EmailAttachments $attachment - The attachment to process and upload.
  • Input $request - The request for this update or edit.
AttachmentService::processAttachment($attachment, $request);

This method should be used in both attachment create and update flows.


  • EmailAttachments – The model representing stored attachment records.
  • Uploads – Upload handler responsible for file processing.
  • Attachments – Utility class for supporting processing of attachments.
  • AuthService – Used to get the current user ID for audit fields.


4. Notes Table of Contents

  • Uploaded attachments are stored in the path defined by EmailAttachments::$_uploadPath.
  • The service assumes the file input name is attachment_name and that the file is uploaded via $_FILES.
  • The processAttachment() method is safe to call for both new and existing records; it checks if uploads are needed.