Important

You are browsing the documentation for version 4.2 of OroCommerce, OroCRM and OroPlatform, which is no longer maintained. Read version 5.1 (the latest LTS version) of the Oro documentation to get up-to-date information.

See our Release Process documentation for more information on the currently supported and upcoming releases.

Mediator Handlers

OroSyncBundle declares some mediator handlers.

Content Manager

Cache Management Handlers

Handler Name

Method

Description

pageCache:init

contentManager.init

Sets up content management component, sets the initial URL

pageCache:add

contentManager.add

Adds the current page to permanent cache

pageCache:get

contentManager.get

Fetches cache data for the URL, by default for the current URL

pageCache:remove

contentManager.remove

Clears cached data, by default for the current URL

State Management Handlers

:header: “Handler Name”,”Method”,”Description”

pageCache:state:save

contentManager.saveState

Saves the state of a page component in a cache

pageCache:state:fetch

contentManager.fetchState

Fetches the state of a page component from the cached page

pageCache:state:check

contentManager.checkState

Checks if the state’s GET parameter (pair key and hash) reflects the current URL

Helper Methods Handlers

Handler Name

Method

Description

currentUrl

contentManager.currentUrl

Returns the current URL (path + query)

compareUrl

contentManager.compareUrl

Retrieves the meaningful part of the path from the URL and compares it to the reference path (or to the current one if the last one is undefined)

changeUrl

contentManager.changeUrl

Changes the URL for the current page

changeUrlParam

contentManager.changeUrlParam

Updates the URL parameter for the current page

See orosync/js/content-manager module for details.