Download the PHP package smartfactory/phpdoxy without Composer

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

PhpDoxy

PhpDoxy is a performant and efficient generator for handful PHP documentation with robust checking for typing errors, missing descriptions, dead references etc.

Example

http://php-smart-factory.org/smartfactory/

Requirements

Installation

composer.json

Key features

Supported tags

Usage

The configuration for the PhpDoxy has to be placed to the configuration file phpdoxy_config.xml. In the case of command line usage, the configuration file may have arbitrary name.

The configuration file should be placed in the working directory of the script. In the case of command line usage, the configuration file could be passed as parameter with a valid relative or absolute path.

WEB

There is an example script in examples/generate.php.

  1. Put the script to the directory of your application. Ensure that the including of the vendor/autoload.php is valid.
  2. Put the configuration file phpdoxy_config.xml to the directory of your application and specify there the source directory with your code to be documented and the target directory for the generated documentation.
  3. Run the generate.php from your browser.

Command Line

The composer creates a "binary" script vendor/bin/phpdoxy in the vendor directory. You can call it from command line like this:

If the configuration file resides in the working directory, it can be omitted by call.

Configuration

The configuration for the documentation generation is setup in the XML file phpdoxy_config.xml.

title

The name of your project or library.

source

The source directory wuth your code to be documentated. The path can be either absolute or relative. If the path is relative, the PhpDoxy tries to find the path based from the directory containing the configuration file and from the working directory.

target

The target directory for the generated documentation. The path can be either absolute or relative. If the path is relative, the PhpDoxy tries to find the path based from the directory containing the configuration file and from the working directory.

template

The name of the template to be used for the generation. PhpDoxy has the directory templates in its base directory. There, the templates reside. Alernatively, you can specify absolute or relative path to the template. If the path is relative, the PhpDoxy tries to find the path based from the directory containing the configuration file and from the working directory.

user_files

This part is optional and should be used if you want to include your own files into the documentation. You should set the following data:

Demo

https://github.com/oschildt/PhpDoxyDemo

  1. Git-clone the demo application and run 'composer update'.
  2. Run generate.php from your browser or generate.cmd/generate.sh.
  3. Study the source code in the directory src and the resulting documentation in the directory docs.

Implementation details

The documentation generation is divided in two parts:

The PhpDocParser parses the source files and creates a dictionary (a connected graph) of objects with recursive linking to each other by reference. Do not try to dump it! It is circular recursive.

This dictionary is a pure data model with complete infromation about all objects and their relations, which can be used for the generation of the documentation.

The PhpDocGenerator ueses the dictionary and generates the documentation. It is responsible for visual presentation and structuring of the documentation.


All versions of phpdoxy with dependencies

PHP Build Version
Package Version
Requires php Version >=8.0
nikic/php-parser Version ^4.13
kukulich/fshl Version ^2.1
phpdocumentor/reflection-docblock Version ^5.3
erusev/parsedown Version ^1.7
erusev/parsedown-extra Version ^0.8.1
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 smartfactory/phpdoxy contains the following files

Loading the files please wait ....