     1: <?php
     2:
     3: /**
     4:  *
     5:  * A factory for creating search provider implementations that implement the
     6:  * SearchProviderInterface interface.
     7:  *
     8:  * @package alpha::util::search
     9:  * @since 1.2.3
    10:  * @author John Collins <dev@alphaframework.org>
    11:  * @version $Id: SearchProviderFactory.inc 1701 2013-12-18 22:33:25Z alphadevx $
    12:  * @license http://www.opensource.org/licenses/bsd-license.php The BSD License
    13:  * @copyright Copyright (c) 2013, John Collins (founder of Alpha Framework).
    14:  * All rights reserved.
    15:  *
    16:  * <pre>
    17:  * Redistribution and use in source and binary forms, with or
    18:  * without modification, are permitted provided that the
    19:  * following conditions are met:
    20:  *
    21:  * * Redistributions of source code must retain the above
    22:  *   copyright notice, this list of conditions and the
    23:  *   following disclaimer.
    24:  * * Redistributions in binary form must reproduce the above
    25:  *   copyright notice, this list of conditions and the
    26:  *   following disclaimer in the documentation and/or other
    27:  *   materials provided with the distribution.
    28:  * * Neither the name of the Alpha Framework nor the names
    29:  *   of its contributors may be used to endorse or promote
    30:  *   products derived from this software without specific
    31:  *   prior written permission.
    32:  *
    33:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
    34:  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
    35:  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
    36:  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    37:  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
    38:  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    39:  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
    40:  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
    41:  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    42:  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    43:  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
    44:  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
    45:  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    46:  * </pre>
    47:  *
    48:  */
    49: class SearchProviderFactory {
    50:     /**
    51:      * Trace logger
    52:      *
    53:      * @var Logger
    54:      * @since 1.2.3
    55:      */
    56:     private static $logger = null;
    57:
    58:     /**
    59:      * A static method that attempts to return a SearchProviderInterface instance
    60:      * based on the name of the provider class supplied.
    61:      *
    62:      * @param $providerName The class name of the provider class, should be in the alpha::util::search package.
    63:      * @throws IllegalArguementException
    64:      * @return SearchProviderInterface
    65:      * @since 1.2.3
    66:      */
    67:     public static function getInstance($providerName) {
    68:         if(self::$logger == null)
    69:             self::$logger = new Logger('SearchProviderFactory');
    70:
    71:         self::$logger->debug('>>getInstance(providerName=['.$providerName.'])');
    72:
    73:         global $config;
    74:
    75:         if(file_exists($config->get('app.root').'alpha/util/search/'.$providerName.'.inc')) {
    76:             require_once $config->get('app.root').'alpha/util/search/'.$providerName.'.inc';
    77:
    78:             $instance = new $providerName;
    79:
    80:             if(!$instance instanceof SearchProviderInterface)
    81:                 throw new IllegalArguementException('The class ['.$providerName.'] does not implement the expected SearchProviderInterface interface!');
    82:
    83:             self::$logger->debug('<<getInstance: [Object '.$providerName.']');
    84:             return $instance;
    85:         }else{
    86:             throw new IllegalArguementException('The class ['.$providerName.'] is not defined anywhere!');
    87:         }
    88:
    89:         self::$logger->debug('<<getInstance');
    90:     }
    91: }
    92:
    93: ?>