Api Class Reference

Static Public Member Functions
static	callWithException (\PHPUnit\Framework\TestCase $testCase, $path, $params=[], $expectedMessage='')
static	restoreErrorHandler ()
static	soapAdapterFaultCallback ($exceptionCode, $exceptionMessage)
static	simpleXmlToArray ($xml, $keyTrimmer=null)
static	checkEntityFields (\PHPUnit\Framework\TestCase $testCase, array $expectedData, array $actualData, array $fieldsToCompare=[])

Static Protected Attributes
static	$_previousHandler = null

Detailed Description

Definition at line 10 of file Api.php.

Member Function Documentation

callWithException()

static callWithException ( \PHPUnit\Framework\TestCase  $testCase,   $path,   $params = [],   $expectedMessage = ''  )

static

Call API method via API handler that raises SoapFault exception

Parameters

\PHPUnit\Framework\TestCase	$testCase	Active test case
string	$path
array	$params	Order of items matters as they are passed to call_user_func_array
string	$expectedMessage	exception message

Returns

\SoapFault

Definition at line 74 of file Api.php.

      {
        try {
            self::call($testCase, $path, $params);
            self::restoreErrorHandler();
            $testCase->fail('Expected error exception was not raised.');
        } catch (\SoapFault $exception) {
            self::restoreErrorHandler();
            if ($expectedMessage) {
                $testCase->assertEquals($expectedMessage, $exception->getMessage());
            }
            return $exception;
        }
    }

checkEntityFields()

static checkEntityFields ( \PHPUnit\Framework\TestCase  $testCase, array  $expectedData, array  $actualData, array  $fieldsToCompare = []  )

static

Check specific fields value in some entity data.

Parameters

\PHPUnit\Framework\TestCase	$testCase
array	$expectedData
array	$actualData
array	$fieldsToCompare	To be able to compare fields from loaded model with fields from API response this parameter provides fields mapping. Array can store model field name $entityField mapped on field name in API response. $fieldsToCompare format is: $fieldsToCompare = array($modelFieldName => $apiResponseFieldName); Example: $fieldsToCompare = array( 'entity_id' => 'product_id', 'sku', 'attribute_set_id' => 'set', 'type_id' => 'type', 'category_ids', );

Definition at line 190 of file Api.php.

      {
        $fieldsToCompare = !empty($fieldsToCompare) ? $fieldsToCompare : array_keys($expectedData);
        foreach ($fieldsToCompare as $entityField => $field) {
            $testCase->assertEquals(
                $expectedData[is_numeric($entityField) ? $field : $entityField],
                $actualData[$field],
                sprintf('"%s" filed has invalid value.', $field)
            );
        }
    }

restoreErrorHandler()

static restoreErrorHandler ( )

static

Restore previously used error handler

Definition at line 96 of file Api.php.

    {
        set_error_handler(self::$_previousHandler);
    }

simpleXmlToArray()

static simpleXmlToArray (   $xml,   $keyTrimmer = null  )

static

Convert Simple XML to array

Parameters

\SimpleXMLObject	$xml
String	$keyTrimmer

Returns

object

In XML notation we can't have nodes with digital names in other words fallowing XML will be not valid: <24> Default category </24>

But this one will not cause any problems: <qwe_24> Default category </qwe_24>

So when we want to obtain an array with key 24 we will pass the correct XML from above and $keyTrimmer = 'qwe_'; As a result we will obtain an array with digital key node.

In the other case just don't pass the $keyTrimmer.

Definition at line 135 of file Api.php.

    {
        $result = [];

        $isTrimmed = false;
        if (null !== $keyTrimmer) {
            $isTrimmed = true;
        }

        if (is_object($xml)) {
            foreach (get_object_vars($xml->children()) as $key => $node) {
                $arrKey = $key;
                if ($isTrimmed) {
                    $arrKey = str_replace($keyTrimmer, '', $key);
                }
                if (is_numeric($arrKey)) {
                    $arrKey = 'Obj' . $arrKey;
                }
                if (is_object($node)) {
                    $result[$arrKey] = self::simpleXmlToArray($node, $keyTrimmer);
                } elseif (is_array($node)) {
                    $result[$arrKey] = [];
                    foreach ($node as $nodeValue) {
                        $result[$arrKey][] = self::simpleXmlToArray($nodeValue, $keyTrimmer);
                    }
                } else {
                    $result[$arrKey] = (string)$node;
                }
            }
        } else {
            $result = (string)$xml;
        }
        return $result;
    }

soapAdapterFaultCallback()

static soapAdapterFaultCallback (   $exceptionCode,   $exceptionMessage  )

static

Throw SoapFault exception. Callback for 'fault' method of API.

Parameters

string	$exceptionCode
string	$exceptionMessage

Exceptions

Definition at line 108 of file Api.php.

    {
        throw new \SoapFault($exceptionCode, $exceptionMessage);
    }

Field Documentation

$_previousHandler

$_previousHandler = null

staticprotected

Definition at line 17 of file Api.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/magento2-base/dev/tests/integration/framework/Magento/TestFramework/Helper/Api.php