File Source for MultiRelationSelect.class.php

<?php
/**
* For including this file you have to define the constant "CLASSPATH".
* Because every include in the framework depends on the CLASSPATH definition.
* The CLASSPATH means the relative path to the folder that contains the
* framework GilliGan.
*
* @package forms
* @subpackage items
*/
if( !defined( "CLASSPATH" ) )
{
echo "<h3>You have to define the constant CLASSPATH!</h3>\n";
echo "Example: define( 'CLASSPATH', '../path/to/classes/' );\n";
exit();
}
/**
* Including the basic class for form items.
*/
require_once( CLASSPATH."forms/items/ABSTHTMLFormItem.class.php" );
/**
*
*/
require_once( CLASSPATH."forms/items/HTMLSelect.class.php" );
/**
*
*/
require_once( CLASSPATH."forms/items/HTMLButton.class.php" );
/**
*
*/
require_once( CLASSPATH."forms/items/HTMLHiddenInput.class.php" );
/**
*
*/
require_once( CLASSPATH."html/JavaScript.class.php" );
/**
*
*/
require_once( CLASSPATH."html/HTMLTable.class.php" );
/**
* A class to generate selects mainly to handle multiple relation between two
* databasetables.
* <code>
* _________
* | p |v|
* ---------
* mtrb
* +-------+-+ | +-------+-+
* | | | V | |-|
* | | | |>>| | | |
* | ls | | | rs | |
* | |-| |<<| | |-|
* | |-| ^ | | |
* +-------+-+ | +-------+-+
* mtlb
*
*
* p - $primaryEntitySelect
* ls - $leftSelect
* rs - $rightSelect
* mtlb - $moveToLeftButton
* mtrb - $moveToRightButton
*</code>
*
* @package forms
* @subpackage items
* @version 0.1.3
* @author Daniel Plücken <daniel@debakel.net>
* @license http://www.gnu.org/copyleft/lesser.html
* GNU Lesser General Public License
* @copyright Copyright (C) 2005 Daniel Plücken <daniel@debakel.net>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* Public License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place, Suite 330,
* Boston, MA 02111-1307 USA
*/
class MultiRelationSelect extends ABSTHTMLFormItem
{
/**
* @var object $primaryEntityDBTObject
* @access public
*/
var $primaryEntityDBTObject;
/**
* @var object $secondaryEntityDBTObject
* @access public
*/
var $secondaryEntityDBTObject;
/**
* @var object $targetDBTObject
* @access public
*/
var $targetDBTObject;
/**
* @var string $primaryEntityPrimaryKey
* @access public
*/
var $primaryEntityPrimaryKey = "";
/**
* @var array $primaryEntityLabelFieldArr
* @access public
*/
var $primaryEntityLabelFieldArr = array();
/**
* @var string $primaryEntitySelectedValue
* @access public
*/
var $primaryEntitySelectedValue = "";
/**
* @var string $secondaryEntityPrimaryKey
* @access public
*/
var $secondaryEntityPrimaryKey = "";
/**
* @var array $secondaryEntityLabelFieldArr
* @access public
*/
var $secondaryEntityLabelFieldArr = array();
/**
* @var string $targetPrimaryEntityKey
* @access public
*/
var $targetPrimaryEntityKey = "";
/**
* @var string $targetSecondaryEntityKey
* @access public
*/
var $targetSecondaryEntityKey = "";
/**
* @var string $primaryEntityWhereClause
* @access public
*/
var $primaryEntityWhereClause = "";
/**
* @var string $secondaryEntityWhereClause
* @access public
*/
var $secondaryEntityWhereClause = "";
/**
* @var string $targetDBTWhereClause
* @access public
*/
var $targetDBTWhereClause = "";
/**
* @var integer $leftSelectSize
* @access public
*/
var $leftSelectSize;
/**
* @var integer $rightSelectSize
* @access public
*/
var $rightSelectSize;
/**
* @var string $moveToRightButtonLabel
* @access public
*/
var $moveToRightButtonLabel = "";
/**
* @var string $moveToLeftButtonLabel
* @access public
*/
var $moveToLeftButtonLabel = "";
/**
* @var string $serializedStandardValue
* @access public
*/
var $serializedStandardValue = "";
/**
* @var string $moveToRightButtonStyle
* @access public
*/
var $moveToRightButtonStyle = "";
/**
* @var string $moveToLeftButtonStyle
* @access public
*/
var $moveToLeftButtonStyle = "";
/**
* @var string $primaryEntitySelectStyle
* @access public
*/
var $primaryEntitySelectStyle = "";
/**
* @var string $leftSelectStyle
* @access public
*/
var $leftSelectStyle = "";
/**
* @var string $rightSelectStyle
* @access public
*/
var $rightSelectStyle = "";
/**
* @var string $form_name
* @access public
*/
var $form_name = "";
/**
* @var HTMLHiddenInput $hiddenValueInput
* @access public
*/
var $hiddenValueInput;
/**
* @var string $layout_table_head
* @access public
*/
var $layout_table_head = "";
/**
* Constructor
*
* @version 1.5
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param object $primaryEntityDBTObject The databasetable object of
* the entity which should
* multiple connected to another
* entity.
* For example one Person is a
* member of different Groups.
* The group is the primary
* entity if you want to assign
* persons to an afore selected
* group.
* @param string $primaryEntityPrimaryKey The field of the primary
* entity which should used for
* the relationship to the
* secondary entity.
* @param array $primaryEntityLabelFieldArr The fieldnames of the primary
* entity for the use of labels
* in the select of the primary
* entity, so that the primary
* entity could be identified by
* the user of the select.
* @param string $primaryEntitySelectedValue The selected value on primary
* entity side.
* @param object $secondaryEntityDBTObject The databasetable object of
* the entity which should
* multiple connected to
* another entity.
* For example some different
* Groups each have the same
* Person as a member.
* The person is the seconary
* entity if you want to assign
* persons to an afore selected
* group.
* @param string $secondaryEntityPrimaryKey The field of the secondary
* entity which should used for
* the relationship to the
* primary entity.
* @param array $secondaryEntityLabelFieldArr The fieldnames which should
* act as labels for the
* secondary entity, so the user
* of the select is able to
* understand the meaning of
* the entity.
* @param object $targetDBTObject The databasetable object of
* the table that should keep
* the relation of the connected
* entities.
* @param string $targetPrimaryEntityKey The fieldname where the
* value of the primary key of
* the primaray entity should
* stored.
* @param string $targetSecondaryEntityKey The fieldname where the
* value of the primary key of
* the secondary entity should
* stored.
* @param string $primaryEntityWhereClause This is to filter the primary
* entities. If their count is
* only one, the primary entity
* select will not be shown.
* @param integer $leftSelectSize
* @param integer $rightSelectSize
* @param string $moveToRightButtonLabel The label of the button by
* which the items of the
* primary entity should
* combined with the secondary
* entity.
* @param string $moveToLeftButtonLabel The label of the button by
* which the items of the
* primary entity should
* lose their connection to the
* secondary entity.
* @param string $serializedStandardValue The content of the select on
* the right side. This
* parameter overules the real
* value in the databasetable
* if it is not empty.
* @return object
*/
function MultiRelationSelect(
$name,
&$primaryEntityDBTObject,
$primaryEntityPrimaryKey,
$primaryEntityLabelFieldArr,
$primaryEntitySelectedValue,
&$secondaryEntityDBTObject,
$secondaryEntityPrimaryKey,
$secondaryEntityLabelFieldArr,
&$targetDBTObject,
$targetPrimaryEntityKey,
$targetSecondaryEntityKey,
$primaryEntityWhereClause = "",
$leftSelectSize = 10,
$rightSelectSize = 10,
$moveToRightButtonLabel = "»",
$moveToLeftButtonLabel = "«",
$serializedStandardValue = ""
)
{
$this->name = $name;
$this->primaryEntityDBTObject = &$primaryEntityDBTObject;
$this->primaryEntityPrimaryKey = $primaryEntityPrimaryKey;
$this->primaryEntityLabelFieldArr = $primaryEntityLabelFieldArr;
$this->primaryEntitySelectedValue = $primaryEntitySelectedValue;
$this->secondaryEntityDBTObject = &$secondaryEntityDBTObject;
$this->secondaryEntityPrimaryKey = $secondaryEntityPrimaryKey;
$this->secondaryEntityLabelFieldArr = $secondaryEntityLabelFieldArr;
$this->targetDBTObject = &$targetDBTObject;
$this->targetPrimaryEntityKey = $targetPrimaryEntityKey;
$this->targetSecondaryEntityKey = $targetSecondaryEntityKey;
$this->primaryEntityWhereClause = $primaryEntityWhereClause;
$this->leftSelectSize = $leftSelectSize;
$this->rightSelectSize = $rightSelectSize;
$this->moveToRightButtonLabel = $moveToRightButtonLabel;
$this->moveToLeftButtonLabel = $moveToLeftButtonLabel;
$this->serializedStandardValue = $serializedStandardValue;
}
/**
* Sets the size of the select appering on the left side.
*
* @version 1.0
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param string $int
* @return void
*/
function setLeftSelectSize( $int )
{ $this->leftSelectSize = $int; }
/**
* Sets the size of the select appering on the right side.
*
* @version 1.0
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param string $int
* @return void
*/
function setRightSelectSize( $int )
{ $this->rightSelectSize = $int; }
/**
* Sets the styleclass of the select appering on the left side.
*
* @version 1.0
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param string $string
* @return void
*/
function setLeftSelectStyle( $string )
{ $this->leftSelectStyle = $string; }
/**
* Sets the styleclass of the select appering on the right side.
*
* @version 1.0
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param string $string
* @return void
*/
function setRightSelectStyle( $string )
{ $this->rightSelectStyle = $string; }
/**
* Sets the styleclass of the button thats function is to move the items from
* the select on the left side to the select on the right side.
*
* @version 1.0
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param string $string
* @return void
*/
function setMoveToRightButtonStyle( $string )
{ $this->moveToRightButtonStyle = $string; }
/**
* Sets the styleclass of the button thats function is to move the items from
* the select on the right side to the select on the left side.
*
* @version 1.0
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param string $string
* @return void
*/
function setMoveToLeftButtonStyle( $string )
{ $this->moveToLeftButtonStyle = $string; }
/**
* Sets the styleclass of the select appering on the top of the select on the
* right side.
*
* @version 1.0
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param string $string
* @return void
*/
function setPrimaryEntitySelectStyle( $string )
{ $this->primaryEntitySelectStyle = $string; }
/**
* Somtimes it can be usefule to filter the achievement from the Target
* database table.
*
* @version 1.0
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param string $string
* @return void
*/
function setWhereClauseOfTargetDBT( $string )
{ $this->targetDBTWhereClause = $string; }
/**
* Somtimes it can be usefule to filter the achievement from the secondary
* entity database table.
*
* @version 1.01
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param string $string
* @return void
*/
function setWhereClauseOfsecondaryEntityDBT( $string )
{ $this->secondaryEntityWhereClause = $string; }
/**
* Somtimes it can be usefule to filter the achievement from the Target
* database table.
*
* @version 1.0
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param string $string
* @return void
*/
function setNameOfForm( $string )
{ $this->form_name = $string; }
/**
* This is for example to add a filter select for the target database table to
* the top of this select. Then you will be able to align it flush with the
* right side of this select.
*
* @version 1.0
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param string $string
* @return void
*/
function setLayoutTableHead( $string )
{ $this->layout_table_head = $string; }
/**
* Returns a generated string based on the attributes of this object.
*
* @version 1.41
* @since 0.1.0
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @return string
*/
function get()
{
static $JSoutput = 0;
if( $JSoutput < 1 )
{
$GLOBALS["javascript_content"][] = HTMLSelect::getJS2moveItem( false );
$GLOBALS["javascript_content"][] = HTMLSelect::getJS2getAllValuesFrom( false );
$GLOBALS["javascript_content"][] = JavaScript::getSerialize( false );
$JSoutput++;
}
$tmpArr = $this->targetDBTObject->getDatasetsWithFields(
array( $this->targetSecondaryEntityKey ),
$this->targetPrimaryEntityKey." = "
."'".$this->primaryEntitySelectedValue."'"
.(
!empty( $this->targetDBTWhereClause )
? "AND ( ".$this->targetDBTWhereClause." )"
: ""
)
);
$movedArr = Arrays::getIndexAsArray(
$this->targetSecondaryEntityKey, $tmpArr
);
if ( !empty( $this->serializedStandardValue ) )
$movedArr = unserialize( $this->serializedStandardValue );
$where_list = "";
if ( is_array( $movedArr ) )
$where_list = implode( "', '", $movedArr );
$tmpLeftSelect = new DBKeySelect(
$this->name."leftMultiSelect", "",
$this->secondaryEntityDBTObject,
$this->secondaryEntityLabelFieldArr,
$this->secondaryEntityPrimaryKey,
$this->secondaryEntityPrimaryKey." NOT IN "
."( '".$where_list."' )"
.(
!empty( $this->secondaryEntityWhereClause )
? " AND ".$this->secondaryEntityWhereClause
: ""
)
);
$tmpLeftSelect->do_not_disable = true;
$tmpLeftSelect->setSize( $this->leftSelectSize );
$tmpLeftSelect->showStandardLabel( false );
$tmpLeftSelect->setMultiple();
$tmpLeftSelect->setStyle( "leftSelectStyle" );
$tmpLeftSelect->showAltoughOnZeroLabelCount();
$tmpRightSelect =& new DBKeySelect(
$this->name."rightMultiSelect", "",
$this->secondaryEntityDBTObject,
$this->secondaryEntityLabelFieldArr,
$this->secondaryEntityPrimaryKey,
$this->secondaryEntityPrimaryKey." IN "
."( '".$where_list."' )"
.(
!empty( $this->secondaryEntityWhereClause )
? " AND ".$this->secondaryEntityWhereClause
: ""
)
);
$tmpRightSelect->do_not_disable = true;
$tmpRightSelect->setSize( $this->rightSelectSize );
$tmpRightSelect->showStandardLabel( false );
$tmpRightSelect->setMultiple();
$tmpRightSelect->setStyle( "rightSelectStyle" );
$tmpRightSelect->showAltoughOnZeroLabelCount();
if( empty( $primaryEntitySelectedValue ) )
$primaryEntitySelectedValue = $_REQUEST["PrimarySelect"];
$tmpPrimaryEntitySelect = new DBKeySelect(
$this->name."PrimarySelect",
$this->primaryEntitySelectedValue,
$this->primaryEntityDBTObject,
$this->primaryEntityLabelFieldArr,
$this->primaryEntityPrimaryKey,
$this->primaryEntityWhereClause,
$this->primarySelectChangeOrder /* todo */
);
$tmpPrimaryEntitySelect->setStyle( "primaryEntitySelectStyle" );
$tmpHiddenValueInput =& new HTMLHiddenInput(
$this->name."_serialized_arr",
str_replace(
"\"", """,
serialize( $tmpRightSelect->getValueArr() )
)
);
$tmpMoveToLeftButton =& new HTMLButton(
"movingToLeftButton",
$this->moveToLeftButtonLabel
);
$tmpMoveToLeftButton->setStyle( "moveToRightButtonStyle" );
$tmpMoveToRightButton =& new HTMLButton(
"movingToRightButton",
$this->moveToRightButtonLabel
);
$tmpMoveToRightButton->setStyle( "moveToLeftButtonStyle" );
$tmp_add_hidden_item = false;
if(
!function_exists( "is_a" )
&& (
get_class( $this->parentform ) == "htmlform"
|| get_parent_class( $this->parentform ) == "htmlform"
)
)
{
$this->parentform->addHiddenFormItem( $tmpHiddenValueInput );
$tmp_parent_form_name = $this->parentform->name;
}
else
if(
function_exists( "is_a" )
&& (
is_a( $this->parentform, "HTMLForm" )
|| is_subclass_of( $this->parentform, "HTMLForm" )
)
)
{
$this->parentform->addHiddenFormItem( $tmpHiddenValueInput );
$tmp_parent_form_name = $this->parentform->name;
}
else
{
$tmp_add_hidden_item = true;
$tmp_parent_form_name = $this->form_name;
}
$tmpMoveToLeftButton->setOnMouseUp(
"window.moveItemTo( "
."document."
.$tmp_parent_form_name."."
.$this->name."rightMultiSelect, "
."document."
.$tmp_parent_form_name."."
.$this->name."leftMultiSelect "
.");"
."document.".$tmp_parent_form_name."."
.$this->name."_serialized_arr.value "
."= php_serialize( "
."getAllValuesFrom( document."
.$tmp_parent_form_name."."
.$tmpRightSelect->name." "
.") "
.");"
);
$tmpMoveToRightButton->setOnMouseUp(
"window.moveItemTo( "
."document."
.$tmp_parent_form_name."."
.$this->name."leftMultiSelect, "
."document."
.$tmp_parent_form_name."."
.$this->name."rightMultiSelect "
.");"
."document.".$tmp_parent_form_name."."
.$this->name."_serialized_arr.value "
."= php_serialize( "
."getAllValuesFrom( document."
.$tmp_parent_form_name."."
.$tmpRightSelect->name." "
.") "
.");"
);
$rows = "";
$width = "";
$height = "";
$cellWidthArr = "";
$cellHeightArr = "";
$tbl =& new HTMLTable(
3, $rows, $width, $height,
$cellWidthArr, $cellHeightArr,
$cellpadding = 0, $cellspacing = 0,
$border = 0, $style = "MultiRelationSelect",
$noformat = false
);
if( !empty( $this->layout_table_head ) )
{
$tbl->addCol(
$this->layout_table_head,
"MultiRelationSelectHead", 3
);
}
if( count( $tmpPrimaryEntitySelect->ValueArr ) > 1 )
{
$tbl->addCol( "", "", 2 );
$tbl->addCol(
$tmpPrimaryEntitySelect->get(),
"MultiRelationSelectPE"
);
}
# Select-Left
$tbl->addCol(
$tmpLeftSelect->get(),
"MultiRelationSelectSL"
);
# Buttons
$tbl->addCol(
$tmpMoveToRightButton->get()."\r\n"
."<br><br>\r\n"
.$tmpMoveToLeftButton->get()."\r\n"
.(
$tmp_add_hidden_item
? $tmpHiddenValueInput->get()
: ""
),
"MultiRelationSelectBT"
);
# Select-Right
$tbl->addCol(
$tmpRightSelect->get(),
"MultiRelationSelectSR"
);
return $tbl->get();
}
} // End of class MultiRelationSelect
?>

Source for file MultiRelationSelect.class.php