Download the PHP package machitgarha/bimoo without Composer

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

Bimoo

Moodle declaration stubs, including classes, functions and globals, thanks to php-stubs/generator, helping IDEs and static analyzers.

Note: The stubs file may be incomplete for your usage (generated for a limited portion of stuff), and may not be updated regularly. However, contributions, including issues and pull requests, will be really welcomed.

How to use it?

First, thanks for using this.

Simply, require it in your composer.json:

Now, your IDE (or text editor) should show you the suggestions for Moodle functions and classes. Not limited to this, you can guide your static analyzer as well.

What is included?

First things first: The stubs file is generated from official mirror Moodle repository. The updates to stubs.php must be done and commited manually from the repository, but the whole process to do so is almost automated (using bin/generate-stubs executable).

To see what paths are included and what not, see data/path-list.json file. You can use glob patterns in it, while it is not recommended (because it leads to huge stubs file).

Release management

To follow Moodle versions properly, and prevent from conflicts and confusions, instead of using semantic versioning, we use the following method:

Each version is in the form of <MoodleMajor>.<MoodleMinor>.<BimooUpdate>.

<MoodleMajor> and <MoodleMinor> are the pieces of Moodle release number a version of Bimoo is based on, as stated here. The reason why the bug-fix piece of Moodle version is not included, is what its official documentation says: "Releases like 2.2.1, 2.2.2, 2.2.3 etc only include fixes based on the latest major release (2.2) and never any significant new features or database changes".

<BimooUpdate> is the state of the current library for that specific Moodle version. In other words, considering a particular minor release of Moodle, it increases whenever an update is made to the library (i.e. the stubs file).

For example, 3.11.19 means the twentieth series of changes supporting Moodle 3.11.*. Pay attention, it has nothing to do with Moodle 3.11.19 (which, perhaps, will never be released).

Every Moodle version older than latest supported is followed in a separate branch. The branches are named as their Moodle version they follow, e.g. 3.9. Ideally, master branch follows the latest Moodle version.

Note: There is no guarantee to support all versions Moodle currently supports. However, support is pretty much welcomed from the community (maybe you?).

To-Do

Contributions

Feel free to do so.

Re-generating stubs file

First, add your files and patterns to data/path-list.json file. Then, issue the following command for the stubs.php to be re-generated automatically:

<moodle-root-dir> is the path to either a Moodle installation, or (a clone of) the official repository (see --help for more information).

That's it! Commit the changes, make a PR, and we would all be happy!

License

Licensed under GPL 3.0.

All versions of bimoo with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4|^8.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 machitgarha/bimoo contains the following files

Loading the files please wait ....