source: sandbox/expresso-solr/expressoMail1_2/inc/solrclient/library/Solarium/Plugin/CustomizeRequest.php @ 7576

<?php
/**
 * Copyright 2011 Bas de Nooijer. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this listof conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * The views and conclusions contained in the software and documentation are
 * those of the authors and should not be interpreted as representing official
 * policies, either expressed or implied, of the copyright holder.
 *
 * @copyright Copyright 2011 Bas de Nooijer <solarium@raspberry.nl>
 * @license http://github.com/basdenooijer/solarium/raw/master/COPYING
 * @link http://www.solarium-project.org/
 *
 * @package Solarium
 */

/**
 * CustomizeRequest plugin
 *
 * You can use this plugin to customize the requests generated for Solarium queries by adding or overwriting
 * params and/or headers.
 *
 * @package Solarium
 * @subpackage Plugin
 */
class Solarium_Plugin_CustomizeRequest extends Solarium_Plugin_Abstract
{

    /**
     * Holds customizations added to this plugin
     *
     * @var array
     */
    protected $_customizations = array();

    /**
     * Initialize options
     *
     * @return void
     */
    protected function _init()
    {
        foreach ($this->_options AS $name => $value) {
            switch ($name) {
                case 'customization':
                    $this->addCustomizations($value);
                    break;
            }
        }
    }

    /**
     * Create a Customization instance
     *
     * If you supply a string as the first arguments ($options) it will be used as the key for the Customization
     * and it will be added to this plugin.
     * If you supply an options array/object that contains a key the Customization will also be added to the plugin.
     *
     * When no key is supplied the Customization cannot be added, in that case you will need to add it manually
     * after setting the key, by using the addCustomization method.
     *
     * @param mixed $options
     * @return Solarium_Plugin_CustomizeRequest_Customization
     */
    public function createCustomization($options = null)
    {
        if (is_string($options)) {
            $fq = new Solarium_Plugin_CustomizeRequest_Customization;
            $fq->setKey($options);
        } else {
            $fq = new Solarium_Plugin_CustomizeRequest_Customization($options);
        }

        if ($fq->getKey() !== null) {
            $this->addCustomization($fq);
        }

        return $fq;
    }

    /**
     * Add a customization
     *
     * Supports a Customization instance or a config array, in that case a new
     * Customization instance wil be created based on the options.
     *
     * @param Solarium_Plugin_CustomizeRequest_Customization|array $customization
     * @return Solarium_Plugin_CustomizeRequest Provides fluent interface
     */
    public function addCustomization($customization)
    {
        if (is_array($customization)) {
            $customization = new Solarium_Plugin_CustomizeRequest_Customization($customization);
        }

        $key = $customization->getKey();

        // check for non-empty key
        if (0 === strlen($key)) {
            throw new Solarium_Exception('A Customization must have a key value');
        }

        // check for a unique key
        if (array_key_exists($key, $this->_customizations)) {
            //double add calls for the same customization are ignored, others cause an exception
            if ($this->_customizations[$key] !== $customization) {
                throw new Solarium_Exception('A Customization must have a unique key value');
            }
        }

        $this->_customizations[$key] = $customization;

        return $this;
    }

    /**
     * Add multiple Customizations
     *
     * @param array $customizations
     * @return Solarium_Plugin_CustomizeRequest Provides fluent interface
     */
    public function addCustomizations(array $customizations)
    {
        foreach ($customizations AS $key => $customization) {

            // in case of a config array: add key to config
            if (is_array($customization) && !isset($customization['key'])) {
                $customization['key'] = $key;
            }

            $this->addCustomization($customization);
        }

        return $this;
    }

    /**
     * Get a Customization
     *
     * @param string $key
     * @return string
     */
    public function getCustomization($key)
    {
        if (isset($this->_customizations[$key])) {
            return $this->_customizations[$key];
        } else {
            return null;
        }
    }

    /**
     * Get all Customizations
     *
     * @return array
     */
    public function getCustomizations()
    {
        return $this->_customizations;
    }

    /**
     * Remove a single Customization
     *
     * You can remove a Customization by passing it's key, or by passing the Customization instance
     *
     * @param string|Solarium_Plugin_CustomizeRequest_Customization $customization
     * @return Solarium_Plugin_CustomizeRequest Provides fluent interface
     */
    public function removeCustomization($customization)
    {
        if (is_object($customization)) {
            $customization = $customization->getKey();
        }

        if (isset($this->_customizations[$customization])) {
            unset($this->_customizations[$customization]);
        }

        return $this;
    }

    /**
     * Remove all Customizations
     *
     * @return Solarium_Plugin_CustomizeRequest Provides fluent interface
     */
    public function clearCustomizations()
    {
        $this->_customizations = array();
        return $this;
    }

    /**
     * Set multiple Customizations
     *
     * This overwrites any existing Customizations
     *
     * @param array $customizations
     */
    public function setCustomizations($customizations)
    {
        $this->clearCustomizations();
        $this->addCustomizations($customizations);
    }

    /**
     * Event hook to customize the request object
     *
     * @param Solarium_Query $query
     * @param Solarium_Client_Request $request
     * @return void
     */
    public function postCreateRequest($query, $request)
    {
        foreach ($this->getCustomizations() as $key => $customization) {

            // first validate
            if (!$customization->isValid()) {
                throw new Solarium_Exception('Request customization with key "' . $key . '" is invalid');
            }

            // apply to request, depending on type
            switch ($customization->getType()) {
                case Solarium_Plugin_CustomizeRequest_Customization::TYPE_PARAM:
                    $request->addParam(
                        $customization->getName(),
                        $customization->getValue(),
                        $customization->getOverwrite()
                    );
                    break;
                case Solarium_Plugin_CustomizeRequest_Customization::TYPE_HEADER:
                    $request->addHeader($customization->getName() . ': ' . $customization->getValue());
                    break;
            }

            // remove single-use customizations after use
            if (!$customization->getPersistent()) {
                $this->removeCustomization($key);
            }
        }
    }

}