SOAPModelAccess::authenticate() - Code Metrics - xini/silverstripe-soapserver - Measure and Improve Code Quality continuously with Scrutinizer

SOAPModelAccess::authenticate() A
last analyzed 2016-04-29 12:35 UTC

↳ Parent: SOAPModelAccess

Complexity

Conditions	3
Paths	4

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	9
rs	9.6666
cc	3
eloc	5
nc	4
nop	2

<?php
/**
 * Basic SOAP Server to access and modify DataObject instances.
 * You can enable SOAP access on a DataObject by setting {@link DataObject::$api_access} to true.
 * This means that you'll also enable a RESTful API through {@link RestfulServer}.
 *
 * @todo Test relation methods
 */
class SOAPModelAccess extends SapphireSoapServer
namespace YourVendor;

class YourClass { }
{
    private static $methods = array(

        'getXML' => array(
            'class' => 'string',
            'id' => 'int',
            'relation' => 'string',
            '_returns' => 'string',
        ),
        'getJSON' => array(
            'class' => 'string',
            'id' => 'int',
            'relation' => 'string',
            '_returns' => 'string',
        ),
        'putXML' => array(
            'class' => 'string',
            'id' => 'int',
            'relation' => 'string',
            'data' => 'string',
            'username' => 'string',
            'password' => 'string',
            '_returns' => 'boolean',
        ),
        'putJSON' => array(
            'class' => 'string',
            'id' => 'int',
            'relation' => 'string',
            '_returns' => 'boolean',
        ),
    );

    public function Link($action = null)
    {
        return Controller::join_links('soap/v1/', $action);
    }

    /**
     * Used to emulate RESTful GET requests with XML data.
     *
     * @param string $class
     * @param Number $id
     * @param string $relation Relation name
     *
     * @return string
     */
    public function getXML($class, $id, $relation = false, $username = null, $password = null)

    {
        $this->authenticate($username, $password);

        $response = Director::test(
            $this->buildRestfulURL($class, $id, $relation, 'xml'),

            null,
            null,
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            'GET'
        );

        return ($response->isError()) ? $this->getErrorMessage($response) : $response->getBody();
    }

    /**
     * Used to emulate RESTful GET requests with JSON data.
     *
     * @param string $class
     * @param Number $id
     * @param string $relation Relation name
     * @param string $username
     * @param string $password
     *
     * @return string
     */
    public function getJSON($class, $id, $relation = false, $username = null, $password = null)

    {
        $this->authenticate($username, $password);

        $response = Director::test(
            $this->buildRestfulURL($class, $id, $relation, 'json'),

            null,
            null,
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            'GET'
        );

        return ($response->isError()) ? $this->getErrorMessage($response) : $response->getBody();
    }

    /**
     * Used to emulate RESTful POST and PUT requests with XML data.
     *
     * @param string $class
     * @param Number $id
     * @param string $relation Relation name
     * @param array  $data
     * @param string $username
     * @param string $password
     *
     * @return string
     */
    public function putXML($class, $id = false, $relation = false, $data, $username = null, $password = null)

    {
        $this->authenticate($username, $password);

        $response = Director::test(
            $this->buildRestfulURL($class, $id, $relation, 'xml'),

            array(),
            null,
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ($id) ? 'PUT' : 'POST',
            $data
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        );

        return ($response->isError()) ? $this->getErrorMessage($response) : $response->getBody();
    }

    /**
     * Used to emulate RESTful POST and PUT requests with JSON data.
     *
     * @param string $class
     * @param Number $id
     * @param string $relation Relation name
     * @param array  $data
     * @param string $username
     * @param string $password
     *
     * @return string
     */
    public function putJSON($class = false, $id = false, $relation = false, $data, $username = null, $password = null)

    {
        $this->authenticate($username, $password);

        $response = Director::test(
            $this->buildRestfulURL($class, $id, $relation, 'json'),

            array(),
            null,
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ($id) ? 'PUT' : 'POST',
            $data
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        );

        return ($response->isError()) ? $this->getErrorMessage($response) : $response->getBody();
    }

