contentbox.modules.contentbox-deps.modules.cbstorages.models

Class RequestStorage

lucee.Component
    extended by contentbox.modules.contentbox-deps.modules.cbstorages.models.RequestStorage

Request Storage plugin. It provides the user with a mechanism for request cycle data storage using the request scope.

Class Attributes:
  • singleton
  •  
  • output : false
  •  
  • synchronized : false
  •  
  • accessors : false
  •  
  • persistent : false
  •  
    Constructor Summary
    init()
    Method Summary
    void clearAll()
         Clear the entire coldbox request storage.
    private void createStorage()
         Create the request storage scope.
    boolean deleteVar(string name)
         Tries to delete a request cycle var.
    boolean exists(string name)
         Checks wether the request cycle variable exists.
    any getStorage()
         Get the entire storage scope.
    any getVar(string name, [any default=''])
         Get a new request cycle variable.
    void removeStorage()
         remove the entire storage scope.
    void setVar(string name, any value)
         Set a new request cycle variable.
     
    Methods inherited from class lucee.Component
    None

    Constructor Detail

    init

    public init()


    Method Detail

    clearAll

    public void clearAll()

    Clear the entire coldbox request storage


    createStorage

    private void createStorage()

    Create the request storage scope


    deleteVar

    public boolean deleteVar(string name)

    Tries to delete a request cycle var.

    Parameters:
    name - The variable name to retrieve.

    exists

    public boolean exists(string name)

    Checks wether the request cycle variable exists.

    Parameters:
    name - The variable name to retrieve.

    getStorage

    public any getStorage()

    Get the entire storage scope


    getVar

    public any getVar(string name, [any default=''])

    Get a new request cycle variable. If the variable does not exist. The method returns blank.

    Parameters:
    name - The variable name to retrieve.
    default - The default value to set. If not used, a blank is returned.

    removeStorage

    public void removeStorage()

    remove the entire storage scope


    setVar

    public void setVar(string name, any value)

    Set a new request cycle variable.

    Parameters:
    name - The name of the variable.
    value - The value to set in the variable.