DIR : /home/kozerus/public_html/dgs/include/db/survey_option.php

/home/kozerus/public_html/dgs/include/db

<?php
/*
Dragon Go Server
Copyright (C) 2001-  Erik Ouchterlony, Jens-Uwe Gaspar

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.

This program 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 Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

 /* Author: Jens-Uwe Gaspar */

require_once 'include/globals.php';
require_once 'include/db_classes.php';
require_once 'include/std_classes.php';

 /*!
  * \file survey_option.php
  *
  * \brief Functions for managing survey-options: tables SurveyOption
  * \see specs/db/table-Voting.txt
  */


 /*!
  * \class SurveyOption
  *
  * \brief Class to manage SurveyOption-table
  */

global $ENTITY_SURVEY_OPTION; //PHP5
$ENTITY_SURVEY_OPTION = new Entity( 'SurveyOption',
      FTYPE_PKEY, 'ID',
      FTYPE_AUTO, 'ID',
      FTYPE_INT,  'ID', 'sid', 'Tag', 'SortOrder', 'MinPoints', 'Score',
      FTYPE_TEXT, 'Title', 'Text'
   );

class SurveyOption
{
   public $ID;
   public $sid; // survey-id
   public $Tag;
   public $SortOrder;
   public $MinPoints;
   public $Score;
   public $Title;
   public $Text;

   // non-DB fields

   public $UserVotePoints = null; // SurveyVote.Points of specific user; null=unset

   /*! \brief Constructs SurveyOption-object with specified arguments. */
   public function __construct( $id=0, $sid=0, $tag=0, $sort_order=0, $min_points=0, $score=0, $title='', $text='' )
   {
      $this->ID = (int)$id;
      $this->sid = (int)$sid;
      $this->Tag = (int)$tag;
      $this->SortOrder = (int)$sort_order;
      $this->MinPoints = (int)$min_points;
      $this->Score = (int)$score;
      $this->Title = $title;
      $this->Text = $text;
   }

   public function to_string()
   {
      return print_r($this, true);
   }

   /*! \brief Inserts or updates SurveyOption-entry in database. */
   public function persist()
   {
      if ( $this->ID > 0 )
         $success = $this->update();
      else
         $success = $this->insert();
      return $success;
   }

   public function insert()
   {
      $entityData = $this->fillEntityData();
      $result = $entityData->insert( "SurveyOption.insert(%s)" );
      if ( $result )
         $this->ID = mysql_insert_id();
      return $result;
   }

   public function update()
   {
      $entityData = $this->fillEntityData();
      return $entityData->update( "SurveyOption.update(%s)" );
   }

   public function fillEntityData( EntityData $data = null )
   {
      if ( is_null($data) )
         $data = $GLOBALS['ENTITY_SURVEY_OPTION']->newEntityData();
      $data->set_value( 'ID', $this->ID );
      $data->set_value( 'sid', $this->sid );
      $data->set_value( 'Tag', $this->Tag );
      $data->set_value( 'SortOrder', $this->SortOrder );
      $data->set_value( 'MinPoints', $this->MinPoints );
      $data->set_value( 'Score', $this->Score );
      $data->set_value( 'Title', $this->Title );
      $data->set_value( 'Text', $this->Text );
      return $data;
   }

   /*!
    * \brief Copies (if $check=false) or checks non-primary-key-like & non-aggregated fields
    *        from given SurveyOption-object to this object.
    * \param $check if true, ONLY check (without copy) if values-to-copy has diff; false = no check
    * \return return true if $check=false, otherwise: return true (need copy) if there is a diff, false otherwise
    */
   public function copyValues( SurveyOption $sopt, $check=false )
   {
      // NOTE: no checking/cloning of fields: ID, sid, Tag; no check on Score (=aggregated-field)
      if ( $check )
      {
         if ( $this->SortOrder != (int)$sopt->SortOrder )
            return true;
         if ( $this->MinPoints != (int)$sopt->MinPoints )
            return true;
         if ( strcmp($this->Title, $sopt->Title) != 0 )
            return true;
         if ( strcmp($this->Text, $sopt->Text) != 0 )
            return true;
         return false; // no diff, no copy/update needed
      }

      $this->SortOrder = (int)$sopt->SortOrder;
      $this->MinPoints = (int)$sopt->MinPoints;
      //$this->Score = (int)$sopt->Score; // no copy of aggregrated-field
      $this->Title = $sopt->Title;
      $this->Text = $sopt->Text;
      return true;
   }//copyValues

   public function buildLabel()
   {
      // CSS-counters not widely supported, so use manual labels
      return chr( ord('A') + $this->SortOrder - 1 ) . '.';
   }


   // ------------ static functions ----------------------------

   /*! \brief Returns db-fields to be used for query of SurveyOption-objects for given survey-id and survey-option-id. */
   public static function build_query_sql( $sid, $sopt_id=0, $with_sort=false )
   {
      $qsql = $GLOBALS['ENTITY_SURVEY_OPTION']->newQuerySQL('SOPT');
      if ( $sid > 0 )
         $qsql->add_part( SQLP_WHERE, "SOPT.sid=$sid" );
      if ( $sopt_id > 0 )
         $qsql->add_part( SQLP_WHERE, "SOPT.ID=$sopt_id" );
      if ( $with_sort )
         $qsql->add_part( SQLP_ORDER, 'SOPT.SortOrder ASC' );
      return $qsql;
   }

