paging.php

Go to the documentation of this file.

<?php

      /*
      *     This source code is a part of the Ultimix Project. 
      *     It is distributed under BSD license. All other third side source code (like tinyMCE) is distributed under 
      *     it's own license wich could be found from the corresponding files or sources. 
      *     This source code is provided "as is" without any warranties or garanties.
      *
      *     Have a nice day!
      *
      *     @url http://ultimix.sorceforge.net
      *
      *     @author Alexey "gdever" Dodonov
      */
      
      class paging_1_0_0{

            var                           $Header = '';
            
            var                           $Footer = '';
            
            var                           $CallbackFunc = false;
            
            var                           $FormId = false;
            
            var                           $ItemTemplate = '';
            
            var                           $DataAccessor = false;
            
            var                           $Page = 0;
            
            var                           $PageField = 'page';
            
            var                           $RecordsPerPage = 20;
            
            var                           $Prefix = 'default';
            
            var                           $CustomButtons = '';
            
            var                           $Ajaxed = false;
            
            var                           $FormRequired = true;
            
            var                           $NoDataFoundMessage;
            
            var                           $GridId = false;
            
            var                           $CachedMultyFS = false;
            var                           $PagingMarkup = false;
            var                           $Security = false;
            var                           $Settings = false;
            var                           $String = false;
            var                           $Utilities = false;
            
            private function  load_scripts()
            {
                  try
                  {
                        $Path = _get_package_relative_path_ex( 'gui::paging' , '1.0.0' );
                        $PageJS = get_package( 'page::page_js' , 'last' , __FILE__ );
                        $PageJS->add_javascript( "{http_host}/$Path/include/js/paging.js" );

                        $this->NoDataFoundMessage = $this->CachedMultyFS->get_template( 
                              __FILE__ , 'data_for_grid_was_not_found.tpl'
                        );

                        $this->CallbackFunc = create_function( 
                              '$Template , $Record', 
                              '$String = get_package( "string" , "last" , __FILE__ );'.
                                    'return( $String->print_record( $Template , $Record ) );'
                        );
                  }
                  catch( Exception $e )
                  {
                        $a = func_get_args();_throw_exception_object( __METHOD__ , $a , $e );
                  }
            }

            function                __construct()
            {
                  try
                  {
                        $this->CachedMultyFS = get_package( 'cached_multy_fs' , 'last' , __FILE__ );
                        $this->PagingMarkup = get_package( 'gui::paging::paging_markup' , 'last' , __FILE__ );
                        $this->Security = get_package( 'security' , 'last' , __FILE__ );
                        $this->Settings = get_package_object( 'settings::settings' , 'last' , __FILE__ );
                        $this->String = get_package( 'string' , 'last' , __FILE__ );
                        $this->Utilities = get_package( 'utilities' , 'last' , __FILE__ );

                        $this->load_scripts();
                  }
                  catch( Exception $e )
                  {
                        $a = func_get_args();_throw_exception_object( __METHOD__ , $a , $e );
                  }
            }

            function                set( $FieldName , $FieldValue )
            {
                  $this->$FieldName = $FieldValue;
            }

            private function  compile_hidden_fields()
            {
                  try
                  {
                        if( $this->Security->get_gp( 'add_hidden_fields' , 'integer' , 1 ) )
                        {
                              $Code = '<input type="hidden" name="ajaxed" value="'.( $this->Ajaxed ? 1 : 0 ).'">
                              <!--input type="hidden" name="page" value="'.$this->Page.'"-->
                              <input type="hidden" id="reorder_field" class="reorder_field" name="reorder_field" value="{field}">
                              <input type="hidden" id="order" class="order" name="order" value="{order}">'.$this->CustomButtons;

                              return( $Code );
                        }
                        return( '' );
                  }
                  catch( Exception $e )
                  {
                        $a = func_get_args();_throw_exception_object( __METHOD__ , $a , $e );
                  }
            }
            
            function                compile_header()
            {
                  try
                  {
                        $this->FormRequired = $this->Security->get_gp( 'paging_require_form' , 'integer' , true );

                        $HiddenFields = $this->compile_hidden_fields();

                        $HiddenFields = $this->PagingMarkup->compile_sort_link( $this , $HiddenFields );

                        if( $this->FormRequired )
                        {
                              return( '<form id="'.$this->FormId.'" action="" method="post">'.$HiddenFields.$this->Header );
                        }
                        else
                        {
                              return( $HiddenFields.$this->Header );
                        }
                  }
                  catch( Exception $e )
                  {
                        $a = func_get_args();_throw_exception_object( __METHOD__ , $a , $e );
                  }
            }

            function                compile_footer()
            {
                  try
                  {
                        $this->Footer = str_replace( '{page_name}' , $this->PageField , $this->Footer );
                        $this->Footer = str_replace( '{records_per_page}' , $this->RecordsPerPage , $this->Footer );

                        if( $this->FormId !== false && $this->FormRequired )
                        {
                              return( $this->Footer.'</form>' );
                        }
                        else
                        {
                              return( $this->Footer );
                        }
                  }
                  catch( Exception $e )
                  {
                        $a = func_get_args();_throw_exception_object( __METHOD__ , $a , $e );
                  }
            }

            private function  compile_items( &$DataToDisplay )
            {
                  try
                  {
                        $RetView = '';
                        $c = count( $DataToDisplay );

                        for( $i = 0 ; $i < $c && $i < $this->RecordsPerPage ; $i++ )
                        {
                              $Tmp = $this->ItemTemplate;

                              $Tmp = call_user_func( $this->CallbackFunc , $Tmp , $DataToDisplay[ $i ] );
                              $Tmp = str_replace( '{odd_factor}' , ( $i % 2 === 0 ? 'even' : 'odd' ) , $Tmp );

                              $RetView .= $Tmp;
                        }

                        return( $RetView );
                  }
                  catch( Exception $e )
                  {
                        $a = func_get_args();_throw_exception_object( __METHOD__ , $a , $e );
                  }
            }
            
            private function  compile_macros( &$DataToDisplay )
            {
                  try
                  {
                        $RetView = $this->compile_items( $DataToDisplay );

                        $RetView = $this->compile_header().'{set_var:name='.$this->FormId.'_records_count;value='.
                                          count( $DataToDisplay ).'}'.$RetView.$this->compile_footer();

                        $RetView = $this->PagingMarkup->compile_left_slider( $this , $RetView );
                        $RetView = $this->PagingMarkup->compile_records_per_page_control( $this , $RetView );
                        $RetView = $this->PagingMarkup->compile_right_slider( $this , count( $DataToDisplay ) , $RetView );

                        return( str_replace( '{prefix}' , $this->Prefix , $RetView ) );
                  }
                  catch( Exception $e )
                  {
                        $a = func_get_args();_throw_exception_object( __METHOD__ , $a , $e );
                  }
            }
            
            private function  compile_no_data_to_display()
            {
                  try
                  {
                        $this->FormRequired = $this->FormId === false ? false : true;
                        $this->NoDataFoundMessage = str_replace( '{prefix}' , $this->Prefix , $this->NoDataFoundMessage );

                        if( $this->FormRequired )
                        {
                              return( 
                                    '{set_var:name='.$this->FormId.'_records_count;value=0}<form id="'.$this->FormId.
                                    '" action="" method="post">'.$this->CustomButtons.$this->NoDataFoundMessage.'</form>'
                              );
                        }
                        else
                        {
                              return( '{set_var:name='.$this->FormId.'_records_count;value=0}'.$this->NoDataFoundMessage );
                        }
                  }
                  catch( Exception $e )
                  {
                        $a = func_get_args();_throw_exception_object( __METHOD__ , $a , $e );
                  }
            }
            
            private function  get_data_to_display( &$Options )
            {
                  try
                  {
                        $ReorderField = $this->Security->get_gp( 'reorder_field' , 'command' , false );
                              $Order = $this->Security->get_gp( 'order' , 'command' , false );

                              if( strlen( $ReorderField ) == 0 )
                              {
                                    $ReorderField = false;
                              }
                              if( strlen( $Order ) == 0 )
                              {
                                    $Order = false;
                              }

                              $DataToDisplay = call_user_func( 
                                    $this->DataAccessor , ( $this->Page - 1 ) * $this->RecordsPerPage , 
                                    $this->RecordsPerPage + 1 , $ReorderField , $Order , $Options
                              );
                              
                              return( $DataToDisplay );
                  }
                  catch( Exception $e )
                  {
                        $a = func_get_args();_throw_exception_object( __METHOD__ , $a , $e );
                  }
            }
            
            private function  primary_init( &$Options )
            {
                  try
                  {
                        $this->GridId = md5( microtime( true ) );

                        $this->Page = $this->Security->get_gp( $this->PageField , 'integer' , 1 );

                        $this->RecordsPerPage = $Options->get_setting( 'records_per_page' , $this->RecordsPerPage );

                        $this->RecordsPerPage = $this->Security->get_c( 
                              $this->Prefix.'_records_per_page' , 'integer' , $this->RecordsPerPage
                        );
                  }
                  catch( Exception $e )
                  {
                        $a = func_get_args();_throw_exception_object( __METHOD__ , $a , $e );
                  }
            }
            
            function                draw( $DataToDisplay = false , $Options = false )
            {
                  try
                  {
                        $this->primary_init( $Options );

                        if( $DataToDisplay === false && $this->DataAccessor === false )
                        {
                              throw( new Exception( 'No data was specified' ) );
                        }
                        if( $this->DataAccessor )
                        {
                              $DataToDisplay = $this->get_data_to_display( $Options );
                        }

                        if( count( $DataToDisplay ) === 0 )
                        {
                              return( $this->compile_no_data_to_display() );
                        }

                        return( $this->compile_macros( $DataToDisplay ) );
                  }
                  catch( Exception $e )
                  {
                        $a = func_get_args();_throw_exception_object( __METHOD__ , $a , $e );
                  }
            }
      }
      
?>