Download the PHP package pradosoft/apigen without Composer

On this page you can find all versions of the php package pradosoft/apigen. 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?

Informations about the package apigen

Smart and Readable Documentation for your PHP project

Build Status Build status Code Coverage Downloads Latest stable

Just look at CakePHP Framework or Doctrine ORM API.

Note! This is 4.2 branch, final 4.x series of ApiGen. The project is undergoing a rewrite (5.x series on master). Please submit any PRs for versions 4.2.x to 4.2 branch.

Requirements

Install

Install using composer as a development dependency in your project:

Or if you want it globally:

Usage

Run ApiGen with source and destination options:

To omit cli options just create apigen.yaml or apigen.neon file in your project's root folder:

For all available options, along with descriptions and default values, just run:

Documentation

DocBlock Annotations

This section provides a list of PHP DocBlock annotations (tags) that are supported by ApiGen:

Configuration

This section provides information on all available configuration options that can be included in configuration files (apigen.yml or apigen.neon).

Minimal Configuration

A minimal configuration file:

Note! The configuration files match CLI options for generate command. The only difference is that when defining these options in configuration file, you have to use camelCased format (i.e. --annotation-groups CLI option becomes annotationGroups configuration parameter).

Reference Configuration

A reference configuration file with all of the available and supported configuration options.

CLI Commands

This section provides information on all available CLI commands and their options.

Main ApiGen commands:

To get a list of available apigen list command. To get help on specific command use apigen help, i.e.:

$ apigen help generate

Generate

generate command is the main command which generates API documentation. The command relies either on passing it CLI options or reading data from configuration files.

A list of options accepted by generate command:

Option Description
--source (-s) Source directory(-ies) to generate API docs for. Multiple values are allowed.
--destination (-d) Destination directory for API docs.
--access-levels Access levels of methods and properties to be included in API docs [options: public, protected, private]. Default: ["public","protected"].
--annotation-groups Generate page with elements with specific annotation.
--config Custom path to ApiGen configuration file. Default: ./apigen.neon
--google-cse-id Custom Google Search Engine ID (for search box).
--base-url Base URL (used for Sitemap / search box).
--google-analytics Google Analytics tracking code to include in generated API docs.
--debug Turn on debug mode (prints verbose information from low-level parser). Useful when debugging / during development.
--download Pass this option to include a link to a generated ZIP archive in the API docs.
--extensions A list of scanned file extensions. Multiple values are allowed. Default: ["php"].
--exclude Diretories or files matching provided mask will be excluded (e.g. */tests/*). Multiple values are allowed.
--groups Define element grouping in the menu [options: namespaces, packages]. Default: namespaces.
--main Elements with provided main name prefix will be first in the tree.
--internal Include elements marked as @internal.
--php Generate documentation for PHP internal classes.
--no-source-code Do not generate highlighted source code for elements.
--template-theme ApiGen template theme name. [default: "default"].
--template-config Specify your own template config (this setting will override --template-theme).
--title Custom title of API docs.
--tree Generate a tree view of classes, interfaces, traits and exceptions.
--deprecated deprecated, only present for BC
--todo deprecated, only present for BC
--charset deprecated, only present for BC
--skip-doc-path deprecated, only present for BC
--overwrite (-o) Force overwriting of destination directory.
--help (-h) Display help message for all or specific commands.
--quiet (-q) Do not output any messages.
--version (-V) Display version of ApiGen.

Themes

In order to enable a custom theme, you have to either provide --theme-config CLI option when runing apigen generate or add themeConfig configuration option in your ApiGen configuration file:

Contributing

Please refer to CONTRIBUTING for details.

Tests

To run tests:

Get Support!

All versions of apigen with dependencies

PHP Build Version
Package Version
Requires php Version >=5.5
popsul/php-token-reflection Version ^1.5
apigen/theme-bootstrap Version 1.1.*
apigen/theme-default Version 1.0.*
herrera-io/phar-update Version ~2.0
kukulich/fshl Version ~2.1
latte/latte Version ^2.3.6
michelf/php-markdown Version ~1.4
nette/bootstrap Version ^2.3
nette/di Version ^2.3
nette/neon Version ^2.3
nette/reflection Version ^2.3
symfony/console Version ^2.7|~3.0
symfony/event-dispatcher Version ^2.7|~3.0
symfony/options-resolver Version ^2.7|~3.0
symfony/yaml Version ^2.7|~3.0
tracy/tracy Version ^2.3
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 pradosoft/apigen contains the following files

Loading the files please wait ....