   /*! \brief Returns SurveyOption-object created from specified (db-)row. */
   public static function new_from_row( array $row )
   {
      $s_opt = new SurveyOption(
            // from SurveyOption
            @$row['ID'],
            @$row['sid'],
            @$row['Tag'],
            @$row['SortOrder'],
            @$row['MinPoints'],
            @$row['Score'],
            @$row['Title'],
            @$row['Text']
         );
      return $s_opt;
   }

   /*! \brief Clone all fields from given SurveyOption-object to this object. */
   public static function cloneSurveyOption( SurveyOption $sopt )
   {
      return new SurveyOption( $sopt->ID, $sopt->sid, $sopt->Tag, $sopt->SortOrder, $sopt->MinPoints,
         $sopt->Score, $sopt->Title, $sopt->Text );
   }

   /*!
    * \brief Loads and returns SurveyOption-object for given survey_option-id limited to 1 result-entry.
    * \param $sopt_id SurveyOption.ID
    * \return NULL if nothing found; SurveyOption-object otherwise
    */
   public static function load_survey_option( $sopt_id )
   {
      if ( !is_numeric($sopt_id) || $sopt_id <= 0 )
         error('invalid_args', "SurveyOption:load_survey_option($sopt_id)");

      $qsql = self::build_query_sql( 0, $sopt_id );
      $qsql->add_part( SQLP_LIMIT, '1' );

      $row = mysql_single_fetch( "SurveyOption:load_survey_option.find_surveyoption($sopt_id)", $qsql->get_select() );
      return ($row) ? self::new_from_row($row) : NULL;
   }//load_survey_option

   /*! \brief Returns enhanced (passed) ListIterator with SurveyOption-objects. */
   public static function load_survey_options( ListIterator $iterator, $sid, $with_sort=true )
   {
      $qsql = self::build_query_sql( $sid, 0, $with_sort );
      $iterator->setQuerySQL( $qsql );
      $query = $iterator->buildQuery();
      $result = db_query( "SurveyOption:load_survey_options", $query );
      $iterator->setResultRows( mysql_num_rows($result) );

      $iterator->clearItems();
      while ( $row = mysql_fetch_array( $result ) )
      {
         $s_opt = self::new_from_row( $row );
         $iterator->addItem( $s_opt, $row );
      }
      mysql_free_result($result);

      return $iterator;
   }//load_survey_options

   public static function persist_survey_options( $sid, array &$arr_sopts, $all_fields=true )
   {
      if ( count($arr_sopts) == 0 )
         return false;

      $skip_fields = ($all_fields) ? null : array( 'Score' );

      $entity_sopt = $GLOBALS['ENTITY_SURVEY_OPTION']->newEntityData();
      $arr_inserts = array();
      foreach ( $arr_sopts as $so )
      {
         if ( $so->sid == 0 )
            $so->sid = $sid;
         $data_sopt = $so->fillEntityData( $entity_sopt );
         $arr_inserts[] = $data_sopt->build_sql_insert_values(false, /*with-PK*/true, $skip_fields);
      }

      $query = $entity_sopt->build_sql_insert_values(true, /*with-PK*/true, $skip_fields)
         . implode(',', $arr_inserts)
         . ' ON DUPLICATE KEY UPDATE '
         . 'sid=VALUES(sid), Tag=VALUES(Tag), SortOrder=VALUES(SortOrder), MinPoints=VALUES(MinPoints), '
         . 'Score=VALUES(Score), Title=VALUES(Title), Text=VALUES(Text)';

      return db_query( "SurveyOption:persist_survey_options.on_dupl_key($sid)", $query );
   }//persist_survey_options

   /*! \brief Updates SurveyOption-entries with $arr_upd = [ ID => diff_score, ... ]. */
   public static function update_aggregates_survey_options( $sid, array $arr_upd )
   {
      if ( count($arr_upd) == 0 )
         return false;

      $sid = (int)$sid;

      $arr_inserts = array();
      foreach ( $arr_upd as $id => $diff_score )
      {
         if ( $diff_score && is_numeric($diff_score) )
            $arr_inserts[] = "($id,$diff_score)";
      }

      if ( count($arr_inserts) > 0 )
      {
         $query = "INSERT INTO SurveyOption (ID,Score) VALUES " . implode(', ', $arr_inserts)
            . " ON DUPLICATE KEY UPDATE Score=Score+(VALUES(Score))";

         return db_query( "SurveyOption:update_aggregates_survey_options.on_dupl_key($sid)", $query );
      }
      else
         return true;
   }//update_aggregates_survey_options

   public static function delete_survey_options( $sid, array $arr_sopts_id )
   {
      if ( count($arr_sopts_id) == 0 )
         return false;

      // check ids to delete
      $ids = array();
      foreach ( $arr_sopts_id as $sopt_id )
      {
         if ( !is_numeric($sopt_id) || $sopt_id <= 0 )
            error('invalid_args', "SurveyOption:delete_survey_options.check.id($sid,$sopt_id)");
         $ids[] = (int)$sopt_id;
      }
      $cnt_ids = count($ids);
      $ids = implode(',', $ids);
      $sid = (int)$sid;

      $result = db_query( "SurveyOption:delete_survey_options.del($sid;$ids)",
         "DELETE FROM SurveyOption WHERE ID IN ($ids) AND sid=$sid LIMIT $cnt_ids" );
      return $result;
   }//delete_survey_options

} // end of 'SurveyOption'
?>