Download the PHP package tamedevelopers/support without Composer

Support Package

Support Package For PHP and Laravel

Documentation

• Requirements
• Installation
• All Paths
• Number to Words
  • ISO
  • Cents
  • Value
  • toText
  • toNumber
• Tame
  • byteToUnit
  • unitToByte
  • fileTime
  • exists
  • unlink
  • mask
  • imageToBase64
  • emailValidator
  • platformIcon
  • paymentIcon
  • calPercentageBetweenNumbers
  • formatNumberToNearestThousand
  • calculateVolumeWeight
  • calculateCubicMeterWeight
  • getBetweenBoxLengthAndWeightInKg
  • getBetweenBoxLengthAndWeightInCMB
• Str
  • Usage
  • phone
  • mask
  • html
  • text
  • shorten
  • random
  • formatString
  • formatOnlyString
  • encrypt
  • decrypt
  • bindings
  • flattenValue
  • exceptArray
  • replaceFirst
  • replaceLast
  • renameArrayKeys
  • forgetArrayKeys
  • changeKeyCase
  • convertArrayCase
  • padLeft
  • padRight
  • words
  • ascii
  • is
  • snake
  • camel
  • kebab
  • title
  • studly
  • slugify
  • slug
  • before
  • after
  • between
  • contains
  • truncate
  • reverse
  • count
  • countOccurrences
  • uuid
  • randomWords
  • extension
  • wrap
  • head
  • last
• Country
  • Usage
  • iso3
  • iso2
  • flagIso3
  • flagIso2
  • month
  • week
  • zone
  • captcha
• File
  • Usage
  • files
  • makeDirectory
  • exists
  • get
  • put
  • delete
  • copy
  • move
  • size
  • lastModified
  • extension
  • name
  • mimeType
  • type
  • permissions
  • isReadable
  • isWritable
  • isDirectory
  • isFile
  • isFileType
• Collection
  • Usage
  • has
  • count
  • all
  • isNotEmpty
  • isEmpty
  • isSame
  • isDuplicate
  • reverse
  • pad
  • combine
  • collapse
  • flatten
  • zip
  • merge
  • only
  • except
  • chunk
  • keys
  • values
  • filter
  • reject
  • where
  • whereIn
  • whereNotIn
  • whereNull
  • whereNotNull
  • first
  • firstWhere
  • last
  • contains
  • doesntContain
  • every
  • some
  • select
  • map
  • mapWithKeys
  • pluck
  • pluckDot
  • groupBy
  • search
  • sort
  • sortBy
  • sortByMany
  • sortByDesc
  • sortKeys
  • sortKeysDesc
  • keyBy
  • slice
  • take
  • takeUntil
  • skip
  • concat
  • union
  • toBase
  • pipe
  • crossJoin
  • join
  • unique
  • each
  • forget
  • changeKeyCase
  • reduce
  • shuffle
  • partition
  • tap
  • chunkWhile
  • nth
  • paginate
  • zipWith
  • countBy
  • duplicates
  • shuffleKeys
  • average
  • avg
  • sum
  • max
  • min
• Mail
  • config
  • to
  • subject
  • altBody
  • body
  • cc
  • bcc
  • replyTo
  • attach
  • delete
  • send
  • flush
  • obFlush
  • convert
• Zip
  • Unzip
  • Zip Download
• PDF
  • Usage
  • Read PDF
• Time
  • time-usage
  • now
  • date
  • today
  • yesterday
  • createFromFormat
  • timestamp
  • toJsTimer
  • diff
  • diffBetween
  • ago
  • range
  • format
  • toDateTimeString
  • addSeconds
  • subSeconds
  • addMinutes
  • subMinutes
  • addHours
  • subHours
  • addDays
  • subDays
  • addWeeks
  • subWeeks
  • addMonths
  • subMonths
  • addYears
  • subYears
  • greeting
  • allTimezone
  • setTimeZone
  • getTimeZone
• HttpRequest
  • url
  • http
  • host
  • full
  • path
  • server
  • request
  • referral
