return -> void

since -> 1.0.0

Parameters <>

  $group -> string
  Group ID

  $id_s -> string | array
  Group data: array for recursive list, string for single item

  $value -> mixed
  Item value: if $id_s is an array leave it empty

/**
 * Store data in multiple groups
 *
 * @param string $group
 * Group ID
 * @param string|array $id_s
 * Group data: array for recursive list, string for single item
 * @param mixed $value
 * Item value: if `$id_s` is an array leave it empty
 *
 * @return void
 * @since 1.0.0
 */
public function setScopeGroup($group, $id_s, $value = ""){
    if (is_array($id_s)) {
        foreach ($id_s as $id => $v) {
            self::setScopeGroup($group, $id, $v);
        }
    } else {
        if (is_scalar($id_s)) {
            $this->SCOPE_GROUP[$group][$id_s] = $value;
        }
    }
}

return -> void

since -> 1.0.4

Parameters <>

  $group -> string
  Group ID

  $new_value -> mixed
  New value to replace

/**
 * Replace group data
 *
 * @param string $group
 * Group ID
 * @param mixed $new_value
 * New value to replace
 *
 * @return void
 * @since 1.0.4
 */
public function updateScopeGroup($group, $new_value){
    if (isset($this->SCOPE_GROUP[$group])) {
        $this->SCOPE_GROUP[$group] = $new_value;
    }
}

return -> array|mixed

since -> 1.0.0

Parameters <>

  $group -> string
  Group ID

  $id -> null | string
  Group id: leave it to null to get the whole group data

  $sort -> bool
  Whether to sort array or not

/**
 * Get group items.
 * if <code>$id</code> is null, it returns the whole group and returns empty array if group is not set<br>
 * if <code>$id</code> is not null, returns items with specified id and returns empty array if id is not set
 *
 * @param string $group
 * Group ID
 * @param null|string $id
 * Group id: leave it to null to get the whole group data
 * @param bool $sort
 * Whether to sort array or not
 *
 * @return array|mixed
 * @since 1.0.0
 */
public function getScopeGroup($group, $id = null, $sort = false){
    if (empty($id)) {
        $data = $this->SCOPE_GROUP[$group] ?? [];
    } else {
        $data = $this->SCOPE_GROUP[$group][$id] ?? [];
    }
    if ($sort and is_array($data)) {
        usort($data, function ($a, $b) {
            return ($a["priority"] ?? 10) - ($b["priority"] ?? 10);
        });
    }
    return $data;
}

return -> void

since -> 1.0.0

Parameters <>

  $group -> string
  Group ID

  $id -> string | null
  Item ID, pass null to remove all items

/**
 * Remove item groups item
 *
 * @param string $group
 * Group ID
 * @param string|null $id
 * Item ID, pass null to remove all items
 *
 * @return void
 * @since 1.0.0
 */
public function removeScopeGroup($group, $id = null){
    if (isset($this->SCOPE_GROUP[$group])) {
        if (isset($this->SCOPE_GROUP[$group][$id])) {
            unset($this->SCOPE_GROUP[$group][$id]);
        } else {
            unset($this->SCOPE_GROUP[$group]);
        }
    }
}

return -> void

since -> 1.0.0

Parameters <>

  $key -> string
  Cache key (PREFIX constant will be added to the beginning for cookies)

  $value -> string | mixed
  Cache value (for cookie only string is acceptable)

  $cookie -> null | true | int
  Number of days or true for 1 day or null to skip adding cookie

/**
 * Set cache
 * <br>Note: Cache contains sessions, cookies and scope variables
 *
 * @param string $key
 * Cache key (`PREFIX` constant will be added to the beginning for cookies)
 * @param string|mixed $value
 * Cache value (for cookie only string is acceptable)
 * @param null|true|int $cookie
 * Number of days or true for 1 day or null to skip adding cookie
 *
 * @return void
 * @since 1.0.0
 */
public function setCache($key, $value, $cookie = null){
    $this->cache[$key] = $value;
    $id = self::PREFIX . $key;
    if ($cookie) {
        setcookie($id, $value, time() + self::STAMPS['day'] * (is_int($cookie) ? $cookie : 1), '/');
    }
}

return -> mixed|null

since -> 1.0.0

Parameters <>

  $key -> string
  Cache key

  $type -> string
  Cache type: "cookie" | "session" | "scope"

/**
 * Get cache if exist
 *
 * @param string $key
 * Cache key
 * @param string $type
 * Cache type: "cookie" | "session" | "scope"
 *
 * @return mixed|null
 * @since 1.0.0
 */
