Download the PHP package jamiehannaford/doc-validator without Composer

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

Informations about the package doc-validator

doc-validator

Simple scraper for validating nested XML/JSON examples in OpenStack/Rackspace doc files.

General outline

  1. Executes a recursive wget for a given URI. The process follows every link nested in a given piece of markup until every possible link is exhausted. It saves each remote URI to the local filesystem. An example location might be: ./docs/docs.openstack.org, where docs.openstack.org is the root URI you specified. Only HTML files are saved, any other remote file type is omitted.

  2. Once the wget procedure is complete, the PHP script traverses the local directory recursively, scanning each HTML file for a given regex pattern. The regular expression indicates how code samples are nested into the markup.

  3. Once code samples are extracted, the script judges whether it is either JSON or XML. It then executes the relevant parsing test for either type.

  4. If the parsing fails, it is likely malformed, and generates an error. These errors can either be output to the console (i.e. STDOUT) or to a local log file.

CLI options

The main script you will need to run is:

Supported CLI flags

Short Long Description Default
-u --uri The URI which wget points at docs.rackspace.com
-s --skip-wget Instructs the script to skip the wget stage and check the local ./docs version only Disabled
-q --quiet-wget Instructs the script to silence the wget output Disabled
-l --log-file Instructs the script to output everything to a provided file. If left empty, the filename will be the same as the root URI Disabled

Convenience scripts

To run against docs.openstack.org, run: ./bin/openstack

To run against docs.rackspace.com, run: ./bin/rackspace

Installation

You will need to install this package with Composer:

You can then access the binary:

Because you have left the --log-file flag empty, it will log everything to a default location:

All versions of doc-validator with dependencies

PHP Build Version
Package Version
Requires php Version >=5.4
psr/log Version 1.0
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 jamiehannaford/doc-validator contains the following files

Loading the files please wait ....