• Cookie
  • Usage
  • set
  • get
  • forget
  • expire
  • all
  • has
• Hash
  • Usage
  • make
  • check
• Asset
  • Asset config
    • Asset Cache
• View
  • Usage
  • Support
  • Helper tview
• Env
  • Env Create
  • Env Load
  • Env Update
• Manager
  • Key Management
  • Helper tmanager
• Server
  • Get Servers
  • Create Custom Config
  • Create Config Template File
• Autoload Register
• Helpers Functions
• Error Dump
• Error Status
• Useful links

Requirements

• >= php 8.0+

Installation

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

All Paths

Number to Words

• Has three chainable methods
  • Can translate all the way to vigintillion
  • It's helper class can be called, using -- NumberToWords()

Iso

• Takes param as string and case-insensitive

Cents

• Takes param as boolean. Default is false
  • By default, it doesn't format the decimals .00 Must be set to true, to format if needed.

Value

• Takes one param as int | float | string
  • If numbers is larger than a trillion 1_000_000_000_000, then the value must be passed as a string.

toText

• Convert number to readable words
  • Below, we're using the function helper method

toNumber

• Convert words to number
  • comma , is used to seperate decimals in words

Tame

• The Core Class of Components
  • It's helper class can be called, using -- Tame()

byteToUnit

• Accepts 5 param. first param alone is needed
  • All other params are [optional]

unitToByte

fileTime

• Returns last edited time of the file as an - int|false

exists

• Checks if a file exists and is not a directory - bool

unlink

• Deletes a file from the server if it exists and does not match the restricted file name - void
  • [optional] second param

mask

• Masks characters in a string based on position and length, with support for emails and custom masking characters.

Example:

imageToBase64

• Converts an image file to its Base64 representation. Supports local files and direct URLs - null|string

emailValidator

• Validates an email address with optional domain and server verification - bool

platformIcon

• Returns the path to the SVG icon for the specified platform or operating system.

Example

paymentIcon

• Retrieves the path to the SVG icon for a specified payment method.

Example

calPercentageBetweenNumbers

• Calculates the percentage relationship between two numbers as an - int

formatNumberToNearestThousand

• Formats a number to its nearest thousand, million, billion, or higher as a - string|float|int

Str

• The Core Class For String Manipulations
  • It's helper class can be called, using -- TameStr()

Str Usage

Country

• Country data and helpers
  • Class: Tamedevelopers\Support\Country
  • It's helper class can be called, using -- TameCountry()

Country Usage

• ISO codes and flags

• Months, Weeks, Time Zones, Captcha Locale

File

• The Core File utilities (read, write, copy, move, info).
  • Class: Tamedevelopers\Support\Capsule\File

File Usage

Collection

• Lightweight collection utilities.
  • Class: Tamedevelopers\Support\Collections\Collection
  • It's helper class can be called, using -- TameCollect() | tcollect()

Collection Usage

Mail

• The Core Class/Wrapper For PHPMailer
  • It's helper class can be called, using -- TameMail()

to

• Accepts multiple emails as array|string

attach

• Accepts multiple complex data as attachment as array|string

subject

• Accepts mandatory string

body

• Accepts mandatory string

send

• Accepts [optional] closure/function

flush

• Accepts mandatory bool Default value is false
  • Clear buffers and send email in the background without waiting (But only to be used when using an API/Submitting via Ajax/Fetch or similar method of form submission)

Zip

• Takes two param as string
  • [sourcePath] path to zip-directory
  • [destination] path to save zip file

Unzip

• Takes two param as string
  • [sourcePath] path of zip-file
  • [destination] path to unzip-directory

Zip Download

• Takes two param as string | boolean
  • [fileName] path of zip-file
  • [unlink] Default is true unlinks file after download

PDF

• Require package to be installed - composer require dompdf/dompdf
  • It's helper class can be called, using -- TamePDF()

PDF Usage

Read PDF

• Takes one param as string
  • [path] absolute path to PDF file

Time

• Class: \Tamedevelopers\Support\Time
  • It's helper class can be called, using -- TameTime()

