settings.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 settings_1_0_0{

            var                           $SettingsList = false;

            var                           $CachedMultyFS = false;
            var                           $SettingsUtilities = false;

            function                __construct()
            {
                  try
                  {
                        $this->SettingsUtilities = get_package( 'settings::settings_utilities' , 'last' , __FILE__ );
                  }
                  catch( Exception $e )
                  {
                        $a = func_get_args();_throw_exception_object( __METHOD__ , $a , $e );
                  }
            }
            
            function                load_settings( $Settings , $Separator = ';' )
            {
                  try
                  {                       
                        $this->SettingsList = array();
                        $this->append_settings( $Settings , $Separator );
                  }
                  catch( Exception $e )
                  {
                        $a = func_get_args();_throw_exception_object( __METHOD__ , $a , $e );
                  }
            }

            function                delete_setting( $Name )
            {
                  try
                  {
                        if( isset( $this->SettingsList[ $Name ] ) === false )
                        {
                              return;
                        }

                        $New = array();
                        foreach( $this->SettingsList as $Key => $Value )
                        {
                              if( $Key !== $Name )
                              {
                                    $New[ $Key ] = $Value;
                              }
                        }
                        $this->SettingsList = $New;
                  }
                  catch( Exception $e )
                  {
                        $a = func_get_args();_throw_exception_object( __METHOD__ , $a , $e );
                  }
            }

            function                append_settings( $Settings , $Separator = ';' )
            {
                  try
                  {
                        if( $Settings === false || $Settings === '' || $Settings === null )
                        {
                              return;
                        }

                        if( is_array( $Settings ) === false )
                        {
                              $Settings = $this->SettingsUtilities->transform_settings( $Settings , $Separator );
                        }

                        $this->SettingsList = array_merge( 
                              $this->SettingsList , $this->SettingsUtilities->load_settings( $Settings )
                        );
                  }
                  catch( Exception $e )
                  {
                        $a = func_get_args();_throw_exception_object( __METHOD__ , $a , $e );
                  }
            }

            function                load_from_http()
            {
                  try
                  {
                        $this->SettingsList = array_merge( $_POST , $_GET );
                  }
                  catch( Exception $e )
                  {
                        $a = func_get_args();_throw_exception_object( __METHOD__ , $a , $e );
                  }
            }

            function                get_raw_settings()
            {
                  try
                  {
                        return( $this->SettingsList );
                  }
                  catch( Exception $e )
                  {
                        $a = func_get_args();_throw_exception_object( __METHOD__ , $a , $e );
                  }
            }

            function                add_settings_from_object( &$Settings )
            {
                  try
                  {
                        $this->SettingsList = array_merge( $this->SettingsList , $Settings->SettingsList );
                  }
                  catch( Exception $e )
                  {
                        $a = func_get_args();_throw_exception_object( __METHOD__ , $a , $e );
                  }
            }

            function                load_raw_settings( &$Settings )
            {
                  try
                  {
                        $this->SettingsList = $Settings;
                  }
                  catch( Exception $e )
                  {
                        $a = func_get_args();_throw_exception_object( __METHOD__ , $a , $e );
                  }
            }

            function                append_raw_settings( &$Settings )
            {
                  try
                  {
                        $this->SettingsList = array_merge( $this->SettingsList , $Settings );
                  }
                  catch( Exception $e )
                  {
                        $a = func_get_args();_throw_exception_object( __METHOD__ , $a , $e );
                  }
            }

            function                get_all_settings()
            {
                  try
                  {
                        $Str = array();

                        foreach( $this->SettingsList as $Key => $Value )
                        {
                              $Str [] = "$Key=$Value";
                        }

                        $Str = implode( ';' , $Str );

                        return( $Str );
                  }
                  catch( Exception $e )
                  {
                        $a = func_get_args();_throw_exception_object( __METHOD__ , $a , $e );
                  }
            }

            private function  get_config( $FilePath )
            {
                  try
                  {
                        if( $this->CachedMultyFS === false )
                        {
                              $this->CachedMultyFS = get_package( 'cached_multy_fs' , 'last' , __FILE__ );
                        }

                        return( $this->CachedMultyFS->file_get_contents( $FilePath ) );
                  }
                  catch( Exception $e )
                  {
                        $a = func_get_args();_throw_exception_object( __METHOD__ , $a , $e );
                  }
            }

            function                load_file( $FilePath , $Separator = ';' )
            {
                  try
                  {
                        $this->load_settings( $this->get_config( $FilePath ) , $Separator );
                  }
                  catch( Exception $e )
                  {
                        $a = func_get_args();_throw_exception_object( __METHOD__ , $a , $e );
                  }
            }

            function                append_file( $FilePath , $Separator = ';' )
            {
                  try
                  {
                        $this->append_settings( $this->get_config( $FilePath ) , $Separator );
                  }
                  catch( Exception $e )
                  {
                        $a = func_get_args();_throw_exception_object( __METHOD__ , $a , $e );
                  }
            }

            function                load_package_settings( $PackageName , $PackageVersion , $FileName )
            {
                  try
                  {
                        $PackageDirectory = _get_package_path_ex( $PackageName , $PackageVersion );

                        $this->load_file( $PackageDirectory."/conf/$FileName" );
                  }
                  catch( Exception $e )
                  {
                        $a = func_get_args();_throw_exception_object( __METHOD__ , $a , $e );
                  }
            }

            function                define( $Name , $DefaultValue = '_throw_exception' )
            {
                  try
                  {
                        DEFINE( $Name , $this->get_setting( $Name , $DefaultValue ) );
                  }
                  catch( Exception $e )
                  {
                        $a = func_get_args();_throw_exception_object( __METHOD__ , $a , $e );
                  }
            }

            function                setting_exists( $Name , $ThrowException = false )
            {
                  try
                  {
                        if( $this->SettingsList !== false && isset( $this->SettingsList[ $Name ] ) )
                        {
                              return( true );
                        }

                        if( $ThrowException )
                        {
                              throw( new Exception( "Setting \"$Name\" does not exist" ) );
                        }

                        return( false );
                  }
                  catch( Exception $e )
                  {
                        $a = func_get_args();_throw_exception_object( __METHOD__ , $a , $e );
                  }
            }

            function                get_setting( $Name , $DefaultValue = '_throw_exception' )
            {
                  try
                  {
                        if( $this->SettingsList !== false && isset( $this->SettingsList[ $Name ] ) )
                        {
                              return( $this->SettingsList[ $Name ] );
                        }
                        if( $DefaultValue === '_throw_exception' )
                        {
                              throw( new Exception( 'Setting "'.$Name.'" was not found' ) );
                        }

                        return( $DefaultValue );
                  }
                  catch( Exception $e )
                  {
                        $a = func_get_args();_throw_exception_object( __METHOD__ , $a , $e );
                  }
            }

            function                get_default_values( $SettingsNames , $DefaultValues )
            {
                  try
                  {
                        $DefaultValues = explode( ',' , $DefaultValues );

                        $c1 = count( $DefaultValues );
                        $c2 = count( $SettingsNames );

                        if( $c1 < $c2 )
                        {
                              for( $i = 0 ; $i < $c2 - $c1 ; $i++ )
                              {
                                    $DefaultValues [] = '_throw_exception';
                              }
                        }

                        return( $DefaultValues );
                  }
                  catch( Exception $e )
                  {
                        $a = func_get_args();_throw_exception_object( __METHOD__ , $a , $e );
                  }
            }

            function                get_settings( $SettingsNames , $DefaultValues = '_throw_exception' )
            {
                  try
                  {
                        $Values = array();
                        $SettingsNames = explode( ',' , $SettingsNames );

                        $DefaultValues = $this->get_default_values( $SettingsNames , $DefaultValues );

                        foreach( $SettingsNames as $i => $Name )
                        {
                              $Values [] = $this->get_setting( $Name , $DefaultValues[ $i ] );
                        }

                        return( $Values );
                  }
                  catch( Exception $e )
                  {
                        $a = func_get_args();_throw_exception_object( __METHOD__ , $a , $e );
                  }
            }

            function                set_setting( $Name , $Value )
            {
                  try
                  {
                        if( $this->SettingsList !== false )
                        {
                              $this->SettingsList[ $Name ] = $Value;
                        }
                  }
                  catch( Exception $e )
                  {
                        $a = func_get_args();_throw_exception_object( __METHOD__ , $a , $e );
                  }
            }

            function                set_undefined( $Name , $Value )
            {
                  try
                  {
                        if( $this->SettingsList !== false && isset( $this->SettingsList[ $Name ] ) === false )
                        {
                              $this->SettingsList[ $Name ] = $Value;
                        }
                  }
                  catch( Exception $e )
                  {
                        $a = func_get_args();_throw_exception_object( __METHOD__ , $a , $e );
                  }
            }

            function                clear()
            {
                  try
                  {
                        $this->SettingsList = array();
                  }
                  catch( Exception $e )
                  {
                        $a = func_get_args();_throw_exception_object( __METHOD__ , $a , $e );
                  }
            }

            function                remove_setting( $Name )
            {
                  try
                  {
                        remove_fields( $this->SettingsList , array( $Name ) );
                  }
                  catch( Exception $e )
                  {
                        $a = func_get_args();_throw_exception_object( __METHOD__ , $a , $e );
                  }
            }

            function                __toString()
            {
                  try
                  {
                        return( serialize( $this->SettingsList ) );
                  }
                  catch( Exception $e )
                  {
                        $a = func_get_args();_throw_exception_object( __METHOD__ , $a , $e );
                  }
            }
      }
      
?>