public function getCache($key, $type = "*"){
    if ($cache = self::cookieExists($key, true) and in_array($type, ["*", "cookie"])) {
        return $cache;
    }
    if ($cache = self::sessionExists($key, true) and in_array($type, ["*", "session"])) {
        return $cache;
    }
    if ($cache = self::cacheExists($key, true) and in_array($type, ["*", "scope"])) {
        return $cache;
    }
    return null;
}

return -> void

since -> 1.0.0

Parameters <>

  $key -> string
  Cache key (without prefix)

/**
 * Remove cache if exists.
 * <br>Note: Cache contains sessions, cookies and scope variables
 *
 * @param string $key
 * Cache key (without prefix)
 *
 * @return void
 * @since 1.0.0
 */
public function removeCache($key){
    $id = self::PREFIX . $key;
    # Remove cookie
    if (self::cookieExists($key)) {
        // Just making sure
        $_COOKIE[$id] = null;
        setcookie($id, "", time() - 3600, "/");
        unset($_COOKIE[$id]);
    }
    # Remove session
    if (self::sessionExists($key)) {
        $_SESSION[$id] = null;
        unset($_SESSION[$id]);
    }
    # remove cache
    if (self::cacheExists($key)) {
        $this->cache[$key] = null;
        unset($this->cache[$key]);
    }
}

return -> bool|mixed|string

since -> 1.0.0

Parameters <>

  $key -> string
  Cache key

  $get -> false
  Whether to get cache (if exists) or not

  $default -> string
  Default value that return if cache doesn't exist

/**
 * Check if `$cache` variable contains an element
 *
 * @param string $key
 * Cache key
 * @param false $get
 * Whether to get cache (if exists) or not
 * @param string $default
 * Default value that return if cache doesn't exist
 *
 * @return bool|mixed|string
 * @since 1.0.0
 */
public function cacheExists($key, $get = false, $default = ""){
    return !empty($this->cache[$key]) ? $get ? $this->cache[$key] : true : ($get ? $default : false);
}

return -> void

since -> 1.0.0

Parameters <>

  $key -> string
  Cookie key (PREFIX constant will be added to the beginning)

  $value -> string
  Cookie value

  $cookie -> bool | int
  Number of days or true for 1 day

/**
 * Set cookie
 *
 * @param string $key
 * Cookie key (`PREFIX` constant will be added to the beginning)
 * @param string $value
 * Cookie value
 * @param bool|int $cookie
 * Number of days or true for 1 day
 *
 * @return void
 * @since 1.0.0
 */
public function setCookie($key, $value, $cookie = false){
    $id = self::PREFIX . $key;
    if (!headers_sent()) {
        setcookie($id, $value, time() + self::STAMPS['day'] * (is_int($cookie) ? $cookie : 1), '/');
    }
}

return -> void

since -> 1.0.0

Parameters <>

  $key -> string
 

/**
 * Remove cookie if exists
 *
 * @param string $key
 *
 * @return void
 * @since 1.0.0
 */
public function removeCookie($key){
    $id = self::PREFIX . $key;
    // Remove cookie by changing the expiration time
    if (self::cookieExists($key)) {
        setcookie($id, "", time() - 3600, "/");
    }
}

return -> void

since -> 1.0.0

Parameters <>

  $key -> string
  Session key (PREFIX constant will be added to the beginning)

  $value -> string
  Session value

/**
 * Set session
 *
 * @param string $key
 * Session key (`PREFIX` constant will be added to the beginning)
 * @param string $value
 * Session value
 *
 * @return void
 * @since 1.0.0
 */
public function setSession($key, $value){
    $id = self::PREFIX . $key;
    $_SESSION[$id] = $value;
}

return -> void

since -> 1.0.0

Parameters <>

  $key -> string
  Session key (PREFIX constant will be added to the beginning)

  $value -> string
  Session value

/**
 * Set session
 *
 * @param string $key
 * Session key (`PREFIX` constant will be added to the beginning)
 * @param string $value
 * Session value
 *
 * @return void
 * @since 1.0.0
 */
public function setSession($key, $value){
    $id = self::PREFIX . $key;
    $_SESSION[$id] = $value;
}

return -> bool

since -> 1.0.0

Parameters <>

  $key -> string
  Cache key (PREFIX constant will be added to the beginning for sessions and cookies)

  $onlyCookie -> bool
  Whether to only check cookie or all cache methods

