jorisros/nginxparser

A class for parsing nginx config files in PHP

, _(*1)

NginxParser

Read and create Nginx config files in php, _(*2)

Requirements

• PHP >= 7.4
• Nginx installed (for the validate function)

Composer

Use composer to to add the classes to your project, _(*3)

composer require jorisros/nginxparser

Run tests

Run in the main directory the following command, _(*4)

./vendor/bin/phpunit tests

Examples

Examples to use the class, _(*5)

Simple config file, _(*6)

<?php

require __DIR__ . '/vendor/autoload.php';

use JorisRos\NginxParser\NginxParser;
use JorisRos\NginxParser\NginxElement;

$config = new NginxParser('server');

$location = new NginxParser('location','/');
$location->setRoot('/usr/share/nginx/html')
         ->setIndex(array('index.html', 'index.htm'));

$config ->setPort(80)
        ->setServerName(array('localhost','local','serveralias'))
        ->setAccessLog('/var/log/nginx/log/host.access.log')
        ->setLocation($location);

if($config->validate())
{
    $strFile = $config->build();
    file_put_contents('server.conf', $strFile);
}else{
    foreach ($config->getValidatorErrors() as $error) {
        # code...
    }
}

It will result in, _(*7)

server {
    port        80;
    server_name     localhost;
    server_alias        local serveralias;
    access_log      /var/log/nginx/log/host.access.log;

    location / {
        root        /usr/share/nginx/html;
        index       index.html index.htm;
    }

}

Read existing config file, _(*8)

<?php

require __DIR__ . '/vendor/autoload.php';

use JorisRos\NginxParser\NginxParser;
use JorisRos\NginxParser\NginxElement;

$d = new NginxParser();
$objects = $d->readFromFile('Resources/nginx-config/nginx.conf');

//var_dump($objects);

foreach($objects as $object)
{
    print($object->build());
}

, _(*9)