Overview.md

Overview

PRG Component Features

The Prg Component implements the PRG pattern so you can use it separately from search tasks when you need it.

The component maintains passed and named parameters or query string variables that come as POST parameters and transform it to the named during redirect, and sets Controller::data back if the GET method was used during component call.

Most importantly the component acts as the glue between your app and the searchable behavior.

You can attach the component to your controller. Here is an example using defaults already set in the component itself.

public $components = array('Search.Prg' => array(
	// options for preset form method
	'presetForm' => array(
		// 'paramType' can be 'named' or 'querystring'
		'paramType' => 'named',
		// 'model' can be 'null' or a default model name
		'model' => null
	),
	// options for commonProcess method
	'commonProcess' => array(
		'formName' => null,
		'keepPassed' => true,
		'action' => null,
		'modelMethod' => 'validateSearch',
		'allowedParams' => array(),
		// 'paramType' can be 'named' or 'querystring'
		'paramType' => 'named',
		'filterEmpty' => false
	)
));

PrgComponent::presetForm Options

• paramType: named or querystring, by default named.
• model: Model name or null, by default null.

PrgComponent::commonProcess Options

The commonProcess() method defined in the Prg component allows you to inject search in any controller with just 1-2 lines of additional code. You should pass the model name that is used for search. By default it is Controller::$modelClass.

Additional options parameters.

• form: Search form name.
• keepPassed: Parameter that describes if you need to merge passedArgs to the url where you will be redirected to after post.
• action: Sometimes you want to have different actions for post and get. In this case you can define get action using this parameter.
• modelMethod: Method used to filter named parameters, passed from the form. By default it is validateSearch, and it defined in Searchable behavior.