Download the PHP package tamedevelopers/file without Composer

File Upload

Documentation

• Requirements
• Installation
• Instantiate
• Amazon Aws S3
• Global Config
• INPUT HTML STRUCTURE
• Response Data
  • Get Message
  • Get Status
  • Get Class
  • First
  • Get
  • Form
  • Unlink
• Usage
  • Name
  • Driver
  • BaseDir
  • Generate
  • Folder
  • Filter
  • Structure
  • Size
  • Limit
  • Mime
  • Width
  • Height
  • Validate
  • Save
  • Resize
  • WaterMark
  • Compress
  • Get External Image Size
  • Get Uploaded Image Size
  • Get Mime Type
  • Not Empty
  • Is Empty
  • Has Error
  • Is Completed
  • Mime Types
• Useful links

Requirements

• >= php 8.0+

Installation

Prior to installing support package get the Composer dependency manager for PHP because it'll simplify installation.

Instantiate

Step 1 — Composer Instantiate class using:

• Example 2

• or -- Helpers Function

Amazon Aws S3

• To use s3 first require composer require aws/aws-sdk-php
• By default Aws load entire SDK we won't be needing
  • Copy the below code into your root composer.json and then run composer update in terminal.

Global Config

• Configure The Global Config, so you don't have to always include default settings
  • Define as named argument

• or -- using file class method Global Config

INPUT HTML STRUCTURE

• or -- For Multiple Data

Response Data

• How to retrieve data

Get Message

• This will return error message

Get Status

• This will return error status code

Get Class

• This will only return msg, if there's an error or success

First

• This will get the first uploaded data

  • [optional] You can pass the mode as string name | path|url
• or

Get

• This will get all uploaded data

  • Returns an index array of all uploaded data, [name, path, url]
  • [optional] You can pass the mode as string name | path|url
• or

Form

• Return form request data
  • This will return validator package object Validator

Unlink

• Accepts two param as string. This method uses the base path automatically.
  • [mandatory] $fileToUnlink Path to file, you want to unlink.
  • [optional] $checkFile. This will check if $fileToUnlink is not same, before.

Usage

Name

• Takes one param string as input name
  • Static method by default

Driver

• More drivers are to be added in the future
  • By default driver is set to local

• using driver if project is not in any Frameworks

BaseDir

• Takes one param string as base directory name
  • This will override the global configuration settings (Domain and Server Path will be set)

Generate

• Takes one param bool

Folder

• Takes one param string as folder_path to save file

Filter

• Takes index or closed array index
  • Remove error status code you do not want to validate
  • You cannot remove Error 200

• or

Structure

• Takes one param string as structure type
  • Best used for Media\|Blog\|Newsletter Websites.

1. Default
   • Year
     • Month
       • Day

Size

• Takes one param string | int

  • size in int | kb | mb | gb
• or

Limit

• Takes one param string | int
  • Default limit is set to 1 upload

Mime

• Takes one param string as mime type
  • Goto Mime Types to see list

Width

• Takes two param string | int and bool
  • 1st param is string | int. width size
  • 2nd param is bool. This allow to check if size should be === or >= size of uploaded image. Default is true

Height

• Same as width method

Validate

• [optional] Method can be use, to return error message.
  • Takes an [optional] param as a callable\|closure function.

Save

• Takes an [optional] param as a callable\|closure function.

  • Calling this [method] will automatically save the data.
• or

Resize

• Takes two param as size int width and height
  • Returns an instance of self

WaterMark

• Takes three param watermarkSource | position | padding
  • [mandatory] $watermarkSource
  • Returns an instance of self
  • Padding is applied evenly on all position apart from center

Compress

• Returns an instance of self

Get External Image Size

• Takes one param as string
  • Return an array | null

Get Uploaded Image Size

• Takes one param as string
  • Return an array | null

Get Mime Type

• Takes one param as string
  • Return string | bool. false on error.

Not Empty

• Takes one param as string. Input file name
  • Return bool true | false

Is Empty

• Same as not empty

Has Error

• Returns true or false. Check if there's an error in the upload

Is Completed

• Returns true or false. Check if upload has been completed

Mime Types

Useful Links

• @author Fredrick Peterson (Tame Developers)
• If you love this PHP Library, you can Buy Tame Developers a coffee