PHP Luminova: Utility Functions for Basic Operations Using the Func Class

The Func module provides a range of useful methods designed to enhance and standardize data handling in your applications. Key functionalities include:

• Input Formatting: Easily format various types of inputs to ensure consistency and correctness.
• Email Validation: Validate email addresses to confirm they meet standard email format requirements.
• Phone Number Validation: Check phone numbers for proper formatting and validity based on regional rules.
• Randomized String Generation: Create unique, random strings for various purposes, such as tokens or identifiers.
• EAN & UPC Generation: Generate European Article Number (EAN) and Universal Product Code (UPC) for products and inventory management.
• UUID Generation: Generate universally unique identifiers (UUIDs) to ensure the uniqueness of elements or records in your system.
• Email Masking: Protect email addresses by masking them, which helps to prevent spam or unauthorized use.
• String Masking: Apply masking to other sensitive strings to enhance security and privacy.

These methods are designed to eas common data processing tasks, ensuring data integrity and facilitating a smoother development process.

• Class namespace: \Luminova\Functions\Func

Methods

The methods can be accessed through global function helper, Factory instance or call statically.

<?php
echo func()->random(50, 'string');

Or using factory instance to initialize function and call math method.

<?php
use Luminova\Application\Factory;

echo Factory::functions()->random(50, 'string');

Or continently call it statically.

<?php
use \Luminova\Functions\Func;

echo Func::random(50, 'string');

normalize

Format text before display by matching links, email, phone,hashtags and mentions with a link representation and replace multiple line breaks.

public static normalize(string $text, string $target = '_self', string $blocked = null, bool $noHtml = true): string

Parameters:

Return Value:

string - Return the formatted text.

random

Generate a randomize string of integers, characters, alphabets, or password.

public static random(int $length = 10, string $type = 'int', bool $uppercase = false): string

Parameters:

Return Value:

string - Return the generated random value.

bigInteger

Create a random big integer based on minimum and maximum.

public static bigInteger(int $min, int $max): string

Parameters:

Return Value:

string - Return the generated big integer.

ean

Generate product EAN13 id.

public static ean(int $country = 615, int $length = 13): string

Parameters:

Return Value:

string - Return the generated product ean code.

upc

Generate a product UPC ID.

public static upc(int $prefix, int $length = 12): string

Parameters:

Return Value:

string - Return the generated UPC ID.

uuid

Generates a UUID string of the specified version.

public static uuid(int $version = 4, ?string $namespace = null, ?string $name = null): string

Parameters:

Return Value:

string - Return the generated UUID string.

Throws:

• \Luminova\Exceptions\InvalidArgumentException - If the namespace or name is not provided for versions 3 or 5.

isUuid

Validates a UUID string against a specific version.

public static isUuid(string $uuid, int $version = 4): bool

Parameters:

Return Value:

bool - Return true if the UUID is valid, false otherwise.

isEmail

Checks if string is a valid email address

public static isEmail(string $email): bool

Parameters:

Return Value:

bool - Return true if email is valid, otherwise false.

isPhone

Checks if string is a valid phone number.

public static isPhone(string|int $phone, int $min = 10): bool

Parameters:

Return Value:

bool - Return true if phone number is valid, otherwise false.

formatPhone

Formats a phone number as (xxx) xxx-xxxx or xxx-xxxx depending on the length.

public static formatPhone(string $phone): string

Parameters:

Return Value:

string - Return the formatted phone number.

strength

Determine if password strength matches the basic strength recommendation.

public static strength(string $password, int $complexity = 4, int $min = 6, int $max = 50): bool

Parameters:

Return Value:

bool - Return true if password passed, otherwise false.

strictType

Sanitize user input to protect against cross-site scripting attacks by removing unwanted characters from string and retain only expected types.

public static strictType(string $string, string $type = 'name', string $replacement = ''): string

Parameters:

Return Value:

string - Return the sanitized string.

mainDomain

Remove subdomains from a URL and return the main domain name only.

public static mainDomain(string $url): string

Parameters:

Return Value:

string - Return the main domain extracted from the URL.

subdomain

Remove main domain from a URL and return only the first subdomain name.

public static subdomain(string $url): string

Parameters:

Return Value:

string - Return the extracted domain or an empty string if no domain is found.

Note: www is considered as none subdomain.And only the first level of subdomain will be returned if the url contains multiple levels of subdomain.

truncate

Truncate a string in specified length and adds an ellipsis at the end if the text is longer than the specified length.

public static truncate(string $text, int $length = 10, string $encoding = 'UTF-8'): string

Parameters:

Return Value:

string - Return the truncated string.

base64_url_encode

Convert a string to base64 encode in other to pass it as a URL parameter.

public static base64_url_encode(string $input): string

Parameters:

Return Value:

string - Return base64 encoded string url.

base64_url_decode

Decode a URL Base64 decoded string back to it's original content.

public static base64_url_decode(string $input): string

Parameters:

Return Value:

string - Return base64 decoded string.

maskEmail

Mask an email address to hide part of it (e.g pe***[email protected]).

public static maskEmail(string $email, string $masker = '*'): string

Parameters:

Return Value:

string - Return masked email address.

mask

Mask a string by position to hide part of it (e.g: mfk****kld).

public static mask(string $string, string $masker = '*', string $position = 'center'): string

Parameters:

Return Value:

string - Return masked string.