GearmanBundle/Service/GearmanClient.php

<?php

namespace Mmoreramerino\GearmanBundle\Service;

use Mmoreramerino\GearmanBundle\Service\GearmanService;
use Mmoreramerino\GearmanBundle\Service\GearmanInterface;
use Mmoreramerino\GearmanBundle\Exceptions\NoCallableGearmanMethodException;

/**
 * Implementation of GearmanInterface
 *
 * @author Marc Morera <marc@ulabox.com>
 */
class GearmanClient extends GearmanService
{

    /**
     * Server variable to define in what server must connect to
     *
     * @var array
     */
    public $server = null;

    /**
     * If workers are not loaded, they're loaded and returned.
     * Otherwise, they are simply returned
     *
     * @return Array Workers array getted from cache and saved
     */
    public function getWorkers()
    {
        /**
         * Always will be an Array
         */
        return $this->setWorkers();
    }

    /**
     * Runs a single task and returns some result, depending of method called.
     * Method called depends of default callable method setted on gearman settings
     *  or overwritted on work or job annotations
     *
     * @param string $name   A GearmanBundle registered function the worker is to execute
     * @param Mixed  $params Parameters to send to job
     *
     * @return mixed result depending of method called.
     */
     public function callJob($name, $params = array())
     {
        $worker = $this->getJob($name);
        $methodCallable = $worker['job']['defaultMethod'] . 'Job';

        if (!method_exists($this, $methodCallable)) {
            throw new NoCallableGearmanMethodException($methodCallable);
        }

        return $this->$methodCallable($name, $params);
     }


    /**
     * Runs a single task and returns a string representation of the result.
     * It is up to the GearmanClient and GearmanWorker to agree on the format of the result.
     * The GearmanClient::do() method is deprecated as of pecl/gearman 1.0.0. Use GearmanClient::doNormal().
     *
     * @param string $name   A GearmanBundle registered function the worker is to execute
     * @param Mixed  $params Parameters to send to job
     *
     * @return string A string representing the results of running a task.
     * @depracated
     */
    public function doJob($name, $params = array())
    {
        return $this->enqueue($name, $params, 'do');
    }

    /**
     * Runs a single task and returns a string representation of the result.
     * It is up to the GearmanClient and GearmanWorker to agree on the format of the result.
     *
     * @param string $name   A GearmanBundle registered function the worker is to execute
     * @param Mixed  $params Parameters to send to job
     *
     * @return string A string representing the results of running a task.
     */
    public function doNormalJob($name, $params = array())
    {
        return $this->enqueue($name, $params, 'doNormal');
    }


    /**
     * Runs a task in the background, returning a job handle which
     *     can be used to get the status of the running task.
     *
     * @param string $name   A GearmanBundle registered function the worker is to execute
     * @param Mixed  $params Parameters to send to job
     *
     * @return string Job handle for the submitted task.
     */
    public function doBackgroundJob($name, $params = array())
    {
        return $this->enqueue($name, $params, 'doBackground');
    }


    /**
     * Runs a single high priority task and returns a string representation of the result.
     * It is up to the GearmanClient and GearmanWorker to agree on the format of the result.
     * High priority tasks will get precedence over normal and low priority tasks in the job queue.
     *
     * @param string $name   A GearmanBundle registered function the worker is to execute
     * @param Mixed  $params Parameters to send to job
     *
     * @return string A string representing the results of running a task.
     */
    public function doHighJob($name, $params = array())
    {
        return $this->enqueue($name, $params, 'doHigh');
    }

    /**
     * Runs a high priority task in the background, returning a job handle which can be used to get the status of the running task.
     * High priority tasks take precedence over normal and low priority tasks in the job queue.
     *
     * @param string $name   A GearmanBundle registered function the worker is to execute
     * @param Mixed  $params Parameters to send to job
     *
     * @return string The job handle for the submitted task.
     */
    public function doHighBackgroundJob($name, $params = array())
    {
        return $this->enqueue($name, $params, 'doHighBackground');
    }

    /**
     * Runs a single low priority task and returns a string representation of the result.
     * It is up to the GearmanClient and GearmanWorker to agree on the format of the result.
     * Normal and high priority tasks will get precedence over low priority tasks in the job queue.
     *
     * @param string $name   A GearmanBundle registered function the worker is to execute
     * @param Mixed  $params Parameters to send to job
     *
     * @return string A string representing the results of running a task.
     */
    public function doLowJob($name, $params = array())
    {
        return $this->enqueue($name, $params, 'doLow');
    }

    /**
     * Runs a low priority task in the background, returning a job handle which can be used to get the status of the running task.
     * Normal and high priority tasks will get precedence over low priority tasks in the job queue.
     *
     * @param string $name   A GearmanBundle registered function the worker is to execute
     * @param Mixed  $params Parameters to send to job
     *
     * @return string The job handle for the submitted task.
     */
    public function doLowBackgroundJob($name, $params = array())
    {
        return $this->enqueue($name, $params, 'doLowBackground');
    }


    /**
     * Get real worker from job name and enqueues the action given one
     *     method.
     *
     * @param string $jobName A GearmanBundle registered function the worker is to execute
     * @param mixed  $params  Parameters to send to job
     * @param string $method  Method to execute
     *
     * @return mixed Return result of the call
     */
    private function enqueue($jobName, $params, $method)
    {
        $worker = $this->getJob($jobName);
        if (false !== $worker) {
            return $this->doEnqueue($worker, $params, $method);
        }

        return false;
    }

    /**
     * Execute a GearmanClient call given a worker, params and a method.
     * If any method is given, it performs a "do" call
     *
     * If he GarmanClient call is asyncronous, result value will be a handler.
     * Otherwise, will return job result.
     *
     * @param array  $worker Worker definition
     * @param mixed  $params Parameters to send to job
     * @param string $method Method to execute
     *
     * @return mixed  Return result of the GearmanClient call
     */
    private function doEnqueue(Array $worker, $params='', $method='do')
    {
        $gmclient= new \GearmanClient();

        if (null === $this->server || !is_array($this->server)) {
            $gmclient->addServer();
        } else {
            $gmclient->addServer($this->server[0], $this->server[1]);
        }

        return $gmclient->$method($worker['job']['realCallableName'], serialize($params));
    }

    /**
     * Set server of gearman
     *
     * @param type $servername Server name (must be ip)
     * @param type $port       Port of server. By default 4730
     *
     * @return Gearman Returns self object
     */
    public function setServer($servername, $port = 4730)
    {
        $this->server = array($servername, $port);
        return $this;
    }
}