ToolCrudObjects Class Reference

Tool class for CRUD operations on Dolibarr objects TODO Remove all tools in this file. More...

Inheritance diagram for ToolCrudObjects:

Collaboration diagram for ToolCrudObjects:

Public Member Functions
	__construct (DoliDB $db)
	Constructor.
	getDefinitions ()
	Returns an array of tool definitions, including name, description, and input schema.
	getCategories ()
	Return categories this tool belongs to.
	execute (string $name, array $args)
	Executes the requested tool function based on its name.
Public Member Functions inherited from McpTool
	__construct ($db, $user, $conf)
	Constructor.
	isSystem ()
	Return true if this is a system/infrastructure tool that must always remain visible and executable regardless of the admin allow-list.

Private Member Functions
	addLineItem (array $args)
	Entry point for the 'add_line_item' tool.
	findProduct ($identifier)
	Find a product by various identifiers (ID, Ref, Barcode, Label).
	deleteObject (array $args)
	Delete a document object.
	checkPermission (string $type)
	Check if the current user has permission for the given object type.
	instantiate (string $type)
	Factory Helper to instantiate Dolibarr objects.

Detailed Description

Tool class for CRUD operations on Dolibarr objects TODO Remove all tools in this file.

Must be into the objectname.class.php to follow the same structure than APIs.

Definition at line 35 of file crud_objects.class.php.

Constructor & Destructor Documentation

__construct()

ToolCrudObjects::__construct

(

DoliDB

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Definition at line 42 of file crud_objects.class.php.

References $db.

Member Function Documentation

addLineItem()

ToolCrudObjects::addLineItem ( array $args )

private

Entry point for the 'add_line_item' tool.

Adds line to an already existing object. Instantiates the document and calls the line processing helper.

Parameters

array{object_type:string,parent_id:int,product_id?:int,description?:string,quantity?:float|int,unit_price?:float|int,vat_rate?:float|int}

$args Tool arguments for adding a line item

Returns

array{success:bool,line_id?:int,error?:string}

Definition at line 689 of file crud_objects.class.php.

References string.

Referenced by execute().

checkPermission()

ToolCrudObjects::checkPermission ( string $type )

private

Check if the current user has permission for the given object type.

Parameters

string

$type

Object type key.

Returns

array{error: string}|null Null if allowed, error array if denied.

Definition at line 875 of file crud_objects.class.php.

References user.

deleteObject()

ToolCrudObjects::deleteObject ( array $args )

private

Delete a document object.

Parameters

array{object_type

string, id: int|string} $args Arguments containing type and ID.

Returns

array{success: bool}|array{error: string} Result array.

Definition at line 830 of file crud_objects.class.php.

References $id, and string.

Referenced by execute().

execute()

ToolCrudObjects::execute	(	string	$name,
		array	$args )

Executes the requested tool function based on its name.

Parameters

string	$name	The name of the tool to execute.
	array<string,mixed>	$args The arguments for the tool (key-value pairs).

Returns

mixed The result of the tool execution (usually an array) or an error array.

Reimplemented from McpTool.

Definition at line 323 of file crud_objects.class.php.

References $conf, $mysoc, addLineItem(), deleteObject(), and user.

findProduct()

ToolCrudObjects::findProduct ( $identifier )

private

Find a product by various identifiers (ID, Ref, Barcode, Label).

Parameters

string | int

$identifier

The search term (ID, ref, barcode, etc.).

Returns

Product|array{error: string, matches?: list<string>} Returns the Product object on success, or an error array.

Definition at line 738 of file crud_objects.class.php.

References getEntity().

getCategories()

ToolCrudObjects::getCategories

(

)

Return categories this tool belongs to.

Used by the intent parser to filter available tools.

Returns

array<string> List of categories (e.g., ['billing', 'commercial'])

Reimplemented from McpTool.

Definition at line 311 of file crud_objects.class.php.

getDefinitions()

ToolCrudObjects::getDefinitions

(

)

Returns an array of tool definitions, including name, description, and input schema.

Returns

list<array<string, mixed>> Array of tool definitions.

Reimplemented from McpTool.

Definition at line 140 of file crud_objects.class.php.

instantiate()

ToolCrudObjects::instantiate ( string $type )

private

Factory Helper to instantiate Dolibarr objects.

Parameters

string

$type

Object type key (e.g., 'proposal', 'invoice').

Returns

CommonObject New instance of the specific Dolibarr class.

Exceptions

Exception

If the type is unknown or class not found.

Definition at line 895 of file crud_objects.class.php.

References string.

---

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

• dolibarr_dev/htdocs/ai/tools/crud_objects.class.php