CoolCMS API

FeedManager extends Manager
in package

Application

Abstract admin manager generic over the entity type and its service.

Properties

$service : TService: Manager service; subclasses narrow the type (`@property` in the Api/Admin/Front manager).
$appContext : AppContext
$cacheTagInvalidator : CacheTagInvalidator|null: Post-commit invalidator of the wire-payload query cache (tag bump per entity class).
$languageContext : LanguageContext|null
$paramsConfig : Config|null: Neon parameters (`%params%`: server paths and directories), set by the decorator (`decorators.neon`) like `setAppContext()`.
$presenterContext : PresenterContext
$settingContext : SettingContext
$feedXmlGenerator : FeedXmlGenerator

Methods

__construct() : mixed
delete() : Result
deleteAll() : Result
find() : SingleQuery<string|int, T>: Finds one entity by id (returns a `SingleQuery` object).
findAll() : Query<string|int, T>: Finds all entities (returns a `Query` object).
findBy() : SingleQuery<string|int, T>: Finds one entity by filters (returns a `SingleQuery` object).
generateNow() : array{path: string, itemCount: int}: Generates the feed now (the "generate now" button): delegates 1:1 to {@see FeedXmlGenerator::generateById()}. The cron lock (double-click protection) stays in the UI component ({@see \App\UI\Admin\Eshop\Components\FeedEditComponent\Traits\GenerateTrait}).
getAppContext() : AppContext
getCategoryRels() : array<int, array<string, mixed>>: Returns the mapping of a single category to a value per feed; used by {@see \App\UI\Admin\Eshop\Presenters\Traits\Forms\ProductCategoryFormTrait}.
getLanguageContext() : LanguageContext|null
getParameterRels() : array<int, array<string, mixed>>
getParameterRelsForSet() : array<int, array<string, mixed>>: Returns the overrides of a single product set across all feeds; used by the "Feeds" tab in {@see \App\UI\Admin\Eshop\Components\ProductSetEditComponent\Traits\FeedFieldsTrait}.
getParameterTree() : array<int, array<string, mixed>>
getPresenterContext() : PresenterContext
getSettingContext() : SettingContext
getSettings() : array<int, array<string, mixed>>
getTotalCount() : int|null: Returns the total count of the last `findAll()` of this manager's service, computed only when the query asked for it (`findAll(..., computeTotalCount: true)`); otherwise the last stored value.
initializeAllContexts() : void
save() : Result
saveCategoryRels() : array{success: bool, message: ?string, data: mixed, code: ?int}: Saves the category mapping. The delete is scoped strictly to `category_id`.
saveParameterRels() : array{success: bool, message: ?string, data: mixed, code: ?int}
saveParameterRelsForSet() : array{success: bool, message: ?string, data: mixed, code: ?int}: Saves the overrides of one product set. The delete is scoped strictly to `product_set_id = :setId`, so saving one set never deletes the overrides of other sets.
saveParameterTree() : array{success: bool, message: ?string, data: mixed, code: ?int}
setAppContext() : $this
setCacheTagInvalidator() : static
setLanguageContext() : $this
setParamsConfig() : static
setPresenterContext() : $this
setSettingContext() : $this
updateColumn() : Result
updateColumns() : Result
bumpCacheTags() : void: Bumps cache tags for the entity after commit: its class, the owned-cascade classes from metadata and the optional `additionalCacheTags()` of the manager.
bumpCacheTagsExplicit() : void: Bumps the given classes explicitly (raw-DBAL paths with a cross-entity effect).
bumpCacheTagsForClass() : void: Bumps cache tags by class name when there is no instance (bulk delete, `updateColumns()`, raw DBAL, tree operations).
classCacheTags() : array<string|int, string>: Returns extra tags for a bump that has no entity, typically tree operations ({@see \App\Core\Traits\Api\Models\Managers\TreeTrait::treeTransaction()}) that rewrite `lft`/`rgt` on many rows.
getService() : TService: Returns the service for the traits.

$service

Manager service; subclasses narrow the type (`@property` in the Api/Admin/Front manager).


        public
            TService
    $service

