Data Objects Reference

class IndexCandidate {
    public mixed $item;

    public function __construct(mixed $item);
}

// In get_candidates()
public function get_candidates(int $page, int $batch_size): array {
    $posts = get_posts([...]);

    // Wrap each item
    return array_map(
        fn($post) => new IndexCandidate($post),
        $posts
    );
}

// In is_supported() and should_index()
public function is_supported(IndexCandidate $item): bool {
    // Access the wrapped item
    return is_a($item->item, \WP_Post::class);
}

// In get_candidate_objects()
public function get_candidate_objects(IndexCandidate $item): array {
    // Unwrap to work with the item
    $post = $item->item;

    return [new IndexablePost((string) $post->ID, [...])];
}

interface IIndexableObject {
    /**
     * Get the unique identifier of the object
     * @return mixed
     */
    public function get_id();

    /**
     * Get the data to be indexed
     * @return array
     */
    public function get_indexable_data();
}

abstract class IndexableObject implements IIndexableObject {
    protected string $id;
    protected array $data;

    public function __construct(string $id, array $data) {
        $this->id   = $id;
        $this->data = $data;
    }

    public function get_id(): string {
        return $this->id;
    }

    public function get_indexable_data(): array {
        return $this->data;
    }
}

use CelerSearch\DataTransfer\IndexablePost;

$post = new IndexablePost('123', [
    'object_id' => '123',
    'post_id'   => 123,
    'title'     => 'My Post',
    'content'   => 'Post content...',
    // ...
]);

use CelerSearch\DataTransfer\IndexableProduct;

$product = new IndexableProduct('456', [
    'object_id'  => '456',
    'post_id'    => 456,
    'post_title' => 'Product Name',
    'price'      => 29.99,
    // ...
]);

use CelerSearch\DataTransfer\IndexableOrder;

$order = new IndexableOrder('order-789', [
    'object_id'   => 'order-789',
    'order_id'    => 789,
    'order_total' => 99.99,
    // ...
]);

namespace MyPlugin\DataTransfer;

use CelerSearch\Abstracts\IndexableObject;

class IndexableEvent extends IndexableObject {
    // Inherits everything from IndexableObject
    // Add custom methods if needed

    public function get_start_date(): int {
        return $this->data['start_date'] ?? 0;
    }
}

class IndexConfig {
    public function __construct(object $value);

    public function getId(): string;          // note: string, not int
    public function getName(): string;
    public function getType(): string;
    public function getSlug(): string;
    public function getConfig(): ?object;     // type-specific config (JSON-decoded)
    public function getStatus(): ?string;
    public function getServiceId(): ?int;
    public function getTotalRemote(): ?int;
    public function getTotalLocal(): ?int;
    public function getCheckedAt(): ?string;
    public function getSyncedAt(): ?string;
    public function getCreatedAt(): ?string;

    public function get($key): mixed;         // arbitrary key access
    public function toArray(): array;
}

use CelerSearch\DataTransfer\IndexConfig;

$config = new IndexConfig((object) [
    'name'       => 'My Posts Index',
    'type'       => 'posts',
    'slug'       => 'my-posts-index',
    'service_id' => 1,
    'config'     => [
        'post_types' => ['post', 'page'],
    ],
]);

class ServiceConfig {
    public function __construct(object $value);

    public function getId(): int;
    public function getName(): string;
    public function getProvider(): string;    // e.g. 'meilisearch'
    public function getConfig(): ?object;     // provider fields (url, api_key, ...)
    public function getStatus(): ?string;
    public function getCheckedAt(): ?string;
    public function getCreatedAt(): ?string;
    public function getFailureCount(): int;

    public function get($key): mixed;
    public function toArray(): array;
}

use CelerSearch\DataTransfer\ServiceConfig;

$config = new ServiceConfig((object) [
    'name'     => 'Production Search',
    'provider' => 'meilisearch',
    'config'   => (object) [
        'url'     => 'https://search.example.com',
        'api_key' => 'your-api-key',
    ],
]);

$url = $config->getConfig()->url ?? '';
$key = $config->getConfig()->api_key ?? '';

$area = [
    'id'       => 'area_abc123',
    'type'     => 'wordpress_public_search',
    'label'    => 'Main Site Search',
    'index_id' => 1,
    'enabled'  => true,
    'features' => [
        'autocomplete' => ['enabled' => true],
    ],
];

WordPress Post (WP_Post)
        ↓
    IndexCandidate wrapper
        ↓
    is_supported() check
        ↓
    should_index() check
        ↓
    get_candidate_objects()
        ↓
    IndexablePost (IIndexableObject)
        ↓
    get_indexable_data()
        ↓
    JSON to Search Engine

// 1. WordPress Post
$post = get_post(123);

// 2. Wrap in IndexCandidate
$candidate = new IndexCandidate($post);

// 3. Check support
if (!$index->is_supported($candidate)) {
    return;
}

// 4. Check if should index
if (!$index->should_index($candidate)) {
    return;
}

// 5. Convert to indexable objects
$objects = $index->get_candidate_objects($candidate);

// 6. Each object implements IIndexableObject
foreach ($objects as $obj) {
    $id = $obj->get_id();               // '123-0'
    $data = $obj->get_indexable_data(); // [...all fields...]

    // 7. Send to the search engine (delegates to the index's service)
    $index->sync_item($obj);
}