Macro

Less than 1 minute

Represents a macro for dynamic value lookup in database synchronization.

class Macro extends \Hazaar\DBI\Manager\Sync\Struct

Encapsulates table, field, and criteria for macro expansion and provides methods for matching and executing macros.

Properties

The name of the table to perform the macro lookup on.

public string $table

The field to retrieve from the table.

public string $field

public array $criteria

The unique index key for caching macro lookups.

public string $indexKey

private  $lookups

Returns the string representation of the macro.

public __toString(): string

Initializes the macro after construction, generating the index key.

public constructed(): void

Matches a macro pattern in a string and returns a Macro instance if found.

public (string $field): ?self

Parameter	Type	Description
`$field`	`string`	the string to match against the macro pattern

Executes the macro, performing a lookup in the database and caching the result.

public run(Adapter $dbi): mixed

Parameter	Type	Description
`$dbi`	`Adapter`	the database adapter instance

private prepareCriteria(string $value): void

Parameter	Type	Description
`$value`	`string`

private prepareCriteriaItem(string $criteria): void

Parameter	Type	Description
`$criteria`	`string`

Generated by Hazaar API Doc Generator on Tue, 21 Apr 2026 04:00:24 +0000