$appContext


        protected
            AppContext
    $appContext

$cacheTagInvalidator

Post-commit invalidator of the wire-payload query cache (tag bump per entity class).


        protected
            CacheTagInvalidator|null
    $cacheTagInvalidator
     = null

Set by the decorator (decorators.neon) like setParamsConfig(). Nullable and fail-open: without wiring (or without Redis) a bump is a no-op.

$languageContext


        protected
            LanguageContext|null
    $languageContext
     = NULL

$paramsConfig

Neon parameters (`%params%`: server paths and directories), set by the decorator (`decorators.neon`) like `setAppContext()`.


        protected
            Config|null
    $paramsConfig
     = null

Write logic (asset directories) reads paths from here, not from getSettings() or the setting context, which may be filled by the client without server paths. The property cannot be named $config: it collides with the promoted $config in some managers.

$presenterContext


        protected
            PresenterContext
    $presenterContext

$settingContext


        protected
            SettingContext
    $settingContext

$feedXmlGenerator read-only


        private
            FeedXmlGenerator
    $feedXmlGenerator

__construct()


    public
                    __construct(FeedService $service, FeedXmlGenerator $feedXmlGenerator) : mixed

Parameters

$service : FeedService
$feedXmlGenerator : FeedXmlGenerator

delete()


    public
                    delete(int|array<string|int, mixed> $id) : Result

Parameters

$id : int|array<string|int, mixed>

Return values

Result

deleteAll()


    public
                    deleteAll([array<string|int, mixed> $filters = [] ]) : Result

Parameters

$filters : array<string|int, mixed> = []

Return values

Result

find()

Finds one entity by id (returns a `SingleQuery` object).


    public
                    find(int $id[, string|array<string|int, mixed> $includes = [] ]) : SingleQuery<string|int, T>

Parameters

$id : int: entity id
$includes : string|array<string|int, mixed> = []: relations to load (['translations', 'routes'] or '*' for all)

Return values

SingleQuery<string|int, T>

findAll()

Finds all entities (returns a `Query` object).


    public
                    findAll([array<string|int, mixed>|null $filters = [] ][, array<string|int, mixed>|null $orderBy = null ][, int|null $offset = null ][, int|null $limit = null ][, array<string|int, mixed>|null $columns = null ][, string|array<string|int, mixed> $includes = [] ][, bool $computeTotalCount = false ]) : Query<string|int, T>

Parameters

$filters : array<string|int, mixed>|null = []: filters for the where conditions
$orderBy : array<string|int, mixed>|null = null: ordering ['column' => 'ASC/DESC']
$offset : int|null = null: offset for pagination
$limit : int|null = null: result limit
$columns : array<string|int, mixed>|null = null: specific columns to load
$includes : string|array<string|int, mixed> = []: relations to load (['translations', 'routes.translations'] or '*' for all)
$computeTotalCount : bool = false: whether to compute the total count for pagination

Return values

Query<string|int, T>

findBy()

Finds one entity by filters (returns a `SingleQuery` object).


    public
                    findBy([array<string|int, mixed> $filters = [] ][, string|array<string|int, mixed> $includes = [] ]) : SingleQuery<string|int, T>

Parameters

$filters : array<string|int, mixed> = []: filters for the where conditions
$includes : string|array<string|int, mixed> = []: relations to load (['translations', 'routes'] or '*' for all)

Return values

SingleQuery<string|int, T>

generateNow()

Generates the feed now (the "generate now" button): delegates 1:1 to {@see FeedXmlGenerator::generateById()}. The cron lock (double-click protection) stays in the UI component ({@see \App\UI\Admin\Eshop\Components\FeedEditComponent\Traits\GenerateTrait}).


    public
                    generateNow(int $feedId) : array{path: string, itemCount: int}

Parameters

$feedId : int

Return values

array{path: string, itemCount: int}

getAppContext()


    public
                    getAppContext() : AppContext

Return values

AppContext

getCategoryRels()

Returns the mapping of a single category to a value per feed; used by {@see \App\UI\Admin\Eshop\Presenters\Traits\Forms\ProductCategoryFormTrait}.


    public
                    getCategoryRels(int $categoryId) : array<int, array<string, mixed>>

