1. class
  2. Civi
  3. \
  4. Api4
  5. \
  6. Service
  7. \
  8. Spec
  9. \
  10. RequestSpec

RequestSpec

class RequestSpec

Properties

protected string $entity
protected string $action
protected FieldSpec[] $fields

Methods

__construct(string $entity, string $action)

No description

addFieldSpec(FieldSpec $field)

No description

FieldSpec|null
getFieldByName($name)

No description

array
getFieldNames()

No description

array|FieldSpec[]
getRequiredFields()

No description

array|FieldSpec[]
getConditionalRequiredFields()

No description

FieldSpec[]
getFields(array $fieldNames = NULL)

No description

string
getEntity()

No description

string
getAction()

No description

Details

at line 61
__construct(string $entity, string $action)

Parameters

string $entity
string $action

at line 66
addFieldSpec(FieldSpec $field)

Parameters

FieldSpec $field

at line 75
FieldSpec|null getFieldByName($name)

Parameters

$name

Return Value

FieldSpec|null

at line 89
array getFieldNames()

Return Value

array Gets all the field names currently part of the specification

at line 98
array|FieldSpec[] getRequiredFields()

Return Value

array|FieldSpec[]

at line 107
array|FieldSpec[] getConditionalRequiredFields()

Return Value

array|FieldSpec[]

at line 118
FieldSpec[] getFields(array $fieldNames = NULL)

Parameters

array $fieldNames Optional array of fields to return

Return Value

FieldSpec[]

at line 134
string getEntity()

Return Value

string

at line 141
string getAction()

Return Value

string