Download the PHP package awema-pl/module-docs without Composer

On this page you can find all versions of the php package awema-pl/module-docs. 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 awema-pl/module-docs

Informations about the package module-docs

Docs

Coverage report Build status Composer Ready Downloads Last version

Awema packages documentation reader

Installation

Via Composer

The package will automatically register itself.

You can publish the views with:

You can publish the config file with:

Adding docs routes

Add to routes\web.php

Examples of use

Methods

all()

Docs::all($withDocs = true);

Output:

Input param $withDocs is bollean, optional and is true by default.

if $withDocs == false file content will be null

get()

Docs::get(['package1' => ['1.0', '2.6'], 'package2' => '1.3', 'package3'], 'package4', $withDocs = true);

Last bool param $withDocs is optional and is true by default

Method output is the same as for all(), but will contain only specified in args packages and versions.

If packages are not listed result will contain all packages.

If versions for specified package is not listed result will contain all versions for that package

package()

Docs::package('package1', $withDocs = true);

Output:

If package is not in the docs, result will be null.

Last bool param $withDocs is optional and is true by default.

If $withDocs == false file content will be null.

versions()

Docs::versions('package1', $withDocs = true);

Output:

If package is not in the docs, result will be null.

Last bool param $withDocs is optional and is true by default.

If $withDocs == false file content will be null.

version()

Docs::version('package1', '1.0', $withDocs = true);

Output:

If package or version is not in the docs, result will be null.

Last bool param $withDocs is optional and is true by default.

If $withDocs == false file content will be null.

files()

Docs::files('package1', '1.0', $withDocs = true);

Output:

If package or version is not in the docs, result will be null.

Last bool param $withDocs is optional and is true by default.

If $withDocs == false file content will be null.

file()

Docs::file('package1', '1.0', 'file.md');

Output:

If package or version or file is not in the docs, result will be null.

fileContent()

Docs::fileContent('package1', '1.0', 'file.md');

Result is file content string or null if file does not exists

list()

Docs::list();

Output is array of packages names

Docs::list('package1');

Output is array of package versions names

If package is not in the docs, result will be null.

Docs::list('package1', '1.0');

Output is array of package version files names

If package or version is not in the docs, result will be null.

Docs::list('package1', '1.0', 'file.md');

Result is file content string or null if file does not exists

Testing

You can run the tests with:

Contributing

Please see contributing.md for details and a todolist.

Security

If you discover any security related issues, please email :author_email instead of using the issue tracker.

Credits

License

license. Please see the license file for more information.

All versions of module-docs with dependencies

PHP Build Version
Package Version
Requires symfony/yaml Version ^4.2
league/commonmark Version ^1.5.4
illuminate/support Version ~5|~6|~7|~8|~9
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 awema-pl/module-docs contains the following files

Loading the files please wait ....