Extension and action examples

Use the action functions with records and Data objects supplied by your application. They pass each argument to the package operation and return its result.

These adapters show container registration. Use the owning package registry when a contract requires contributor discovery.

Contract adapters wrap an existing implementation. Call their registration function from your service provider with that implementation; tagged contracts keep their declared tag. Resolve the backend by its concrete class before registration so the replacement contract does not resolve itself. Static contract metadata uses one backend class per adapter.

Action anonymizeContact

<?php
declare(strict_types=1);

namespace App\CapellExamples\Contacts;

function runAnonymizeContact(\Capell\Contacts\Models\Contact $contact, ?\Illuminate\Contracts\Auth\Authenticatable $actor = null): \Capell\Contacts\Models\Contact
{
    return \Capell\Contacts\Actions\AnonymizeContactAction::run($contact, $actor);
}

Action anonymizeContactWithAudit

<?php
declare(strict_types=1);

namespace App\CapellExamples\Contacts;

function runAnonymizeContactWithAudit(\Capell\Contacts\Models\Contact $contact, ?string $requestedBy = null, ?\Illuminate\Contracts\Auth\Authenticatable $actor = null): \Capell\Contacts\Models\Contact
{
    return \Capell\Contacts\Actions\AnonymizeContactWithAuditAction::run($contact, $requestedBy, $actor);
}

Action auditContactPrivacyExport

<?php
declare(strict_types=1);

namespace App\CapellExamples\Contacts;

function runAuditContactPrivacyExport(\Capell\Contacts\Models\Contact $contact, ?string $requestedBy = null, ?\Illuminate\Contracts\Auth\Authenticatable $actor = null): array
{
    return \Capell\Contacts\Actions\AuditContactPrivacyExportAction::run($contact, $requestedBy, $actor);
}

Action buildContactPrivacyExport

<?php
declare(strict_types=1);

namespace App\CapellExamples\Contacts;

function runBuildContactPrivacyExport(\Capell\Contacts\Models\Contact $contact, ?\Illuminate\Contracts\Auth\Authenticatable $actor = null): array
{
    return \Capell\Contacts\Actions\BuildContactPrivacyExportAction::run($contact, $actor);
}

Action buildContactsOverviewStats

<?php
declare(strict_types=1);

namespace App\CapellExamples\Contacts;

function runBuildContactsOverviewStats(?int $siteId = null): array
{
    return \Capell\Contacts\Actions\BuildContactsOverviewStatsAction::run($siteId);
}

Action findOrCreateContact

<?php
declare(strict_types=1);

namespace App\CapellExamples\Contacts;

function runFindOrCreateContact(\Capell\Contacts\Data\ContactIdentityData $identity, ?\Illuminate\Database\Eloquent\Model $source = null): \Capell\Contacts\Models\Contact
{
    return \Capell\Contacts\Actions\FindOrCreateContactAction::run($identity, $source);
}

Action recordContactActivity

<?php
declare(strict_types=1);

namespace App\CapellExamples\Contacts;

function runRecordContactActivity(\Capell\Contacts\Models\Contact $contact, \Capell\Contacts\Data\ContactActivityData $activityData, ?\Illuminate\Database\Eloquent\Model $subject = null, ?\Capell\Contacts\Models\Lead $lead = null, ?\Capell\Contacts\Models\Organisation $organisation = null): \Capell\Contacts\Models\ContactActivity
{
    return \Capell\Contacts\Actions\RecordContactActivityAction::run($contact, $activityData, $subject, $lead, $organisation);
}

Action syncAccessGateRegistrationContact

<?php
declare(strict_types=1);

namespace App\CapellExamples\Contacts;

function runSyncAccessGateRegistrationContact(object $event): ?\Capell\Contacts\Data\ContactSourceSyncResultData
{
    return \Capell\Contacts\Actions\SyncAccessGateRegistrationContactAction::run($event);
}

Action syncCampaignConversionContact

<?php
declare(strict_types=1);

namespace App\CapellExamples\Contacts;

function runSyncCampaignConversionContact(object $event): ?\Capell\Contacts\Data\ContactSourceSyncResultData
{
    return \Capell\Contacts\Actions\SyncCampaignConversionContactAction::run($event);
}

Action syncCommentContact

<?php
declare(strict_types=1);

namespace App\CapellExamples\Contacts;

function runSyncCommentContact(object $event): ?\Capell\Contacts\Data\ContactSourceSyncResultData
{
    return \Capell\Contacts\Actions\SyncCommentContactAction::run($event);
}

Action syncContactSourceRecord

<?php
declare(strict_types=1);

namespace App\CapellExamples\Contacts;

function runSyncContactSourceRecord(\Capell\Contacts\Data\ContactSourceRecordData $record, ?\Illuminate\Database\Eloquent\Model $source = null, ?\Capell\Contacts\Models\Organisation $organisation = null): \Capell\Contacts\Data\ContactSourceSyncResultData
{
    return \Capell\Contacts\Actions\SyncContactSourceRecordAction::run($record, $source, $organisation);
}

Action syncEventRegistrationContact

<?php
declare(strict_types=1);

namespace App\CapellExamples\Contacts;

function runSyncEventRegistrationContact(object $event): ?\Capell\Contacts\Data\ContactSourceSyncResultData
{
    return \Capell\Contacts\Actions\SyncEventRegistrationContactAction::run($event);
}

Action syncFormSubmissionContact

<?php
declare(strict_types=1);

namespace App\CapellExamples\Contacts;

function runSyncFormSubmissionContact(object $event): ?\Capell\Contacts\Data\ContactSourceSyncResultData
{
    return \Capell\Contacts\Actions\SyncFormSubmissionContactAction::run($event);
}

Action syncShopifyCustomerContact

<?php
declare(strict_types=1);

namespace App\CapellExamples\Contacts;

function runSyncShopifyCustomerContact(object $event): ?\Capell\Contacts\Data\ContactSourceSyncResultData
{
    return \Capell\Contacts\Actions\SyncShopifyCustomerContactAction::run($event);
}

Action tagContact

<?php
declare(strict_types=1);

namespace App\CapellExamples\Contacts;

function runTagContact(\Capell\Contacts\Models\Contact $contact, array|string $tags): \Capell\Contacts\Models\Contact
{
    return \Capell\Contacts\Actions\TagContactAction::run($contact, $tags);
}