Download the PHP package ncuesta/pinocchio without Composer

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

Pinocchio

Build Status

Annotated Source generator for PHP (port of Docco). This library has been inspired by Phrocco.

Pinocchio crawls the source files on a project and automatically generates annotated source HTML pages that serve both as self-documented projects and API-like documentation.

You may see the annotated source of Pinnochio, for an example.

Key benefits

Installation

You can install Pinocchio using Composer. It is more likely that you'll use Pinocchio as a development library and not as one that will actually be required for the use of your project, so you might want to use it as a dev requirement in your composer.json file like this:

Once you have that, you can install it providing the --dev flag:

If Composer complains about stability issues, you might need to add a minimum-stability key to the composer.json file like follows:

Usage

Once installed via Composer you can use Pinocchio directly from the command-line interface as follows. Please note that vendor/bin/pinocchio is the path to Pinocchio's executable, and that vendor/bin is the directory in which Composer installs any vendor binary files by default. If you have changed this path, be sure that you are running Pinocchio from your specific one.

So, running:

will crawl for any source files under ./src directory and will generate their corresponding annotated source files under ./output. See below for further customization of this behavior.

Configuration

Pinocchio can be configured in many ways. You can provide your configuration options when running the script, have your settings taken from a configuration file located on the root of your project, or a combination of both.

The order in which option sources are considered is:

  1. Command-line arguments
  2. Configuration file values
  3. Default values

Configuration options

Here is a list of all the configuration options and their acceptable values:

Configuration as arguments

When running Pinocchio you can pass arguments that will be considered as configuration options. For instance:

Will tell Pinocchio that the source option has been set to src and output to annotated-source.

Configuration file

If a file named pinocchio.json is found at the directory in which you invoke Pinocchio (namely your project's root), it will be used as an configuration source. For instance:

Default values

All configuration values have a sensible default value so that you don't have to configure anything. Here is a list of all the default values for the different configuration options:

Contributing

Pinocchio is an Open Source project and hence any collaborations, suggestions or whatsoever are welcome. For any of those matters, please use the Issues or create Pull Requests.

License

Pinocchio is licensed under the MIT License. Here you have the boring legal stuff:


All versions of pinocchio with dependencies

PHP Build Version
Package Version
Requires php Version >=5.3.6
ncuesta/clinner Version ~1.0
dflydev/markdown Version ~1.0
guzzle/guzzle Version ~3.9.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 ncuesta/pinocchio contains the following files

Loading the files please wait ....