    /**
     * Used to emulate RESTful DELETE requests.
     *
     * @param string $class
     * @param Number $id
     * @param string $relation Relation name
     * @param string $username
     * @param string $password
     *
     * @return string
     */
    public function deleteXML($class, $id, $relation = false, $username = null, $password = null)

    {
        $this->authenticate($username, $password);

        $response = Director::test(
            $this->buildRestfulURL($class, $id, $relation, 'xml'),

            null,
            null,
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            'DELETE'
        );

        return ($response->isError()) ? $this->getErrorMessage($response) : $response->getBody();
    }

    /**
     * Used to emulate RESTful DELETE requests.
     *
     * @param string $class
     * @param Number $id
     * @param string $relation Relation name
     * @param string $username
     * @param string $password
     *
     * @return string
     */
    public function deleteJSON($class, $id, $relation = false, $username = null, $password = null)

    {
        $this->authenticate($username, $password);

        $response = Director::test(
            $this->buildRestfulURL($class, $id, $relation, 'json'),

            null,
            null,
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            'DELETE'
        );

        return ($response->isError()) ? $this->getErrorMessage($response) : $response->getBody();
    }

    /**
     * Faking an HTTP Basicauth login in the PHP environment
     * that RestfulServer can pick up.
     *
     * @param string $username Username
     * @param string $password Plaintext password
     */
    protected function authenticate($username, $password)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        if (is_string($username)) {
            $_SERVER['PHP_AUTH_USER'] = $username;
        }
        if (is_string($password)) {
            $_SERVER['PHP_AUTH_PW'] = $password;
        }
    }

    /**
     * @param string $class
     * @param Number $id
     * @param string $relation
     * @param string $extension
     *
     * @return string
     */
    protected function buildRestfulURL($class, $id, $relation, $extension)
    {
        $url = "api/v1/{$class}";
        if ($id) {
            $url .= "/{$id}";
        }
        if ($relation) {
            $url .= "/{$relation}";
        }
        if ($extension) {
            $url .= "/.{$extension}";
        }

        return $url;
    }

    /**
     * @param SS_HTTPResponse $response
     *
     * @return string XML string containing the HTTP error message
     */
    protected function getErrorMessage($response)
    {
        return '<error type="authentication" code="'.$response->getStatusCode().'">'.$response->getStatusDescription().'</error>';
    }
}


1			<?php
2			/**
3			* Basic SOAP Server to access and modify DataObject instances.
4			* You can enable SOAP access on a DataObject by setting {@link DataObject::$api_access} to true.
5			* This means that you'll also enable a RESTful API through {@link RestfulServer}.
6			*
7			* @todo Test relation methods
8			*/
9			class SOAPModelAccess extends SapphireSoapServer
			0 ignored issues – show Coding Style Compatibility introduced 2016-04-25 04:09 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
10			{
11			private static $methods = array(
			0 ignored issues – show Comprehensibility introduced 2016-04-25 04:09 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2016-04-25 04:09 UTC by Report Bug Copy Issue Report The property `$methods` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
12			'getXML' => array(
13			'class' => 'string',
14			'id' => 'int',
15			'relation' => 'string',
16			'_returns' => 'string',
17			),
18			'getJSON' => array(
19			'class' => 'string',
20			'id' => 'int',
21			'relation' => 'string',
22			'_returns' => 'string',
23			),
24			'putXML' => array(
25			'class' => 'string',
26			'id' => 'int',
27			'relation' => 'string',
28			'data' => 'string',
29			'username' => 'string',
30			'password' => 'string',
31			'_returns' => 'boolean',
32			),
33			'putJSON' => array(
34			'class' => 'string',
35			'id' => 'int',
36			'relation' => 'string',
37			'_returns' => 'boolean',
38			),

xini / silverstripe-soapserver

SOAPModelAccess::authenticate() A last analyzed 2016-04-29 12:35 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

SOAPModelAccess::authenticate() A
last analyzed 2016-04-29 12:35 UTC