Parameters

$categoryId : int

Return values

array<int, array<string, mixed>>

getLanguageContext()


    public
                    getLanguageContext() : LanguageContext|null

Return values

LanguageContext|null

getParameterRels()


    public
                    getParameterRels(int $feedId) : array<int, array<string, mixed>>

Parameters

$feedId : int

Return values

array<int, array<string, mixed>>

getParameterRelsForSet()

Returns the overrides of a single product set across all feeds; used by the "Feeds" tab in {@see \App\UI\Admin\Eshop\Components\ProductSetEditComponent\Traits\FeedFieldsTrait}.


    public
                    getParameterRelsForSet(int $productSetId) : array<int, array<string, mixed>>

Parameters

$productSetId : int

Return values

array<int, array<string, mixed>>

getParameterTree()


    public
                    getParameterTree(int $feedId) : array<int, array<string, mixed>>

Parameters

$feedId : int

Return values

array<int, array<string, mixed>>

getPresenterContext()


    public
                    getPresenterContext() : PresenterContext

Return values

PresenterContext

getSettingContext()


    public
                    getSettingContext() : SettingContext

Return values

SettingContext

getSettings()


    public
                    getSettings() : array<int, array<string, mixed>>

Return values

array<int, array<string, mixed>>

getTotalCount()

Returns the total count of the last `findAll()` of this manager's service, computed only when the query asked for it (`findAll(..., computeTotalCount: true)`); otherwise the last stored value.


    public
                    getTotalCount() : int|null

Same value as Query::getTotalCount() of that query.

Return values

int|null

initializeAllContexts()


    public
                    initializeAllContexts() : void

save()


    public
                    save(BaseEntity $entity[, array<string, mixed> $meta = [] ]) : Result

Parameters

$entity : BaseEntity
$meta : array<string, mixed> = []

Return values

Result

saveCategoryRels()

Saves the category mapping. The delete is scoped strictly to `category_id`.


    public
                    saveCategoryRels(int $categoryId, array<int, array<string, mixed>> $rows) : array{success: bool, message: ?string, data: mixed, code: ?int}

Parameters

$categoryId : int
$rows : array<int, array<string, mixed>>

Return values

array{success: bool, message: ?string, data: mixed, code: ?int}

saveParameterRels()


    public
                    saveParameterRels(int $feedId, array<int, array<string, mixed>> $rows) : array{success: bool, message: ?string, data: mixed, code: ?int}

Parameters

$feedId : int
$rows : array<int, array<string, mixed>>

Return values

array{success: bool, message: ?string, data: mixed, code: ?int}

saveParameterRelsForSet()

Saves the overrides of one product set. The delete is scoped strictly to `product_set_id = :setId`, so saving one set never deletes the overrides of other sets.


    public
                    saveParameterRelsForSet(int $productSetId, array<int, array<string, mixed>> $rows) : array{success: bool, message: ?string, data: mixed, code: ?int}

Parameters

$productSetId : int
$rows : array<int, array<string, mixed>>

Return values

array{success: bool, message: ?string, data: mixed, code: ?int}

saveParameterTree()


    public
                    saveParameterTree(int $feedId, array<int, array<string, mixed>> $tree) : array{success: bool, message: ?string, data: mixed, code: ?int}

Parameters

$feedId : int
$tree : array<int, array<string, mixed>>

Return values

array{success: bool, message: ?string, data: mixed, code: ?int}

setAppContext()


    public
                    setAppContext(AppContext $appContext) : $this

Parameters

$appContext : AppContext

Return values

$this

setCacheTagInvalidator()


    public
                    setCacheTagInvalidator(CacheTagInvalidator $cacheTagInvalidator) : static

Parameters

$cacheTagInvalidator : CacheTagInvalidator

Return values

static

setLanguageContext()


    public
                    setLanguageContext(LanguageContext|null $languageContext) : $this

Parameters

$languageContext : LanguageContext|null

Return values

$this