/**
 * Check if cache is set
 * <br>Note: Cache contains sessions, cookies and scope variables
 *
 * @param string $key
 * Cache key (`PREFIX` constant will be added to the beginning for sessions and cookies)
 * @param bool $onlyCookie
 * Whether to only check cookie or all cache methods
 *
 * @return bool
 * @since 1.0.0
 */
public function cacheIsset($key, $onlyCookie = false){
    $cookieExists = self::cookieExists($key);
    if ($onlyCookie) {
        return $cookieExists;
    }
    if ($cookieExists) {
        return true;
    }
    if (self::cacheExists($key)) {
        return true;
    }
    if (self::cacheExists($key)) {
        return true;
    }
    return false;
}

return -> void

since -> 1.0.0

Parameters <>

  $id -> string
  Stylesheet ID. You can specify stylesheet scope by adding ':' character to the beginning of ID. e.g: "dashboard:style_id"

  $url -> string
  Stylesheet URL

  $ver -> string
  Stylesheet version

/**
 * Add CSS stylesheet
 *
 * @param string $id
 * Stylesheet ID. You can specify stylesheet scope by adding ':' character to the beginning of ID. e.g: "dashboard:style_id"
 * @param string $url
 * Stylesheet URL
 * @param string $ver
 * Stylesheet version
 *
 * @return void
 * @since 1.0.0
 */
public function addStyle($id, $url, $ver = "unknown"){
    $this->css[$id] = array('id' => $id, 'url' => $url, 'ver' => $ver);
}

return -> void

since -> 1.0.0

Parameters <>

  $scope -> string
  Stylesheet scope

/**
 * Print stylesheets
 *
 * @param string $scope
 * Stylesheet scope
 *
 * @return void
 * @since 1.0.0
 */
public function dumpStyles($scope = null){
    if (!is_array($this->css) or empty($this->css)) {
        return;
    }
    foreach ($this->css as $id => $data) {
        if (!empty($scope) and !amd_starts_with($id, "{$scope}:")) {
            continue;
        }
        if (empty($scope) and strpos($id, ":") !== false) {
            continue;
        }
        $v = $data['ver'];
        # @formatter off
        ?>
            <link rel="stylesheet" href="<?php 
        echo esc_url($data['url'] . (!empty($v) ? '?ver=' . $v : ''));
        ?>">
			<?php 
        # @formatter on
    }
}

return -> void

since -> 1.0.0

Parameters <>

  $id -> string
  Script ID. You can specify script scope by adding ':' character to the beginning of ID. e.g: "dashboard:script_id"

  $url -> string
  Script URL

  $ver -> string
  Script version

/**
 * Add JS script
 *
 * @param string $id
 * Script ID. You can specify script scope by adding ':' character to the beginning of ID. e.g: "dashboard:script_id"
 * @param string $url
 * Script URL
 * @param string $ver
 * Script version
 *
 * @return void
 * @since 1.0.0
 */
public function addScript($id, $url, $ver = "unknown"){
    $this->js[$id] = array('id' => $id, 'url' => $url, 'ver' => $ver);
}

return -> void

since -> 1.0.0

Parameters <>

  $scope -> string
  Script scope

/**
 * Print script
 * @param string $scope
 * Script scope
 *
 * @return void
 * @since 1.0.0
 */
public function dumpScript($scope = null){
    if (!is_array($this->js) or empty($this->js)) {
        return;
    }
    foreach ($this->js as $id => $data) {
        if (!empty($scope) and !amd_starts_with($id, "{$scope}:")) {
            continue;
        }
        if (empty($scope) and strpos($id, ":") !== false) {
            continue;
        }
        $v = $data['ver'];
        # @formatter off
        ?>
            <script src="<?php 
        echo esc_url($data['url'] . (!empty($v) ? '?ver=' . $v : ''));
        ?>"></script>
			<?php 
        # @formatter on
    }
}

return -> void

since -> 1.0.0

Parameters <>

  $key -> string
  Item key

  $value -> mixed
  Item value

/**
 * Set defaults value
 *
 * @param string $key
 * Item key
 * @param mixed $value
 * Item value
 *
 * @return void
 * @since 1.0.0
 */
public function setDefault($key, $value){
    $this->defaults[$key] = $value;
}

return -> mixed|string

since -> 1.0.0

Parameters <>

  $key -> string
  Item key

  $default -> mixed
  Return this value if item doesn't exist

/**
 * Get defaults value
 *
 * @param string $key
 * Item key
 * @param mixed $default
 * Return this value if item doesn't exist
 *
 * @return mixed|string
 * @since 1.0.0
 */
public function getDefault($key, $default = ""){
    return isset($this->defaults[$key]) ? $this->defaults[$key] : $default;
}