pmg/pheanstalk-bundle

A simple bundle that integrate Pheanstalk with Symfony

PmgPheanstalkBundle

An extremely simple Symfony bundle that puts one or more Pheanstalk connections into your Symfony application., _(*1)

If you're looking for something more full featured, check out LeezyPheanstalkBundle., _(*2)

Installation

1. Download the Bundle

composer require pmg/pheanstalk-bundle

2. Enable the Bundle

<?php
// app/AppKernel

class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = [
            // ...
            new PMG\PheanstalkBundle\PmgPheanstalkBundle(),
        ];

        // ...

        return $bundles;
    }

    // ...
}

Configuration

By default the bundle will provide you with one Pheanstalk\Pheanstalk named pmg_pheanstalk in the container. This connects to localhost on the default 11300 port., _(*3)

Single Connection Example

# Default configuration for "PmgPheanstalkBundle"
pmg_pheanstalk:
    # The connection's host.
    host:                 localhost

    # The connection's port.
    port:                 11300

    # The connection's timeout.
    timeout:              null

    # Whether or not to keep the connection's socket around between requests. See http://php.net/manual/en/function.pfsockopen.php
    persist:              false

Multiple Connections

# Default configuration for "PmgPheanstalkBundle"
pmg_pheanstalk:
    # The default connection that will be made available at the `pmg_pheanstalk` service
    default_connection:   default
    connections:
        # use the default configuration
        default: ~

        # another connection, will be put at the `pmg_pheanstalk.another` service
        another:
            host: anotherServier.com
            port: 11301

Statistic Endpoints

This bundle includes a few basic endpoints that return JSON data that provides information about the queue tubes. Each endpoint also allows for a connection parameter to be supplied. If it is not, the default connection is used., _(*4)

Enabling the endpoints

Add the following line to your routing.xml file. (Or equivalent YML file), _(*5)

   <import resource="@PmgPheanstalkBundle/Resources/config/routing.yml">
        <default key="_format">json</default>
   </import>

Available endpoints

• [GET] /{tube} - Provides all information from beanstalkd about the given tube
• [GET] / - Provides all information about all tubes from beanstalkd