Documentation

DeleteTag

Use case for deleting tags.

Tags
since
3.0.0

Table of Contents

Properties

$association  : TagAssociationInterface
$repository  : TagRepositoryInterface

Methods

__construct()  : mixed
Constructor.
execute()  : bool
Delete a single tag by ID.
executeAll()  : int
Delete all tags matching a filter.
executeAllWithResult()  : array{success: bool, count: int}
Delete all tags matching filter and return result.
executeMultiple()  : int
Delete multiple tags by IDs.
executeMultipleWithResult()  : array{success: bool, count: int}
Delete multiple tags and return result.
executeWithResult()  : array{success: bool, count: int}
Delete a single tag and return result.

Properties

Methods

execute()

Delete a single tag by ID.

public execute(int $id) : bool
Parameters
$id : int

Tag ID

Return values
bool

True if deleted

executeAll()

Delete all tags matching a filter.

public executeAll([string $query = '' ]) : int
Parameters
$query : string = ''

Filter query (supports * wildcard)

Return values
int

Number of deleted tags

executeAllWithResult()

Delete all tags matching filter and return result.

public executeAllWithResult([string $query = '' ]) : array{success: bool, count: int}
Parameters
$query : string = ''

Filter query

Return values
array{success: bool, count: int}

Result

executeMultiple()

Delete multiple tags by IDs.

public executeMultiple(array<string|int, int> $ids) : int
Parameters
$ids : array<string|int, int>

Tag IDs

Return values
int

Number of deleted tags

executeMultipleWithResult()

Delete multiple tags and return result.

public executeMultipleWithResult(array<string|int, int> $ids) : array{success: bool, count: int}
Parameters
$ids : array<string|int, int>

Tag IDs

Return values
array{success: bool, count: int}

Result

executeWithResult()

Delete a single tag and return result.

public executeWithResult(int $id) : array{success: bool, count: int}
Parameters
$id : int

Tag ID

Return values
array{success: bool, count: int}

Result


        
On this page

Search results