PHP code example of omaralalwi / laravel-api-helpers

    
        
<?php
require_once('vendor/autoload.php');

/* Start to develop here. Best regards https://php-download.com/ */

    

omaralalwi / laravel-api-helpers example snippets

$apiVersion = get_api_v();

// Check if the current API version is 3
if (is_api_v(3)) {
    echo "This is API version 3. ✅";
} else {
    echo "This is not API version 3. ❌";
}

// Verify that the API version is at least version 4
if (api_v_at_least(4)) {
    echo "API version is 4 or higher. 🚀";
} else {
    echo "API version is below 4. Please upgrade.";
}

if (is_api_request()) {
    echo "This is an API request. 🌐";
} else {
    echo "This is not an API request.";
}

$clientIp = get_client_ip();
echo "Client IP: " . ($clientIp ?? "unknown");

$locale = get_request_locale();
echo "Request locale: {$locale}";

$token = get_request_token();
echo $token ? "Token: {$token}" : "No token found.";

$contentType = get_request_content_type();
echo $contentType ? "Content-Type: {$contentType}" : "No Content-Type provided.";

if (is_secure_request()) {
    echo "Secure HTTPS request detected. 🔒";
} else {
    echo "This is not a secure request.";
}

$headers = get_request_headers();
print_r($headers); // Displays all request headers

if (is_api_authenticated()) {
    echo "API user is authenticated. 🔐";
} else {
    echo "API user is not authenticated.";
}

$user = get_auth_user();
echo $user ? "Authenticated user: {$user->name}" : "No authenticated user.";

$apiUser = get_api_user();
echo $apiUser ? "API User: {$apiUser->name}" : "No API user authenticated.";

$apiHelpers = [
    'API Version'             => get_api_v(),
    'Is API v3?'              => is_api_v(3),
    'API Version At Least 4?' => api_v_at_least(4),
    'Is API Request?'         => is_api_request(),
    'Client IP'               => get_client_ip(),
    'Request Locale'          => get_request_locale(),
    'Request Token'           => get_request_token(),
    'Request Content-Type'    => get_request_content_type(),
    'Is Secure Request?'      => is_secure_request(),
    'Request Headers'         => json_encode(get_request_headers()),
    'Is API Authenticated?'   => is_api_authenticated(),
    'Authenticated User'      => optional(get_auth_user())->name ?? 'No Authenticated User',
    'API Authenticated User'  => optional(get_api_user())->name ?? 'No API User Authenticated',
];

\Log::info('API Helper Functions Test:');

foreach ($apiHelpers as $key => $value) {
    \Log::info("{$key}: " . (is_array($value) ? json_encode($value) : $value));
}