$dsn
$dsn : string
Data Source Name (DSN), a reference to a path on a local or remote system with the ability to add parameters.
The format for the DSN is inspired by the PDO DSN format ({@see}) where you have a string containing Semicolon Separated Values (SSV), where each part is a key=value pair. Exception to this rule is the first entry in the string; this is the URI where the referenced Data Source is located.
A simple example can be a reference to your project folder:
file:///home/mvriel/project/src
Yet a more complex example may be a reference to a specific branch on a git repository:
git+https://github.com/phpDocumentor/phpDocumentor;path=/src;branch=release/3.0
In the example above we reference a git repository using the http protocol and as options we mention that the branch
that we would like to parse is release/3.0
and in it we want to start at the path /src
.
$dsn : string
$parameters : string[]