OperationDefinitionBuilder Class Reference

Public Member Functions
	build ()
	withName ($name)
	withOperation ($operation)
	withType ($type)
	withMetadata ($metadata)

Detailed Description

Definition at line 10 of file OperationDefinitionBuilder.php.

Member Function Documentation

build()

build

(

)

Function which builds an operation defintions based on the fields set by the user.

Returns

OperationDefinitionObject

Definition at line 51 of file OperationDefinitionBuilder.php.

    {
        return new OperationDefinitionObject(
            $this->name,
            $this->operation,
            $this->type,
            null,
            null,
            null,
            null,
            null,
            $this->metadata,
            null,
            false
        );
    }

withMetadata()

withMetadata

(

$metadata

)

Takes an array of values => type or an array of operation elements and transforms into operation metadata.

Parameters

array

$metadata

Returns

OperationDefinitionBuilder

Definition at line 110 of file OperationDefinitionBuilder.php.

    {
        $primitives = [];
        foreach ($metadata as $fieldName => $value) {
            // type check here TODO
            if (is_string($value)) {
                $primitives[$fieldName] = $value;
            } else {
                $this->metadata[] = $value;
            }
        }

        $this->metadata = array_merge(
            $this->metadata,
            OperationElementBuilder::buildOperationElementFields($primitives)
        );
        return $this;
    }

withName()

withName

(

$name

)

Sets the name of the operation definition to be built.

Parameters

string

$name

Returns

OperationDefinitionBuilder

Definition at line 74 of file OperationDefinitionBuilder.php.

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

withOperation()

withOperation

(

$operation

)

Sets the name of the operation for the object to be built.

Parameters

string

$operation

Returns

OperationDefinitionBuilder

Definition at line 86 of file OperationDefinitionBuilder.php.

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

withType()

withType

(

$type

)

Sets the name of the type of operation (e.g. create, delete)

Parameters

string

$type

Returns

OperationDefinitionBuilder

Definition at line 98 of file OperationDefinitionBuilder.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/OperationDefinitionBuilder.php