ongom / hot-lib
A PHP library for providing most of the common PHP function like session, flash messeging and also file hundling.
README
This is a php library that provides most of the common controller methods. It has on it static methods like;
session()
It saves and retrieve session variable. You don't need to start session.
Hot\Hot::session('key', 'value'); Hot\Hot::session('active_user', ['user_id'=>2]); // will set active_user to the session variable Hot\Hot::session('active_user'); // will get active_user from the session variable
deleteSession()
Will delete the session key from the the session variable. If no parameter is passed, it unset the entire session.
Hot\Hot::deleteSession('active_user'); // will delete session key called active_user from the session variable Hot\Hot::deleteSession(); // unsets the session.
flash()
It sets and retrieve flash messege. This messege will appear only once. It also uses sessinon under in the background.
Hot\Hot::flash('seccess', 'sent the messege successfully'); // will set flash messege with key success Hot\Hot::flash('success'); // will get flash messege with key sucsess
redirect()
Redirects the request to a new route. It takes in the new redirect route.
Hot\Hot::redirect('/login'); // if using a route Hot\Hot::redirect('https://www.youtube.com'); // if using php core without routing library
exist()
Checks if a paticular data exists. it returns boolean. Null, 0 and empty string returns false
Hot\Data::exist('hello');
json()
Converts array to json object. Has no effect on numbers and strings.
Hot\Data::json(['name'=>'tom']);
send()
Converts array to json object and echo it. Has no effect on numbers and strings.
Hot\Data::send(['name'=>'tom']);
array()
Converts object class array to standard arrays. Has no effect on numbers and strings.
Hot\Data::array(stdClass Object ([name] => tom [age] => 13)); // ['name'=>'tom', 'age'=>13]
object()
Converts array to standard class object. Has no effect on numbers and strings.
Hot\Data::object(['name'=>'tom', 'age'=>13]); // stdClass Object ([name] => tom [age] => 13)
rundom()
Generate random string of default length 8. Takes in the length of the string as one parameter.
Hot\Hot::random(5);
sequence()
Generate and returns sequence of number from down to up or from up to down. Takes in the three number parameter; from, to and steps.
Hot\Number::sequence(1,8,3); // OR Hot\Number::sequence(8, 5, 0.2);
get()
Returns the varables which are on get superglobal in object form. It takes in $_GET supergloble variable
Hot\Data::get($_GET); //Also after calling the method, you can access tha keys Data::$get->key; Data::$get->name;
post()
Returns the varables which are on post superglobal in object form. It takes in $_POST supergloble variable
Hot\Data::post($_POST); //Also after calling the method, you can access tha keys Data::$post->key; Data::$post->name;
upload()
It uploads single or multiple files locally on the server. It also renames the files before saving it. Takes in four parameters, the file, upload path, array of allowed extension minimum accepted file size and maximum accepted file size and it retuns a string for single file, array for multiple files and false for failure to upload.
Hot\File::upload($_FILES['image'], 'path/to/upload/directory', ['jpg','png'], 5, 20); // min size = 5 and max size = 20 Hot\File::upload($_FILES['image'], 'path/to/upload/directory'); //last three parameters are optional.
delete()
It deletes any file from the server. It takes in a string or array of filenames and the directory where it is stored.
Hot\File::delete('logo.png','path/to/directory',); //or Hot\File::delete(['logo.png','image.jpg'] , 'path/to/directory');
files()
It gets all the files from the provided directory. It take in an array or string of filename, and the derectory where the files is stored and an optional falback inmage which can either be a link or the file on the server.
Hot\File::files('logo.png','path/to/directory'); // Hot\File::files(['logo.png','image.jpg'],'path/to/directory'); // Hot\File::files(['logo.png','image.jpg'],'path/to/directory', 'logo.png');
exist()
It gets all the files if the file exist on the server. takes in the file path and returns a boolean.
Hot\File::exist('path/to/directory/logo.png');
env()
It reads a particular evironment variable from the .env file. It returns the value of the key passed. If no key is passed it returns the whole env array results.
Hot\Data::env(); //returns array; Hot\Data::env('passcode'); //returns the value of the key;
format()
It formats the number with commas by default. It takes in the number and an optional formatter, if formatter is not passed, it default to comma.
Hot\Number::format(10000); // 10,000 Hot\Number::format(10000000, '.'); //10.000.000
matrix()
Converts large numbers to shorthands like 10M for 10000000, 1.3k for 1300, etc. It takes in the number and the optional precision.
Hot\Number::martix(10000); // 10K Hot\Number::martix(10000000, 2); //10.00M
chop()
It cuts some part of the array or string off from some position to a particular position.
Hot\Hot::chop('Test text', 1, 6); // Test t Hot\Hot::chop([1,2,3,4,5,6,], 1, 4); //[1,2,3,4]
trancate()
Instead of rounding off, it trancates the number to some required precision.
Hot\Number::trancate(15.57, 1); //15.5
ago()
Takes in the date or time and returns how much time has passed. Returns false if less than 1 seconds.
Hot\Time::ago('2024-11-10 14:00:00');
left()
Takes in the date or time ahead and returns how much time is left. Returns false if less than 1 seconds.
Hot\Time::left('2024-11-15 11:38:00');
hash()
Takes in plain text and reterns the hash. There more methods with different algorithms like bcrypt(123456), algon2i(123456), algon21i(123456)
Hot\Password::hash('123456');
verify()
Takes in plain text and hashed text then, reterns a boolean, true for match and false for not matching.
Hot\Password::verify('123455', '$pdojshjs...');