README

FlushDNS is a PHP library to flush the DNS cache of the current machine.

It also provides a command line utility: flushdns.

Compatible with MacOS, Linux, and Windows.

🚀 Installation

composer require knotsphp/flushdns

📚 Usage

use KnotsPHP\FlushDNS\FlushDNS;

// Flush DNS cache
$success = FlushDNS::run(); 

// Only get the command
$command = FlushDNS::getCommand();

// Check if the command needs elevated privileges
$needsElevation = FlushDNS::needsElevation();

This library also comes some helpers fnuctions for Curl:

// Get options to ignore dns cache
$flushDnsOptions = FlushDNS::getCurlOpts();

// Make the request
$curl = curl_init();
curl_setopt_array($curl, array_merge(
    [
        CURLOPT_URL => "https://app.unolia.com/api/v1/domains",
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_HTTPHEADER => [
            "Accept: application/json",
            "Authorization: Bearer 123"
        ],
    ],
    $flushDnsOptions,
));
$response = curl_exec($curl);
$domains = json_decode($response);
curl_close($curl);

📚 Use in command line

You can also use this library in the command line by using the flushdns command.

It's recommended to install the library globally to use it in the command line.

composer global require knotsphp/flushdns

Then you can use the flushdns command to get the public IP address of the current machine.

# In your project directory
vendor/bin/flushdns

# Globally installed
flushdns

📖 Documentation

This library is compatible with MacOS, Linux, and Windows.

Some operating systems may require root access to flush the DNS cache.

📋 TODO

Add argument to public static method to get a command for a specific OS. (needs knotsphp/system updated)
Add support for more operating systems.
Add support for running elevated commands on MacOS and Linux by passing the password as an argument or having a gui prompt depending of the context. (needs knotsphp/elevated to be written)

🤝 Contributing

Clone the project and run composer update to install the dependencies.

Before pushing your changes, run composer qa.

This will run pint (code style), phpstan (static analysis), and pest (tests).

👥 Credits

FlushDNS was created by Eser DENIZ.

📝 License

FlushDNS is licensed under the MIT License. See LICENSE for more information.

knotsphp / flushdns

Maintainers

Details