Fwk\Core\Action\ProxyFactory

Complexity

Total Complexity

9

Size/Duplication

Total Lines	60
Duplicated Lines	0 %

Coupling/Cohesion

Dependencies

6

Test Coverage

Coverage

100%

Importance

Changes	4
Bugs	1	Features	3

1 Method

Rating	Name	Duplication	Size	Complexity
D	factory()	0	31	9

<?php
/**
 * Fwk
 *
 * Copyright (c) 2011-2012, Julien Ballestracci <julien@nitronet.org>.
 * All rights reserved.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 OWNER 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.
 *
 * PHP Version 5.3
 *
 * @category  Core
 * @package   Fwk\Core
 * @author    Julien Ballestracci <julien@nitronet.org>
 * @copyright 2011-2014 Julien Ballestracci <julien@nitronet.org>
 * @license   http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @link      http://www.fwk.pw
 */
namespace Fwk\Core\Action;

use Fwk\Core\ActionProxy;
use Fwk\Core\Exception;

/**
 * Strategy Factory utility to help loading the correct ActionProxy depending
 * on the argument passed to the factory() method.
 *
 * @category ActionProxy
 * @package  Fwk\Core
 * @author   Julien Ballestracci <julien@nitronet.org>
 * @license  http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @link     http://www.fwk.pw
 */
class ProxyFactory

ProxyFactory does not seem to conform to the naming convention (Utils?$).

{
    /**
     * Factory Strategy to load the correct ActionProxy. A sort of "shortcut
     * utility".
     * 
     * If $callableOrShortcut is:<br />
     * <ol>
     * <li>a <i>\Closure</i> or a <i>Callable</i> will return a 
     * <i>CallableActionProxy</i>
     * <br />(ex: array($object, 'method')</li>
     * <li>a <i>string starting with '@' followed by a name WITHOUT ':' in it</i>
     * will return a <i>ServiceActionProxy</i><br />(ex: @MyServiceReference)</li>
     * <li><i>string starting with '@' followed by a name WITH ':' in it</i>
     * will return a <i>ServiceControllerActionProxy</i> 
     * <br />(ex: @MyControllerReference:methodName)</li>
     * <li><i>string WITH ':' in it</i> will return a 
     * <i>ControllerActionProxy</i><br />(ex: MyApp\\Controllers\\Home:show)</li>
     * <li>a <i>string starting with '+' followed by a path to a php file</i>
     * will return an <i>IncludeActionProxy</i><br />
     * (ex: +/path/to/myscript.php)</li>
     * </ol>
     * 
     * @param mixed $callableOrShortcut See documentation above
     * 
     * @return ActionProxy The according ActionProxy instance

Consider making the return type a bit more specific; maybe use CallableActionProxy|ServiceActionProxy|ServiceControllerActionProxy|ControllerActionProxy|IncludeActionProxy.

     * @throws Exception   When the shortcut is incorrect
     */
    public static function factory($callableOrShortcut)
    {
        if ($callableOrShortcut instanceof \Closure 
            || is_callable($callableOrShortcut)
        ) {
            return new CallableActionProxy($callableOrShortcut);
        } elseif (is_string($callableOrShortcut)) {
            if (strpos($callableOrShortcut, '@', 0) !== false) {
                if (strpos($callableOrShortcut, ':') === false) {
                    return new ServiceActionProxy(substr($callableOrShortcut, 1));
                } elseif (strpos($callableOrShortcut, ':') !== false) {
                    list($service, $method) = explode(':', $callableOrShortcut);
                    return new ServiceControllerActionProxy(
                        substr($service, 1), 
                        $method
                    );
                }
            } elseif (strpos($callableOrShortcut, ':') !== false) {
                list($className, $method) = explode(':', $callableOrShortcut);
                return new ControllerActionProxy($className, $method);
            } elseif (strpos($callableOrShortcut, '+', 0) !== false) {
                return new IncludeActionProxy(substr($callableOrShortcut, 1));
            }
            
            throw new Exception(
                sprintf('Invalid ActionProxy shortcut: '. $callableOrShortcut)
            );
        }
        
        throw new Exception(sprintf('Incorrect ActionProxy shortcut'));
    }
}