robotomize/fujes

View on GitHub
src/robotomize/Fujes/SearchFactory.php

Summary

Maintainability
A
50 mins
Test Coverage
<?php
    /**
     * This file is part of the Fujes package.
     * @link    https://github.com/robotomize/fujes
     * @license http://www.opensource.org/licenses/mit-license.php MIT (see the LICENSE file)
     */

namespace robotomize\Fujes;

/**
 * Class SearchEngineFactory
 * This factory for faster access to the functions of the library.
 *
 * @package robotomize\Fujes
 * @author  robotomize@gmail.com
 * @version 0.4.1.0
 *
 * @usage
 * $resultArray = SearchEngineFactory::find('http://uWtfAPI.json', 'Avengers', 1, true)->fetchOne();
 * -> json string
 * $resultArray = SearchEngineFactory::find('http://uWtfAPI.json', 'Avengers', 1, false)->fetchOne();
 * -> PHP assoc array
 */
class SearchFactory
{
    /**
     * @param string $urlName
     * @param string $matchString
     * @param int $depth
     * @param bool $jsonEncode
     * @param bool $multipleResult
     * @param int $quality
     * @param string $versionType
     *
     * @return SearchEngine
     */
    public static function find(
        $urlName,
        $matchString,
        $depth = 1,
        $jsonEncode = true,
        $multipleResult = false,
        $quality = 1,
        $versionType = 'master'
    ) {
        $objectFactory = new SearchEngine(
            $urlName,
            $matchString,
            $depth,
            $jsonEncode,
            $multipleResult,
            $quality,
            $versionType
        );
        $objectFactory->run();
        return $objectFactory;
    }
}