The APIary

Introduction

As documented in Extending Bee it is possible to extend Bee with both custom commands and hooks within modules. The purpose of this page is to allow users to share custom bee commands that you think others would benefit from and to document any modules that have, or should have, bee commands. Please copy and use the templates to add to this page.

Custom Commands

Template - Give it a name

Your name (optional) and github handle
The purpose of this command is to ...

Code

<?php
  function custom_bee_command() {
    // your code
  }

  function custom_bee_callback() {
    // your code
  }

Modules

Memcache

Functions

• Retrieve statistics from memcache.
• Flush all objects from a bin.

Details

Memcache

Read Only Mode

Read Only Mode allows site administrators and developers to lock down or freeze a production server so that maintenance or large deployments can occur without taking the site offline.

Functions

• Enable: bee readonlymode TRUE
• Disable: bee readonlymode FALSE
• Check the status: bee readonlymode

It supports the aliases rom and ro and setting the value is case-insensitive as well as supporting 0 and 1.

See the section in the README file for more details

Details

• Read Only Mode

Rules

Functions

• What the bee commands do or should do TBC

Details

• Rules

Backup Migrate

Functions

• bam-backup: Backup a specified source associated with a Backdrop CMS website.
• bam-destinations: Get a list of available destinations.
• bam-profiles: Get a list of available settings profiles.
• bam-restore: Restore a saved backup to a specified source.
• bam-saved: Get a list of previously created backup files.
• bam-sources: Get a list of available sources.

Details

• Backup Migrate

S3 File System

Functions

• What the bee commands do or should do TBC

Details

• s3fs

Tweet Feed

Functions

• What the bee commands do or should do TBC

Details

• Tweet Feed

Node Access Rebuild Progressive

Functions

• bee node-access-rebuild-progressive

or for short,

• bee narp

Details

• Node Access Rebuild Progressive

Template

Functions

• What the bee commands do or should do

Details

• Link to request in module queue or link to module
• Do drush commands already exist?
  • If yes, link to file with drush commands in.
• Is anyone working on it?
• Your name (optional) and github handle