README

A PHP library providing a collection of web-related utility functions for handling HTTP requests, validating web data, and working with URLs.

Installation

Install the package via Composer:

composer require vairogs/functions-web

Requirements

PHP 8.4 or higher Symfony HttpFoundation component

Usage

There are two ways to use this package: via the Functions class or by directly using the traits.

Using the Functions Class

The Functions class provides a comprehensive set of web-related utility functions.

use Vairogs\Functions\Web\Functions;

// Create a new Functions instance
$web = new Functions();

// Validate an IP address
$isValid = $web->validateIPAddress('192.168.1.1');

// Validate an email address
$isValid = $web->validateEmail('user@example.com');

// Check if a URL is absolute
$isAbsolute = $web->isAbsolute('https://example.com');

// Get remote IP address from a request
$ip = $web->remoteIp($request);

// Check if a request is using HTTPS
$isHttps = $web->isHttps($request);

// Encode a URL
$encoded = $web->urlEncode('https://example.com?query=value&special=value with spaces');

Using Traits Directly

Alternatively, you can use the traits directly in your own classes:

use Vairogs\Functions\Web\Traits\_ValidateIPAddress;
use Vairogs\Functions\Web\Traits\_ValidateEmail;
use Vairogs\Functions\Web\Traits\_IsAbsolute;

class MyClass
{
    // Import the traits you need
    use _ValidateIPAddress;
    use _ValidateEmail;
    use _IsAbsolute;

    public function doSomething(): void
    {
        // Use the methods directly
        $isValidIp = $this->validateIPAddress('192.168.1.1');
        $isValidEmail = $this->validateEmail('user@example.com');
        $isAbsoluteUrl = $this->isAbsolute('https://example.com');
    }
}

Note that some traits may depend on other helper traits. The Functions class handles these dependencies for you, but if you use the traits directly, you may need to include these helper traits as well.

Features

For a complete list of all functions available in this package, see Features.

License

This package is licensed under the BSD-3-Clause License.

About Vairogs

This package is part of the vairogs/vairogs project - a comprehensive PHP library and Symfony bundle that provides a collection of utilities, components, and integrations for Symfony applications.

The main project includes:

Various utility functions and components
Doctrine ORM tools and extensions
API Platform integrations
Symfony bundle for easy configuration
And much more

If you find this Web component useful, you might want to check out the full Vairogs project for additional tools and utilities that can enhance your Symfony application development.

To install the complete package:

composer require vairogs/vairogs

vairogs / functions-web

Maintainers

Details