Objects Overview

Objects are the core of Splash synchronization. Each Object represents a data type in your application (ThirdParty, Product, Order, etc.) that can be synchronized with other systems.

What is an Object?

An Object is a PHP class that:

• Extends AbstractObject
• Defines available fields (what data can be synchronized)
• Implements CRUD operations (how to read/write data)
• Lives in the Splash\Local\Objects namespace

graph LR
    subgraph "Your Object"
        DEF[Definition]
        FLD[Fields]
        CRUD[CRUD]
    end

    subgraph "Splash"
        API[Splash API]
    end

    DEF -->|describes| API
    FLD -->|what to sync| API
    CRUD -->|how to sync| API

Minimal Object Structure

Important: Using IntelParserTrait is strongly recommended. It auto-discovers fields and getters/setters, reducing boilerplate code significantly.

<?php

namespace Splash\Local\Objects;

use Splash\Core\Models\AbstractObject;
use Splash\Core\Models\Objects\IntelParserTrait;

class ThirdParty extends AbstractObject
{
    use IntelParserTrait;

    //====================================================================//
    // Object Definition
    //====================================================================//

    /** [@var](https://github.com/var) string */
    protected static string $name = "Third Party";

    /** [@var](https://github.com/var) string */
    protected static string $description = "Customer or Supplier";

    /** [@var](https://github.com/var) string */
    protected static string $ico = "fa fa-user";

    //====================================================================//
    // Object Synchronization Limitations
    //====================================================================//

    /** [@var](https://github.com/var) bool Allow creation of new objects */
    protected static bool $allowPushCreated = true;

    /** [@var](https://github.com/var) bool Allow update of existing objects */
    protected static bool $allowPushUpdated = true;

    /** [@var](https://github.com/var) bool Allow deletion of objects */
    protected static bool $allowPushDeleted = true;

    //====================================================================//
    // Your business object
    //====================================================================//

    protected object $object;

    //====================================================================//
    // CRUD Methods (required)
    //====================================================================//

    public function load(string $objectId): ?object
    {
        // Load and return your business object
    }

    public function create(): ?object
    {
        // Create and return a new business object
    }

    public function update(bool $needed): ?string
    {
        // Save changes and return object ID
    }

    public function delete(?string $objectId = null): bool
    {
        // Delete the object
    }

    public function getObjectIdentifier(): ?string
    {
        // Return current object ID
    }

    public function objectsList(?string $filter = null, array $params = array()): array
    {
        // Return list of objects with pagination
    }
}

Object Definition Properties

Basic Properties

Synchronization Limitations

These flags prevent operations (hard limits):

Synchronization Defaults

These flags set default configuration (can be changed by user):

Key Traits

Splash provides traits to simplify Object development:

Object Lifecycle

Read Operation

When Splash needs to read an object, it first loads it, then requests specific fields.

sequenceDiagram
    participant S as Splash API
    participant O as Your Object

    S->>O: load(objectId)
    O-->>S: object or null
    S->>O: get(objectId, fields)
    O-->>S: field values

Create / Update Operation

For create, objectId is null and create() is called. For update, load() is called first. In both cases, set() applies the data and update() persists changes.

Performance tip: The IntelParserTrait tracks changes and passes needed=false to update() if no fields were modified. You can skip the database write in this case for better performance.

sequenceDiagram
    participant S as Splash API
    participant O as Your Object

    alt Create (objectId is null)
        S->>O: create()
        O-->>S: new object
    else Update (objectId exists)
        S->>O: load(objectId)
        O-->>S: object
    end
    S->>O: set(objectId, data)
    S->>O: update(needed)
    O-->>S: object ID

Delete Operation

Simple deletion by object ID. Return false only if deletion failed, otherwise true (even if object doesn't exist).

sequenceDiagram
    participant S as Splash API
    participant O as Your Object

    S->>O: delete(objectId)
    O-->>S: true (or false if failed)

Next Steps

• Defining Fields - Declare what data can be synchronized
• CRUD Operations - Implement read/write logic
• List Fields - Handle array/collection fields
• Advanced Patterns - IntelParserTrait, Extensions

Back to Documentation Index