modX.logManagerAction

modX::logManagerAction¶

Creates and saves a modManagerLog record for one action. Processors call it right after they change an object, and the rows appear under Reports → Manager Actions.

Empty arguments are stored as:

The method returns the saved object, or null when the save fails after an error was logged.

Syntax¶

modManagerLog|null logManagerAction (string $action, string $class_key, mixed $item, [int|null $userId = null])

• $action (string) action key stored in the row
• $class_key (string) class key of the affected object
• $item (mixed) identifier stored as item
• $userId (int|null) acting user; by default null uses the id of modX::$user

Example¶

$log = $modx->logManagerAction('update_resource', modResource::class, 5);

if ($log === null) {
    // the row was not saved
}

See Also¶

• modX
• modResource