PHPackages                             dcarbone/tns-parser - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Parsing &amp; Serialization](/categories/parsing)
4. /
5. dcarbone/tns-parser

ActiveLibrary[Parsing &amp; Serialization](/categories/parsing)

dcarbone/tns-parser
===================

Oracle tnsnames.ora file / string parser written in PHP

0.3.0(8y ago)31151Apache-2.0PHPPHP &gt;=5.4.0

Since Nov 17Pushed 8y ago2 watchersCompare

[ Source](https://github.com/dcarbone/tns-parser)[ Packagist](https://packagist.org/packages/dcarbone/tns-parser)[ Docs](https://github.com/dcarbone/tns-parser)[ RSS](/packages/dcarbone-tns-parser/feed)WikiDiscussions master Synced 2mo ago

READMEChangelog (4)Dependencies (1)Versions (5)Used By (0)

tns-parser
==========

[](#tns-parser)

Oracle tnsnames.ora file / string parser written in PHP

[![Build Status](https://camo.githubusercontent.com/fca01fde4843002811195c5b76f6e1504d5a42bb8289cd82a88dd1c49329d9b6/68747470733a2f2f7472617669732d63692e6f72672f64636172626f6e652f746e732d7061727365722e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/dcarbone/tns-parser)

Installation
============

[](#installation)

This library is designed to be installed using [Composer](https://getcomposer.org/).

Require entry:

```
"dcarbone/tns-parser": "0.1.*"
```

This readme assumes knowledge of [Composer Autoloading](https://getcomposer.org/doc/01-basic-usage.md#autoloading).

Feature List
============

[](#feature-list)

- Able to parse input from file or passed string
- Multi-line and comment agnostic
- Supports multi-entry items (such as multi-address entries)
- Allows searching
- Allows basic sorting based upon entry name
- Implements the follow interfaces:
    - [Serializable](http://php.net/manual/en/class.serializable.php)
    - [JsonSerializable](http://php.net/manual/en/class.jsonserializable.php)
    - [ArrayAccess](http://php.net/manual/en/class.arrayaccess.php)
    - [Iterator](http://php.net/manual/en/class.iterator.php)
    - [Countable](http://php.net/manual/en/class.countable.php)
- Able to export entries as:
    - Original
    - Alphabetized tnsnames.ora file
    - JSON representation

Example Usage
=============

[](#example-usage)

Given the below TNS entries:

```
$tns = parseString($tns);
```

And that's it!

Searching
---------

[](#searching)

During input parsing, all properties for a given TNS entry are stored a multi-dimensional array to allow searching:

```
$matched = $parser->search('awesome');
```

The search result is an array containing the NAMES of any matched entries. The above, in this case, would result in:

```
var_export($matched);
/*
array (
  0 => 'AWESOME.MYSELF.DATABASE',
  1 => 'AWESOME2.MYSELF.DATABASE',
)
*/
```

You can get as specific as you like:

```
$matched = $parser->search('me2.db.myself');
var_export($matched):
/*
array (
  0 => 'AWESOME2.MYSELF.DATABASE',
)
*/
```

You can then use the matched names to retrieve the entries:

```
// Using the 2nd match statement...
$entries = array();
foreach($matched as $name)
{
    $entries = $parser[$name];
}
var_export($entries);
/*
array (
  'DESCRIPTION' =>
  array (
    'ADDRESS_LIST' =>
    array (
      'ADDRESS' =>
      array (
        0 =>
        array (
          'PROTOCOL' => 'TCP',
          'HOST' => 'me2.db.myself.net',
          'PORT' => '12345',
        ),
        1 =>
        array (
          'PROTOCOL' => 'TCP',
          'HOST' => 'me25.db.myself.net',
          'PORT' => '12345',
        ),
      ),
      'LOAD_BALANCE' => 'on',
      'FAILOVER' => 'on',
      'ENABLE' => 'broken',
    ),
    'CONNECT_DATA' =>
    array (
      'SID' => 'AWESOME2',
      'SERVER' => 'dedicated',
      'FAILOVER_MODE' =>
      array (
        'TYPE' => 'select',
        'METHOD' => 'basic',
        'RETRIES' => '120',
        'DELAY' => '2',
      ),
    ),
  ),
)
*/
```

... Or get a valid TNS entry version as a string:

```
$entry = $parser->getTNSEntryString($matched[0]);
var_export($entry);
/*
'AWESOME2.MYSELF.DATABASE =
    (DESCRIPTION =
        (ADDRESS_LIST =
            (ADDRESS =
                (PROTOCOL = TCP)
                (HOST = me2.db.myself.net)
                (PORT = 12345)
            )
            (ADDRESS =
                (PROTOCOL = TCP)
                (HOST = me25.db.myself.net)
                (PORT = 12345)
            )
            (LOAD_BALANCE = on)
            (FAILOVER = on)
            (ENABLE = broken)
        )
        (CONNECT_DATA =
            (SID = AWESOME2)
            (SERVER = dedicated)
            (FAILOVER_MODE =
                (TYPE = select)
                (METHOD = basic)
                (RETRIES = 120)
                (DELAY = 2)
            )
        )
    )'
*/
```

Under the covers, the searching system uses [preg\_match](http://php.net/manual/en/function.preg-match.php), with the following structure: `'{%s}S'` by default, with %s being replaced by your input.

If you wish for a case-sensitive search, pass in `true` as the 2nd parameter when executing `search()`.

Sorting
-------

[](#sorting)

For the moment, searching is limited to alphabetical by entry name, and utilizes [ksort](http://php.net/manual/en/function.ksort.php) under the covers.

```
$parser->sort();
```

Suggestions?
------------

[](#suggestions)

For the moment this library serves my needs, however if anybody using this library would like to see some improvements / modifications made, please let me know!

Tests
-----

[](#tests)

Work in progress.

###  Health Score

26

—

LowBetter than 43% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity15

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity51

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 72.7% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~259 days

Total

4

Last Release

3051d ago

PHP version history (2 changes)0.1.1PHP &gt;=5.3.3

0.3.0PHP &gt;=5.4.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/385c0c0eae1b51f1e81ee464ff6bfb3cce32589ac252ca68cc3a8aec2e3ada14?d=identicon)[dcarbone](/maintainers/dcarbone)

---

Top Contributors

[![dcarbone](https://avatars.githubusercontent.com/u/1392439?v=4)](https://github.com/dcarbone "dcarbone (16 commits)")[![avindra](https://avatars.githubusercontent.com/u/126848?v=4)](https://github.com/avindra "avindra (6 commits)")

---

Tags

oraoracle-tnsnamesphptns-entriestns-parseroracletnstnsnames.oratnsnamestns names

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/dcarbone-tns-parser/health.svg)

```
[![Health](https://phpackages.com/badges/dcarbone-tns-parser/health.svg)](https://phpackages.com/packages/dcarbone-tns-parser)
```

###  Alternatives

[mtdowling/jmespath.php

Declaratively specify how to extract elements from a JSON document

2.0k472.8M135](/packages/mtdowling-jmespathphp)[opis/closure

A library that can be used to serialize closures (anonymous functions) and arbitrary data.

2.6k230.0M284](/packages/opis-closure)[masterminds/html5

An HTML5 parser and serializer.

1.8k242.8M229](/packages/masterminds-html5)[sabberworm/php-css-parser

Parser for CSS Files written in PHP

1.8k191.2M65](/packages/sabberworm-php-css-parser)[michelf/php-markdown

PHP Markdown

3.5k52.4M345](/packages/michelf-php-markdown)[jms/metadata

Class/method/property metadata management in PHP

1.8k152.8M88](/packages/jms-metadata)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
