Download the PHP package happyculture/kumquat_kickstarter without Composer

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

Kumquat Kickstarter

Kumquat kickstarter is a drupal module that helps you start your Drupal projects faster by migrating entity bundles and fields from a spreadsheet.

Installation

Basic usage

  1. Copy this Google Sheet into your own Drive and fill it with data
    1. Each bundle you want to create must have an entry in the Bundles worksheet
    2. Each bundle for which you want fields must have its own woksheet named Field: [BUNDLE LABEL] based on the Fields: Actualités worksheet
  2. Export it as ODS format, name it site_builder.ods and place it in your ../config/ directory
  3. Migrate the bundles: drush migrate:import --tag kumquat_kickstarter_entity_bundles
  4. Clear Drupal cache to get the new bundles detected: drush cache:rebuild
  5. Migrate the fields: drush migrate:import --tag kumquat_kickstarter_fields
  6. Migrate the default form modes: drush migrate:import --tag kumquat_kickstarter_default_form_mode
  7. Export the created configuration

Advanced usage

Running all fields migrations of a specific bundle

Fields migrations are generated using a custom migration tag that allows to run all fields migration of a specific bundle at once. This tags is the form of kumquat_kickstarter_fields:ENTITY_TYPE__BUNBLE.

For example, to run the fields migrations of the news_categories vocabulary, you can run drush migrate:import --tag kumquat_kickstarter_fields:taxonomy_term__news_categories.

Prepopulating migrate maps after site reinstall

It can help a lot to prepopulate the migrate maps when you reinstall your site from scratch to prevent future migrations to override your existing entities.

To do so, you can use the drush kumquat_kickstarter:prepropulate --tag kumquat_kickstarter command.

Translating the spreasheet in your language

You may have noticed but the first line of each worksheet is hidden. It contains the name used by the script to migrate the data. The headers line that you can see is dedicated to end users and can be translated.

The names of the entity and field types cannot be translated, though. They are used by the migration to get important settings from the code.

Translating the configuration that you migrate

Configuration is imported using the site's default language. To be able to also import the translated version of the configuration for your other enabled languages you'll need to add some columns in the document.

The additional columns have to be named like the reference column (see below) appended by an uppercased langcode.

Reference columns for bundles:

Reference columns for fields (include label override):

For example, if your default language is French and if you want the configuration to be translated in English and Spanish, you'll need to add "Name EN", "Name SP", "Description EN" and "Description SP" columns to your Bundles worksheet. You'll also need to add "Field label EN", "Field label SP", "Help text EN" and "Help text SP" columns to your fields worksheets.

Using contributed and custom entities

To add an entity type:

  1. Enable the module that carries the entity type
  2. Find the PHP Class that define the bundle entity ('bundle of' in the Annotation)
  3. Copy the exact label value of your bundle entity
  4. Paste it in the A column of the Settings worksheet
  5. You can start using this new type in the Bundles worksheet and run migrations to get those bundles migrated

Troubleshooting

Errors when defining fields settings

Invalid YAML

Most of the time, invalid YAML will not throw any useful error. Be careful to respect indentation and wrap keys or values including spaces into some quotes.

Field types that convert settings

The settings columns need to be filled with YAML. Most of the time, you can take the YAML from the settings a field created in the UI, but sometimes, for example for list fields, it won't work. The thing is that some field types implements a storageSettingsFromConfigData() or a fieldSettingsFromConfigData() static method that converts the settings.

For example, for a List (text) field, you would find the following in the field storage configuration object:

But because of the ListItemBase::storageSettingsFromConfigData() method, you will need to put the following in the migration source file:

Credits

The font used for the logo is Smooth Butter from PutraCetol Studio.

All versions of kumquat_kickstarter with dependencies

PHP Build Version
Package Version
Requires drupal/migrate_plus Version ^5 || ^6
drupal/migrate_spreadsheet Version ^2
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 happyculture/kumquat_kickstarter contains the following files

Loading the files please wait ....