Download the PHP package sashabo/nginx-conf-parser without Composer
On this page you can find all versions of the php package sashabo/nginx-conf-parser. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download sashabo/nginx-conf-parser
More information about sashabo/nginx-conf-parser
Files in sashabo/nginx-conf-parser
Package nginx-conf-parser
Short Description Parsing nginx.conf files and following includes
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package nginx-conf-parser
nginx-conf-parser
A PHP library for parsing nginx.conf files. No dependencies.
Installation
composer require sashabo/nginx-conf-parser
Usage
To parse nginx.conf from string use static method:
SashaBo\NginxConfParser\Parser::parseString(string $source): array
To parse from file:
SashaBo\NginxConfParser\Parser::parseFile(string $path, bool $followIncludes = false): array
Both return :
name - the name of nginx.conf parameter.
values - an array or words going after the name. For example:
rows - an array of rows in {...}.
So, a row with name 'http' contains rows with name 'server', and they - rows with name 'location'.
position, line and linePosition start from 0. For the 'server_name'
nginx parameter these three values describe the position of 's' symbol.
length is counted from the first symbol of the name ('s' for
'server_name') to the ';' or '}' symbol including them. So you can use
position and length to remove or replace the whole nginx parameter or
the block of parameters with substr_replace, and your nginx.conf will be
still valid.
Behavior
The parser doesn't interpret nginx.conf data, just parses. It knows nothing about nginx parameters, just follows the syntax. If your nginx.conf file contains wrong data, the parser won't throw exceptions while the structure of the file is correct.
The only command the parser understands is include if $followIncludes
is true. In this case, parser will parse also included file (or few files
if there is a pattern like sites-enabled/*.conf) and replace the
include row with rows from the included file.
Composing nginx.conf
The package contains a tool for composing parsed (or generated) data back
to nginx.conf file. To do this, use static method
SashaBo\NginxConfParser\Composer::compose(array $rows): string
Searching parameters in nginx.conf
Since 1.2.0 the package contains Finder class with these methods:
Using variables
Since 1.2.0 the package contains VariableReplacer class with these methods:
Example:
