Public Member Functions
	Dataface_RemoveRelatedRecordForm (&$record, $relationshipName, $query=null)
	formSubmitted ()
&	getRecord ()
	allowDeleteRecords ()
	deleteRequired ()
	_build ()
	display ()
&	getSelectedRecords ()
&	getDomainTable ()
	delete ($values)
Data Fields
	$_record
	$_relationshipName
	$_relationship
	$_isBuilt = false
	$query
	$records
	$_domainTable
	$allowDelete

Detailed Description

File: Dataface/RemoveRelatedRecordForm.php Author: Steve Hannah <shannah@sfu.ca> Created: November 2005

Description: -------------

An HTML form to remove a set of records from a relationship. It also has an option to remove the records from the database.

Definition at line 40 of file RemoveRelatedRecordForm.php.

Member Function Documentation

_build ( )

Builds the form.

Definition at line 190 of file RemoveRelatedRecordForm.php.

allowDeleteRecords ( )

Definition at line 156 of file RemoveRelatedRecordForm.php.

Dataface_RemoveRelatedRecordForm	(	&$	record,
		$	relationshipName,
		$	query = `null`
	)

Constructor

Parameters:

record	Reference to record object. If left null or blank, the proper record will be loaded using GET and POST parameters. Dataface_Record
relationshipName	The name of the relationship from which records will be removed.
array	of urlencoded strings of the form key1=value1&key2=value2& ... etc.. where keyi is the ith key in the related record.

Definition at line 107 of file RemoveRelatedRecordForm.php.

delete ( $ values )

Deletes the appropriate records from the join table and the domain table (if requested).

Definition at line 299 of file RemoveRelatedRecordForm.php.

deleteRequired ( )

Indicates whether this removal *REQUIRES* a delete to occur. For one to many relationships, deletion is required. For many-to-many relationships, deletion is not required.

Definition at line 181 of file RemoveRelatedRecordForm.php.

display ( )

Displays the form.

Definition at line 236 of file RemoveRelatedRecordForm.php.

formSubmitted ( )

Indicates whether or not form can be submitted. This can be called in static context also which makes it usable in the constructor.

Returns:: boolean True if form has been submitted. False otherwise.

Definition at line 137 of file RemoveRelatedRecordForm.php.

& getDomainTable ( )

Returns a reference to the Dataface_Table object encapsulating the domain table for this relationship.

Returns:: Dataface_Table The domain table.

Definition at line 279 of file RemoveRelatedRecordForm.php.

& getRecord ( )

Loads and returns the Dataface_Record object that is specified by the current POST and GET variables. This may be called in static context which makes it useful in the constructor.