pm_cList:: setFSP Method

Gets the specified setting (filtering, sorting, paging) from the global array of parameters.

Syntax

function setFSP ($cmd)

Parameters

cmd

      A string value with a command that specifies the setting to be applied. Supported are the following commands:

• 'setFilter' - tells the function to apply filtering settings;
• 'clearFilter' - tells the function to clear filtering settings;
• 'setSort' - tells the function to apply sorting settings;
• 'setPage' - tells the function to set the current page;
• 'setPageSize' - tells the function to set the page size.

Returns

A boolean which is true if the specified setting has been applied successfully, false otherwise. If one passes in false as a command, the function returns true.

Remarks

This function looks for the specified setting in the global array of parameters passed to a script via GET, POST, or COOKIE HTML method:

• The 'filter' parameter is checked if the 'setFilter' command is specified;
• The 'sort' parameter is checked if the 'setSort' command is specified;
• The 'page' parameter is checked if the 'setPage' command is specified;
• The 'page_size' parameter is checked if the 'setPageSize' command is specified.

In case the passed in command is not recognized, Plesk throws an error message.

One may need to define a custom command if the derived class is extended with new properties that should be read from the global array of parameters. It is important that all new commands are registered in the isCMDSupported method. Also, every command triggers a special member function that reads the global parameter and puts the obtained value to the matching class member variable. The code of the overloaded method can look as follows:

static function setFSP($cmd)

{

      switch ($cmd){

      case false:

                    return true;

      case '<new_command>':

                    return $this->set<new_param>(get_gpc('<new_param>'));

      …

      psaerror('Command not found:'.$cmd);

      }

}