PHPackages                             ride/lib-api - 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. [API Development](/categories/api)
4. /
5. ride/lib-api

ActiveLibrary[API Development](/categories/api)

ride/lib-api
============

API library of the Ride framework.

1.0.0(9y ago)03.8k2MITPHP

Since Feb 23Pushed 9y ago8 watchersCompare

[ Source](https://github.com/all-ride/ride-lib-api)[ Packagist](https://packagist.org/packages/ride/lib-api)[ RSS](/packages/ride-lib-api/feed)WikiDiscussions master Synced today

READMEChangelogDependencies (1)Versions (5)Used By (2)

Ride: API Library
=================

[](#ride-api-library)

Library to browse the API of your PHP code through reflection.

What's In This Library
----------------------

[](#whats-in-this-library)

### DocParser

[](#docparser)

The *DocParser* class parses a doc comment string into a *Doc* instance.

An example of a doc comment string:

```
    /**
     * Gets a list of namespaces
     * @param string $namespace Filter namespaces with the provided namespace
     * @return array Ordered array with the namespace as key and value
     */

```

### Doc

[](#doc)

The *Doc* class is a data container for the doc comment information as parsed by the *DocParser*.

### DocParameter

[](#docparameter)

The *DocParameter* class is a data container for the doc comment information of an argument of a function or method.

### TagParser

[](#tagparser)

The *TagParser* class is used by the *DocParser* to process the different tags (eg @param, @return, ...) of a doc comment.

### Tag

[](#tag)

The *Tag* interface is used to implement a specific doc comment tag.

### ReflectionClass

[](#reflectionclass)

The *ReflectionClass* extends from the PHP core class and adds methods to access the parsed *Doc* instances and other usefull things to generate an API doc.

### ReflectionMethod

[](#reflectionmethod)

The *ReflectionClass* class extends from the PHP core class and adds methods to access the parsed *Doc* instances and the source code.

### ReflectionProperty

[](#reflectionproperty)

The *ReflectionProperty* class extends from the PHP core class and adds methods to access the parsed *Doc* instances.

### ApiBrowser

[](#apibrowser)

The *ApiBrowser* class is the facade to this library. Use this instance to check the available namespaces, the classes which reside therein or the full detail of an individual class.

Code Sample
-----------

[](#code-sample)

Check the following code sample to see some of the possibilities of this library.

```