felixarntz/wp-psr-cache

<?php
/**
 * Interface WpCacheKeyGen
 *
 * @package LeavesAndLove\WpPsrCache
 * @license GNU General Public License, version 2
 * @link    https://github.com/felixarntz/wp-psr-cache
 */

namespace LeavesAndLove\WpPsrCache\CacheKeyGen;

/**
 * WordPress cache key generator interface.
 *
 * @since 1.0.0
 */
interface WpCacheKeyGen extends CacheKeyGen
{

    /**
     * Add cache groups to consider global groups.
     *
     * @since 1.0.0
     *
     * @param array $groups The list of groups that are global.
     */
    public function addGlobalGroups(array $groups);

    /**
     * Gets the list of global groups.
     *
     * @since 1.0.0
     *
     * @return array List of global groups.
     */
    public function getGlobalGroups(): array;

    /**
     * Add cache groups to consider network groups.
     *
     * @since 1.0.0
     *
     * @param array $groups The list of groups that are network-specific.
     */
    public function addNetworkGroups(array $groups);

    /**
     * Gets the list of network groups.
     *
     * @since 1.0.0
     *
     * @return array List of network groups.
     */
    public function getNetworkGroups(): array;

    /**
     * Switch the site context.
     *
     * @since 1.0.0
     *
     * @param int $siteId Site ID to switch the context to.
     */
    public function switchSiteContext(int $siteId);

    /**
     * Get the site context.
     *
     * @since 1.0.0
     *
     * @return int Site ID of the current context.
     */
    public function getSiteContext(): int;

    /**
     * Switch the network context.
     *
     * @since 1.0.0
     *
     * @param int $networkId Network ID to switch the context to.
     */
    public function switchNetworkContext(int $networkId);

    /**
     * Get the network context.
     *
     * @since 1.0.0
     *
     * @return int Network ID of the current context.
     */
    public function getNetworkContext(): int;
}