OperationElementBuilder Class Reference

Public Member Functions
	build ()
	withElementType ($elementType)
	withFields ($fields)
	withKey ($key)
	withType ($type)
	addElements ($elementsToAdd)
	addFields ($fieldsToAdd)
	withNestedElements ($nestedElements)

Static Public Member Functions
static	buildOperationElementFields ($fields)

Detailed Description

Definition at line 11 of file OperationElementBuilder.php.

Member Function Documentation

addElements()

addElements

(

$elementsToAdd

)

Adds a set of new Operation Elements to the nested metadata.

Parameters

array

$elementsToAdd

Returns

OperationElementBuilder

Definition at line 140 of file OperationElementBuilder.php.

    {
        foreach ($elementsToAdd as $fieldKey => $metadata) {
            $this->nestedMetadata[$fieldKey] = $metadata;
        }

        return $this;
    }

addFields()

addFields

(

$fieldsToAdd

)

Adds a new set of fields (value => type) into an object parameter to be converted to Operation Elements.

Parameters

array

$fieldsToAdd

Returns

OperationElementBuilder

Definition at line 155 of file OperationElementBuilder.php.

    {
        foreach ($fieldsToAdd as $fieldKey => $type) {
            $this->fields[$fieldKey] = $type;
        }

        return $this;
    }

build()

build

(

)

Build function which takes params defined by the user and returns a new Operation Element.

Returns

OperationElement

Definition at line 74 of file OperationElementBuilder.php.

    {
        return new OperationElement(
            $this->key,
            $this->type,
            $this->elementType,
            null,
            $this->nestedElements,
            array_merge($this->nestedMetadata, self::buildOperationElementFields($this->fields))
        );
    }

buildOperationElementFields()

static buildOperationElementFields (   $fields )

static

Takes an array of fields (value => type) and returns an array of Operations Elements of type field.

Parameters

array

$fields

Returns

array

Definition at line 182 of file OperationElementBuilder.php.

    {
        $operationElements = [];
        foreach ($fields as $fieldName => $type) {
            $operationElements[] = new OperationElement(
                $fieldName,
                $type,
                null,
                OperationDefinitionObjectHandler::ENTITY_OPERATION_ENTRY
            );
        }

        return $operationElements;
    }

withElementType()

withElementType

(

$elementType

)

Sets a new element type, overwrites any existing.

Parameters

string

$elementType

Returns

OperationElementBuilder

Definition at line 92 of file OperationElementBuilder.php.

    {
        $this->elementType = $elementType;
        return $this;
    }

withFields()

withFields

(

$fields

)

Set a new set of fields or operation elements

Parameters

array

$fields

Returns

OperationElementBuilder

Definition at line 104 of file OperationElementBuilder.php.

    {
        $this->fields = $fields;
        return $this;
    }

withKey()

withKey

(

$key

)

Sets a key for the operation element. See ref to param key for explanation.

Parameters

string

$key

Returns

OperationElementBuilder

Definition at line 116 of file OperationElementBuilder.php.

    {
        $this->key = $key;
        return $this;
    }

withNestedElements()

withNestedElements

(

$nestedElements

)

Sets an array nested elements to an object property.

Parameters

array

$nestedElements

Returns

OperationElementBuilder

Definition at line 170 of file OperationElementBuilder.php.

    {
        $this->nestedElements = $nestedElements;
        return $this;
    }

withType()

withType

(

$type

)

Sets a type for the operation element. See ref to param type for explanation.

Parameters

string

$type

Returns

OperationElementBuilder

Definition at line 128 of file OperationElementBuilder.php.

    {
        $this->type = $type;
        return $this;
    }

---

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

• vendor/magento/magento2-functional-testing-framework/dev/tests/unit/Util/OperationElementBuilder.php