Download the PHP package stein197/doxer without Composer

On this page you can find all versions of the php package stein197/doxer. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Example code of stein197/doxer

Informations about the package doxer

PHP docblock comment parser

Simple PHP documentation comment parser. First, install it via composer as follows:

And then use it like this:

Each docblock comment can have tags which start with @ sign and each tag can have an array of properties and an optional description. The next list shows which tags are currently supported:

So for example if tag "@return string A string" is parsed, it's properties will only contain type entry:

But if the tag does not match any of predefined, then it will be parsed as @tag [<description>]. So for example if tag "@nonexistent string A string" is parsed, all it will contain is a description:

If tag to be parsed can have properties but has incorrect syntax, properties and description will be nulls:

NOTE! If tag accepts name property which will start with $ sign (@param, @var tags), then after retrieving name property the name will be retrieved without leading "$":

API

The only class that is supposed to be used is Stein197\Doxer\Doc, which accepts a docblock string as the only constructor parameter. Then the next methods could be used:

Method Return type Description
getDescription() string Returns docblock description or null if it's not present
getTags(?string $name = null) Stein197\Doxer\Tag[] Returns an array of tags or null if there are no tags present. If optional parameter is passed then only tags with matching name will be retrieved
exists() bool Returns true if doc exists. Even empty description block treats as existing one

The next table contains list of Stein197\Doxer\Tag public methods:

Method Return type Description
getDescription() string Returns tag description or null if it's not present
getName() string Returns the name of a tag without leading @ sign
getProperties() string[] Returns an array of tag properties or null if there are no properties
getProperty(string $name) string Returns single property value or null if there is no such property

Tests

To run unit tests call the test composer script:

All versions of doxer with dependencies

PHP Build Version
Package Version
Requires php Version >=7.4
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package stein197/doxer contains the following files

Loading the files please wait ....