setParamsConfig()


    public
                    setParamsConfig(Config $paramsConfig) : static

Parameters

$paramsConfig : Config

Return values

static

setPresenterContext()


    public
                    setPresenterContext(PresenterContext $presenterContext) : $this

Parameters

$presenterContext : PresenterContext

Return values

$this

setSettingContext()


    public
                    setSettingContext(SettingContext $settingContext) : $this

Parameters

$settingContext : SettingContext

Return values

$this

updateColumn()


    public
                    updateColumn(int|array<string|int, mixed> $entityId, string $property, mixed $value) : Result

Parameters

$entityId : int|array<string|int, mixed>: id, or a list of ids / composite-id arrays
$property : string
$value : mixed

Return values

Result

updateColumns()


    public
                    updateColumns(int|array<string|int, mixed> $entityId, array<string, mixed> $values) : Result

Parameters

$entityId : int|array<string|int, mixed>: id, or a list of ids / composite-id arrays
$values : array<string, mixed>: property name => new value

Return values

Result

bumpCacheTags()

Bumps cache tags for the entity after commit: its class, the owned-cascade classes from metadata and the optional `additionalCacheTags()` of the manager.


    protected
                    bumpCacheTags(object $entity) : void

Fail-open (the invalidator swallows exceptions). Called from the manager Save/Delete/Tree traits after the commit.

Parameters

$entity : object

bumpCacheTagsExplicit()

Bumps the given classes explicitly (raw-DBAL paths with a cross-entity effect).


    protected
                    bumpCacheTagsExplicit(array<string|int, string> $classes) : void

Parameters

$classes : array<string|int, string>

bumpCacheTagsForClass()

Bumps cache tags by class name when there is no instance (bulk delete, `updateColumns()`, raw DBAL, tree operations).


    protected
                    bumpCacheTagsForClass(class-string $rootClass[, array<string|int, string> $extraTags = [] ]) : void

Bumps the root class and its owned-cascade classes.

Parameters

$rootClass : class-string
$extraTags : array<string|int, string> = []

classCacheTags()

Returns extra tags for a bump that has no entity, typically tree operations ({@see \App\Core\Traits\Api\Models\Managers\TreeTrait::treeTransaction()}) that rewrite `lft`/`rgt` on many rows.


    protected
                    classCacheTags() : array<string|int, string>

IMPORTANT: additionalCacheTags(object) receives an entity, so a class-level bump cannot use it; without this hook a delete would lose the cross-entity tag (Comment to CommentThread). A manager whose cross-entity tag does not depend on a particular entity returns it here.

NOTE: unlike additionalCacheTags(), this hook is declared (with an empty default) instead of being an opt-in through method_exists(); method_exists() is always true in a manager that has the method, which phpstan reports as alreadyNarrowedType.

Return values

array<string|int, string>

getService()

Returns the service for the traits.


    protected
                    getService() : TService

Return values

TService

FeedManager extends Manager in package Application

Tags

Table of Contents

Properties

Methods

Properties

$service

$appContext

$cacheTagInvalidator

$languageContext

$paramsConfig

$presenterContext

$settingContext

$feedXmlGenerator read-only

Methods

__construct()

Parameters

delete()

Parameters

Return values

deleteAll()

Parameters

Return values

find()

Parameters

Return values

findAll()

Parameters

Return values

findBy()

Parameters

Return values

generateNow()

Parameters

Return values

getAppContext()

Return values

getCategoryRels()

Parameters

Return values

getLanguageContext()

Return values

getParameterRels()

Parameters

Return values

getParameterRelsForSet()

Parameters

Return values

getParameterTree()

Parameters

Return values

getPresenterContext()

Return values

getSettingContext()

Return values

getSettings()

Return values

getTotalCount()

Return values

initializeAllContexts()

save()

Parameters

Return values

saveCategoryRels()

Parameters

Return values

saveParameterRels()

Parameters

Return values

saveParameterRelsForSet()

Parameters

Return values

saveParameterTree()

Parameters

Return values

setAppContext()

Parameters

Return values

setCacheTagInvalidator()

Parameters

FeedManager extends Manager
in package

Application