Download the PHP package romanzipp/laravel-model-doc without Composer

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

Informations about the package laravel-model-doc

Laravel Model PHPDoc Generator

Latest Stable Version Total Downloads License GitHub Build Status

Generate PHPDoc comments for Laravel Models including database columns, relationships, accessors, query scopes and factories.

Contents

Installation

Configuration

Copy configuration to config folder:

Usage

See the configuration file for more specific use cases.

Prepare your models

  1. Add the corresponding table name
  2. Add relation methods return types
  3. Add accessor methods return types

Example

Set custom path

You can set a custom base path for the generator using the usePath static method.

See the configuration file for more specific use cases.

Use verbose mode

If you get an error when generating the documentation for a model, you can use the --v option to get more information about the error.

Custom database types

If (in verbose mode) you get an error like Unknown database type enum requested, you can add that custom type mapping in Laravel's database.php config file. Laravel uses the Doctrine DBAL package for database types. You can find a list of supported types here. Laravel provides an example for timestamp type mapping here.

Here is an example for enum type mapping in database.php config file:

Features

Testing

SQLite

MariaDB

Requires Lando.

All versions of laravel-model-doc with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
illuminate/database Version ^11.0
illuminate/console Version ^11.0
illuminate/support Version ^11.0
phpowermove/docblock Version ^4.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 romanzipp/laravel-model-doc contains the following files

Loading the files please wait ....