/**
* Load a single DatagridColumnPreference object,
* by DatagridId, DatagridColumnId, UserAccountId Index(es)
* @param integer $intDatagridId
* @param integer $intDatagridColumnId
* @param integer $intUserAccountId
* @return DatagridColumnPreference
*/
public static function LoadByDatagridShortDescriptionColumnNameUserAccountId($strDatagridShortDescription, $strColumnName, $intUserAccountId)
{
$objDatagrid = Datagrid::LoadByShortDescription($strDatagridShortDescription);
if ($objDatagrid) {
return DatagridColumnPreference::LoadByDatagridIdColumnNameUserAccountId($objDatagrid->DatagridId, $strColumnName, $intUserAccountId);
} else {
throw new Exception(sprintf('The datagrid %s is not represented in the datagrid table in the database', $strDatagridShortDescription));
}
}
protected function SetupDatagridColumnPreference()
{
// Lookup Object PK information from Query String (if applicable)
// Set mode to Edit or New depending on what's found
$intDatagridColumnPreferenceId = QApplication::QueryString('intDatagridColumnPreferenceId');
if ($intDatagridColumnPreferenceId) {
$this->objDatagridColumnPreference = DatagridColumnPreference::Load($intDatagridColumnPreferenceId);
if (!$this->objDatagridColumnPreference) {
throw new Exception('Could not find a DatagridColumnPreference object with PK arguments: ' . $intDatagridColumnPreferenceId);
}
$this->strTitleVerb = QApplication::Translate('Edit');
$this->blnEditMode = true;
} else {
$this->objDatagridColumnPreference = new DatagridColumnPreference();
$this->strTitleVerb = QApplication::Translate('Create');
$this->blnEditMode = false;
}
}
protected function GetControlHtml()
{
$strToReturn = '';
$this->DataBind();
// Table Tag
$strStyle = $this->GetStyleAttributes();
if ($strStyle) {
$strStyle = sprintf('style="%s" ', $strStyle);
}
$strToReturn .= sprintf('<table %s%s>', $this->GetAttributes(), $strStyle);
if ($this->objColumnArray) {
foreach ($this->objColumnArray as $objColumn) {
if ($this->ShowColumnToggle && $objColumn instanceof QDataGridColumnExt) {
// Check if this user has a display preference for this particular column
if ($objDatagridColumnPreference = DatagridColumnPreference::LoadByDatagridShortDescriptionColumnNameUserAccountId($this->Name, $objColumn->Name, QApplication::$objUserAccount->UserAccountId)) {
// Set the columns display attribute only if this user has a display preference set for this column
$objColumn->Display = $objDatagridColumnPreference->DisplayFlag;
}
}
}
}
// Paginator Row (if applicable)
if ($this->objPaginator) {
$strToReturn .= $this->GetPaginatorRowHtml($this->objPaginator);
}
// Header Row (if applicable)
if ($this->blnShowHeader) {
$strToReturn .= $this->GetHeaderRowHtml();
}
// DataGrid Rows
$this->intCurrentRowIndex = 0;
if ($this->objDataSource) {
foreach ($this->objDataSource as $objObject) {
$strToReturn .= $this->GetDataGridRowHtml($objObject);
}
}
// Footer Row (if applicable)
if ($this->blnShowFooter) {
$strToReturn .= $this->GetFooterRowHtml();
}
// Finish Up
$strToReturn .= '</table>';
// Render the ColumnToggleMenu
if ($this->blnShowColumnToggle || $this->ShowExportCsv) {
$strToReturn .= $this->objColumnToggle->Render(false);
}
$this->objDataSource = null;
return $strToReturn;
}
public static function GetSoapArrayFromArray($objArray)
{
if (!$objArray) {
return null;
}
$objArrayToReturn = array();
foreach ($objArray as $objObject) {
array_push($objArrayToReturn, DatagridColumnPreference::GetSoapObjectFromObject($objObject, true));
}
return unserialize(serialize($objArrayToReturn));
}
protected function dtgDatagridColumnPreference_Bind()
{
// Because we want to enable pagination AND sorting, we need to setup the $objClauses array to send to LoadAll()
// Remember! We need to first set the TotalItemCount, which will affect the calcuation of LimitClause below
$this->dtgDatagridColumnPreference->TotalItemCount = DatagridColumnPreference::CountAll();
// Setup the $objClauses Array
$objClauses = array();
// If a column is selected to be sorted, and if that column has a OrderByClause set on it, then let's add
// the OrderByClause to the $objClauses array
if ($objClause = $this->dtgDatagridColumnPreference->OrderByClause) {
array_push($objClauses, $objClause);
}
// Add the LimitClause information, as well
if ($objClause = $this->dtgDatagridColumnPreference->LimitClause) {
array_push($objClauses, $objClause);
}
// Set the DataSource to be the array of all DatagridColumnPreference objects, given the clauses above
$this->dtgDatagridColumnPreference->DataSource = DatagridColumnPreference::LoadAll($objClauses);
}
/**
* Deletes all associated DatagridColumnPreferences
* @return void
*/
public function DeleteAllDatagridColumnPreferences()
{
if (is_null($this->intDatagridId)) {
throw new QUndefinedPrimaryKeyException('Unable to call UnassociateDatagridColumnPreference on this unsaved Datagrid.');
}
// Get the Database Object for this Class
$objDatabase = Datagrid::GetDatabase();
// Journaling
if ($objDatabase->JournalingDatabase) {
foreach (DatagridColumnPreference::LoadArrayByDatagridId($this->intDatagridId) as $objDatagridColumnPreference) {
$objDatagridColumnPreference->Journal('DELETE');
}
}
// Perform the SQL Query
$objDatabase->NonQuery('
DELETE FROM
`datagrid_column_preference`
WHERE
`datagrid_id` = ' . $objDatabase->SqlVariable($this->intDatagridId) . '
');
}
/**
* Static Helper Method to Create using PK arguments
* You must pass in the PK arguments on an object to load, or leave it blank to create a new one.
* If you want to load via QueryString or PathInfo, use the CreateFromQueryString or CreateFromPathInfo
* static helper methods. Finally, specify a CreateType to define whether or not we are only allowed to
* edit, or if we are also allowed to create a new one, etc.
*
* @param mixed $objParentObject QForm or QPanel which will be using this DatagridColumnPreferenceMetaControl
* @param integer $intDatagridColumnPreferenceId primary key value
* @param QMetaControlCreateType $intCreateType rules governing DatagridColumnPreference object creation - defaults to CreateOrEdit
* @return DatagridColumnPreferenceMetaControl
*/
public static function Create($objParentObject, $intDatagridColumnPreferenceId = null, $intCreateType = QMetaControlCreateType::CreateOrEdit)
{
// Attempt to Load from PK Arguments
if (strlen($intDatagridColumnPreferenceId)) {
$objDatagridColumnPreference = DatagridColumnPreference::Load($intDatagridColumnPreferenceId);
// DatagridColumnPreference was found -- return it!
if ($objDatagridColumnPreference) {
return new DatagridColumnPreferenceMetaControl($objParentObject, $objDatagridColumnPreference);
} else {
if ($intCreateType != QMetaControlCreateType::CreateOnRecordNotFound) {
throw new QCallerException('Could not find a DatagridColumnPreference object with PK arguments: ' . $intDatagridColumnPreferenceId);
}
}
// If EditOnly is specified, throw an exception
} else {
if ($intCreateType == QMetaControlCreateType::EditOnly) {
throw new QCallerException('No PK arguments specified');
}
}
// If we are here, then we need to create a new record
return new DatagridColumnPreferenceMetaControl($objParentObject, new DatagridColumnPreference());
}
/**
* Main utility method to aid with data binding. It is used by the default BindAllRows() databinder but
* could and should be used by any custom databind methods that would be used for instances of this
* MetaDataGrid, by simply passing in a custom QQCondition and/or QQClause.
*
* If a paginator is set on this DataBinder, it will use it. If not, then no pagination will be used.
* It will also perform any sorting (if applicable).
*
* @param QQCondition $objConditions override the default condition of QQ::All() to the query, itself
* @param QQClause[] $objOptionalClauses additional optional QQClause object or array of QQClause objects for the query
* @return void
*/
public function MetaDataBinder(QQCondition $objCondition = null, $objOptionalClauses = null)
{
// Setup input parameters to default values if none passed in
if (!$objCondition) {
$objCondition = QQ::All();
}
$objClauses = $objOptionalClauses ? $objOptionalClauses : array();
// We need to first set the TotalItemCount, which will affect the calcuation of LimitClause below
if ($this->Paginator) {
$this->TotalItemCount = DatagridColumnPreference::QueryCount($objCondition, $objClauses);
}
// If a column is selected to be sorted, and if that column has a OrderByClause set on it, then let's add
// the OrderByClause to the $objClauses array
if ($objClause = $this->OrderByClause) {
array_push($objClauses, $objClause);
}
// Add the LimitClause information, as well
if ($objClause = $this->LimitClause) {
array_push($objClauses, $objClause);
}
// Set the DataSource to be a Query result from DatagridColumnPreference, given the clauses above
$this->DataSource = DatagridColumnPreference::QueryArray($objCondition, $objClauses);
}
public function SaveDisplayPreference($strDatagridName)
{
$objDatagridColumnPreference = DatagridColumnPreference::LoadByDatagridShortDescriptionColumnNameUserAccountId($strDatagridName, $this->Name, QApplication::$objUserAccount->UserAccountId);
if (!$objDatagridColumnPreference) {
$objDatagridColumnPreference = new DatagridColumnPreference();
$objDatagrid = Datagrid::LoadByShortDescription($strDatagridName);
if ($objDatagrid) {
$objDatagridColumnPreference->DatagridId = $objDatagrid->DatagridId;
} else {
throw new Exception(sprintf("The datagrid %s is not represented in the database", $strDatagridName));
}
$objDatagridColumnPreference->ColumnName = $this->Name;
$objDatagridColumnPreference->UserAccountId = QApplication::$objUserAccount->UserAccountId;
}
$objDatagridColumnPreference->DisplayFlag = $this->Display;
$objDatagridColumnPreference->Save();
}
/**
* Load a single DatagridColumnPreference object,
* by DatagridId, DatagridColumnId, UserAccountId Index(es)
* @param integer $intDatagridId
* @param integer $intDatagridColumnId
* @param integer $intUserAccountId
* @return DatagridColumnPreference
*/
public static function LoadByDatagridShortDescriptionColumnNameUserAccountId($strDatagridShortDescription, $strColumnName, $intUserAccountId)
{
return DatagridColumnPreference::QuerySingle(QQ::AndCondition(QQ::Equal(QQN::DatagridColumnPreference()->Datagrid->ShortDescription, $strDatagridShortDescription), QQ::Equal(QQN::DatagridColumnPreference()->ColumnName, $strColumnName), QQ::Equal(QQN::DatagridColumnPreference()->UserAccountId, $intUserAccountId)));
}
public function dtgDatagridColumnPreference_Bind()
{
// Get Total Count b/c of Pagination
$this->dtgDatagridColumnPreference->TotalItemCount = DatagridColumnPreference::CountAll();
$objClauses = array();
if ($objClause = $this->dtgDatagridColumnPreference->OrderByClause) {
array_push($objClauses, $objClause);
}
if ($objClause = $this->dtgDatagridColumnPreference->LimitClause) {
array_push($objClauses, $objClause);
}
$this->dtgDatagridColumnPreference->DataSource = DatagridColumnPreference::LoadAll($objClauses);
}
/**
* Counts all associated DatagridColumnPreferences
* @return int
*/
public function CountDatagridColumnPreferences()
{
if (is_null($this->intUserAccountId)) {
return 0;
}
return DatagridColumnPreference::CountByUserAccountId($this->intUserAccountId);
}
