SearchIndexController Class Reference

Detailed Description

SearchIndexController creates a Lucene index from the complete datastore.

The controller supports the following actions:

Action default
Create the index.

Parameter Description
in nodesPerCall The number of nodes to process in one call (default: 10)

For additional actions and parameters see BatchController actions.

Author
ingo herwig ingo@.nosp@m.wemo.nosp@m.ve.co.nosp@m.m

Definition at line 46 of file SearchIndexController.php.

+ Inheritance diagram for SearchIndexController:

Public Member Functions

 __construct (Session $session, PersistenceFacade $persistenceFacade, PermissionManager $permissionManager, ActionMapper $actionMapper, Localization $localization, Message $message, Configuration $configuration, Search $search)
 
 initialize (Request $request, Response $response)
 
- Public Member Functions inherited from BatchController
 initialize (Request $request, Response $response)
 
- Public Member Functions inherited from Controller
 __construct (Session $session, PersistenceFacade $persistenceFacade, PermissionManager $permissionManager, ActionMapper $actionMapper, Localization $localization, Message $message, Configuration $configuration)
 
 initialize (Request $request, Response $response)
 
 execute ($method=null)
 
 getRequest ()
 
 getResponse ()
 

Protected Member Functions

 getWorkPackage ($number)
 
 collect ($types)
 
 index ($oids)
 
 optimize ($oids)
 
- Protected Member Functions inherited from BatchController
 doExecute ($method=null)
 
 getStepNumber ()
 
 addWorkPackage ($name, $size, $oids, $callback, $args=null)
 
 processPart ($step)
 
 getRequestValue ($name)
 
 getNumberOfSteps ()
 
 getDisplayText ($step)
 
 getDownloadFile ()
 
 getWorkPackage ($number)
 
 cleanup ()
 
- Protected Member Functions inherited from Controller
 validate ()
 
 doExecute ($method=null)
 
 executeSubAction ($action)
 
 redirect ($location, $key=null, $data=null)
 
 getLogger ()
 
 getSession ()
 
 getPersistenceFacade ()
 
 getPermissionManager ()
 
 getActionMapper ()
 
 getLocalization ()
 
 getMessage ()
 
 getConfiguration ()
 
 requireTransaction ()
 
 endTransaction ($commit)
 
 isLocalizedRequest ()
 
 checkLanguageParameter ()
 
 generateCsrfToken ($name)
 
 validateCsrfToken ($name)
 
 getLocalSessionValue ($key, $default=null)
 
 setLocalSessionValue ($key, $value)
 
 clearLocalSessionValues ()
 

Additional Inherited Members

- Public Attributes inherited from BatchController
const REQUEST_VAR = 'request'
 
const ONE_CALL_VAR = 'oneCall'
 
const STEP_VAR = 'step'
 
const NUM_STEPS_VAR = 'numSteps'
 
const DOWNLOAD_STEP_VAR = 'downloadStep'
 
const PACKAGES_VAR = 'packages'
 
- Public Attributes inherited from Controller
const CSRF_TOKEN_PARAM = 'csrf_token'
 

Constructor & Destructor Documentation

__construct ( Session  $session,
PersistenceFacade  $persistenceFacade,
PermissionManager  $permissionManager,
ActionMapper  $actionMapper,
Localization  $localization,
Message  $message,
Configuration  $configuration,
Search  $search 
)

Constructor.

Parameters
$session
$persistenceFacade
$permissionManager
$actionMapper
$localization
$message
$configuration
$search

Definition at line 67 of file SearchIndexController.php.

Member Function Documentation

initialize ( Request  $request,
Response  $response 
)
See also
Controller::initialize()

Definition at line 83 of file SearchIndexController.php.

getWorkPackage (   $number)
protected
See also
BatchController::getWorkPackage()

Definition at line 98 of file SearchIndexController.php.

collect (   $types)
protected

Collect all oids of the given types.

Parameters
$typesThe types to process
Note
This is a callback method called on a matching work package
See also
BatchController::addWorkPackage()

Definition at line 129 of file SearchIndexController.php.

index (   $oids)
protected

Create the lucene index from the given objects.

Parameters
$oidsThe oids to process
Note
This is a callback method called on a matching work package
See also
BatchController::addWorkPackage()

Definition at line 149 of file SearchIndexController.php.

optimize (   $oids)
protected

Optimize the search index.

Parameters
$oidsThe oids to process
Note
This is a callback method called on a matching work package
See also
BatchController::addWorkPackage()

Definition at line 170 of file SearchIndexController.php.