Time Usage

• Get time date from class

now

• Returns the Time Object with current timestamp of now

date

• Accepts one param as (time) int|string

today

• Thesame as now() with timestamp of today

yesterday

• Thesame as now() with timestamp of yesterday

createFromFormat

• Accepts two parameter [date, format]
  • only [date] is mandatory and returns the Time(object)

timestamp

• Accepts two parameter [date, format]
  • only [date] is mandatory and returns formated timestamp

toJsTimer

• Accept one parameter as [date]. Returns formated javascript timestamp

diff

• Takes one paramater as mode. Different between the given date a current time as now
  • Return an array if [mode] is not found or value of mode set

diffBetween

• Takes three paramater as firstDate \| lastDate \| mode. Thesame as diff.

ago

• ago() or timeAgo(), Takes one paramater as mode

range

• Build date range according to value given
  • Accepts (2) params value and format

get output

• To get the output, we need to call the TimeHelper format method
  • The format() method takes two [optional] param. start, year as boolean

addSeconds

• Can be called using boht [plural|singular] formats. To add more dates with already existing time.

subSeconds

• Can be called using boht [plural|singular] formats. To subtract dates from already existing time.

allTimezone

setTimeZone

getTimeZone

HttpRequest

• Http Request Helper
  • It's helper class can be called, using -- TameRequest()|urlHelper()
  • urlHelper() was older method name. We still keep for older project support.

Cookie

• Class: \Tamedevelopers\Support\Cookie
  • It's helper class can be called, using -- TameCookie()

Cookie Usage

Set

• Takes 7 param
  • Mandatory $name param as string
  • [optional] $value param as string | null
  • [optional] $minutes param as int | string
  • [optional] $path param as string | null
  • [optional] $domain param as string | null
  • [optional] $secure param as bool | null
  • [optional] $httponly param as bool | null

Get

• Takes param as string

Forget

• Takes 3 param
  • Mandatory $name param as string
  • [optional] $path param as string | null
  • [optional] $domain param as string | null

Has

• Takes param as string
  • Returns bool

Hash

Hash Usage

• Password hashing and verify

hash-make

hash-check

Asset

• Takes a param as string path to asset file
  • Default [dir] is set to public
  • It's helper class can be called, using -- tasset()

Asset Config

• Takes three param as string
  • It's helper class can be called, using -- config_asset()

Asset Cache

• By Default, cache is set to false

  • You'll see a link representation as http://domain.com/[path_to_asset_file]?v=111111111
• or -- using helper method

View

View Usage

• Basic usage with layout and sections

• Rendering multiple times safely (same instance)

• Render and capture as a string

View Support

• Supported extensions for views [only resolves filename]
  • Similar Laravel blade syntax usage

Samples

View Helper

• It's helper class can be called, using -- tview()

Env

• By default it use the default root as .env path, so mandatory to install vendor in root directory.

Env Create

• To create an environment .env file. Create or ignore if exists

Env Load

• To load the environment .env file
  • Takes optional param as string $path

Env Update

• Returns true|false. Used to update env variables
  • It's helper class can be called, using -- env_update()

Server

• Return instance of Server
  • It's helper class can be called, using -- server()

Get Servers

• Returns assoc arrays of Server
  • server\|domain

Create Custom Config

• With this helper you can be able to create your own custom config by extending the Default Config Method
  • When using this model, make sure every of your php file returns an associative array for the key to work

• Create our own config to extends the default

• or -- using helpers

Manager

Key Management

• The package enforces a valid application key in .env as APP_KEY.

• If APP_KEY is missing, invalid, or manually altered, the application will return HTTP 500 until a new key is generated via the API below.

• Valid key format is Laravel-style: base64: followed by base64 of 32 random bytes.

Helper tmanager

• You can use the helper for convenience:

Autoload Register

• Takes a string|array as parameter
  • Register one or more folders containing your PHP files
  • Automatically loads Files|Classes in the folder and sub-folders

Helpers Functions

Error Dump

Useful Links

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