Download the PHP package neighborhoods/kojo-phinx-templates without Composer

On this page you can find all versions of the php package neighborhoods/kojo-phinx-templates. 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 neighborhoods/kojo-phinx-templates

Informations about the package kojo-phinx-templates

Phinx templates for Kōjō

A developer utility to generate Kōjō related Phinx migrations and seeds.

Install

Via Composer as a development dependency

You should also have Phinx and Kōjō as direct dependencies. Don't rely on this package pulling them in, especially since this is a dev dependency.

This package requires Phinx 0.12.5 or above. If you're having issues with running the command above, send the composer.json file to the code owner.

Use cases

Possible use cases are described below.

Kōjō setup

Create migration for Kōjō setup. Every project using Kōjō should have it.

If you open the file you'll see that the template assumes that Kōjō parameters are located in the kojo-environment folder inside the current working directly.
That's because the kojo-environment folder is usually located in the application root from where migrations are usually run using vendor/bin/phinx migrate command.
You might need to update the path to Kōjō parameters. If so, consider defining it relative to the migration file, using the __DIR__ constant.

Job Type Creation

For each new worker generate a migration defining the job type. In these examples the worker name is Observer. Use something more descriptive, like the component name.

Open the generated migration, update the job type attributes. The values in the migration should not depend on other classes. Copy constant values, rather than referencing them.

Thanks to @jpmarcotte for insights on this one.

Job Scheduling

If it makes sense, create a seeder scheduling the job. This is useful for jobs rescheduling themselves, providing a way to start the initial job.

Open the generated seeder and update the JOB_TYPE_CODE constant.

Run the generated seeder whenever you want to start the job.

Jobs rescheduling themselves should be seeded after their job type creation. Integrating the seeding into migrations simplifies the deployment process and ensures the job is seeded only once.
Generate a seeding migration by running the command below.

Open the generated migration and update the Seed class name in the required seed file path, up() and down() methods.

All versions of kojo-phinx-templates with dependencies

PHP Build Version
Package Version
Requires neighborhoods/kojo Version ^5
php Version >=7.2
robmorgan/phinx Version ^0.12.5
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 neighborhoods/kojo-phinx-templates contains the following files

Loading the files please wait ....