Summer Raffle 2023

Class Details

/**
 * EE_Config
 *
 * @package     Event Espresso
 * @subpackage  core/
 * @author      Brent Christensen
 */
Class [  final class EE_Config implements EventEspresso\core\interfaces\ResettableInterface ] {
  @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 19-1287

  - Constants [4] {
    Constant [ public string OPTION_NAME ] { ee_config }
    Constant [ public string LOG_NAME ] { ee_config_log }
    Constant [ public int LOG_LENGTH ] { 100 }
    Constant [ public string ADDON_OPTION_NAMES ] { ee_config_option_names }
  }

  - Static properties [3] {
    Property [ private static ?EE_Config $_instance = NULL ]
    Property [ private static bool $_logging_enabled = false ]
    Property [ private static bool $initialized = false ]
  }

  - Static methods [19] {
    /**
     * @singleton method used to instantiate class object
     * @return EE_Config instance
     */
    Method [  static public method instance ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 78 - 85

      - Parameters [0] {
      }
      - Return [ EE_Config ]
    }

    /**
     * Resets the config
     *
     * @param bool $hard_reset       if TRUE, sets EE_CONFig back to its original settings in the database. If FALSE
     *                               (default) leaves the database alone, and merely resets the EE_Config object to
     *                               reflect its state in the database
     * @param bool $reinstantiate    if TRUE (default) call instance() and return it. Otherwise, just leave
     *                               $_instance as NULL. Useful in case you want to forget about the old instance on
     *                               EE_Config, but might not be ready to instantiate EE_Config currently (eg if the
     *                               site was put into maintenance mode)
     * @return EE_Config|null
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  static public method reset ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 102 - 122

      - Parameters [2] {
        Parameter #0 [  bool $hard_reset = false ]
        Parameter #1 [  bool $reinstantiate = true ]
      }
      - Return [ ?EE_Config ]
    }

    /**
     * @return bool
     */
    Method [  static public method logging_enabled ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 197 - 200

      - Parameters [0] {
      }
      - Return [ bool ]
    }

    /**
     * use to get the current theme if needed from static context
     *
     * @return string current theme set.
     */
    Method [  static public method get_current_theme ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 208 - 213

      - Parameters [0] {
      }
      - Return [ string ]
    }

    /**
     * @param string $config_option_name
     */
    Method [  static public method log ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 909 - 921

      - Parameters [1] {
        Parameter #0 [  string $config_option_name = '' ]
      }
    }

    /**
     * trim_log
     * reduces the size of the config log to the length specified by EE_Config::LOG_LENGTH
     */
    Method [  static public method trim_log ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 928 - 940
    }

    Method [  static public method getLegacyShortcodesManager ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 955 - 963

      - Parameters [0] {
      }
      - Return [ EventEspresso\core\services\shortcodes\LegacyShortcodesManager ]
    }

    Method [  static public method getModuleRoutesManager ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 966 - 974

      - Parameters [0] {
      }
      - Return [ ?EventEspresso\core\services\modules\ModuleRoutesManager ]
    }

    /**
     * register_shortcode - makes core aware of this shortcode
     *
     * @param string $shortcode_path - full path up to and including shortcode folder
     * @return bool
     * @deprecated 4.9.26
     */
    Method [  static public method register_shortcode ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 984 - 995

      - Parameters [1] {
        Parameter #0 [  $shortcode_path = NULL ]
      }
    }

    /**
     * @return string|null
     * @deprecated 5.0.21.p
     */
    Method [  static public method get_page_for_posts ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 1002 - 1005

      - Parameters [0] {
      }
      - Return [ ?string ]
    }

    /**
     * @param string $module_path - full path up to and including module folder
     * @return bool
     * @deprecated 5.0.21.p
     */
    Method [  static public method register_module ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 1049 - 1063

      - Parameters [1] {
        Parameter #0 [  $module_path = '' ]
      }
    }

    /**
     * @param string $widget_path - full path up to and including widget folder
     * @return void
     * @deprecated 5.0.21.p
     */
    Method [  static public method register_ee_widget ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 1092 - 1106

      - Parameters [1] {
        Parameter #0 [  $widget_path = '' ]
      }
    }

    /**
     * @param string $route       - "pretty" public alias for module method
     * @param string $module      - module name (classname without EED_ prefix)
     * @param string $method_name - the actual module method to be routed to
     * @param string $key         - url param key indicating a route is being called
     * @return bool
     * @deprecated 5.0.21.p
     */
    Method [  static public method register_route ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 1117 - 1134

      - Parameters [4] {
        Parameter #0 [  $route = '' ]
        Parameter #1 [  $module = '' ]
        Parameter #2 [  $method_name = '' ]
        Parameter #3 [  $key = 'ee' ]
      }
    }

    /**
     * @param string $route - "pretty" public alias for module method
     * @param string $key   - url param key indicating a route is being called
     * @return array
     * @deprecated 5.0.21.p
     */
    Method [  static public method get_route ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 1143 - 1155

      - Parameters [2] {
        Parameter #0 [  $route = '' ]
        Parameter #1 [  $key = 'ee' ]
      }
    }

    /**
     * @return array
     * @deprecated 5.0.21.p
     */
    Method [  static public method get_routes ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 1162 - 1174
    }

    /**
     * @param string       $route      - "pretty" public alias for module method
     * @param integer      $status     - integer value corresponding  to status constant strings set in module parent
     *                                 class, allows different forwards to be served based on status
     * @param array|string $forward    - function name or array( class, method )
     * @param string       $key        - url param key indicating a route is being called
     * @return bool
     * @deprecated 5.0.21.p
     */
    Method [  static public method register_forward ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 1186 - 1203

      - Parameters [4] {
        Parameter #0 [  $route = '' ]
        Parameter #1 [  $status = 0 ]
        Parameter #2 [  $forward = '' ]
        Parameter #3 [  $key = 'ee' ]
      }
    }

    /**
     * @param string  $route     - "pretty" public alias for module method
     * @param integer $status    - integer value corresponding  to status constant strings set in module parent class,
     *                           allows different forwards to be served based on status
     * @param string  $key       - url param key indicating a route is being called
     * @return string
     * @deprecated 5.0.21.p
     */
    Method [  static public method get_forward ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 1214 - 1230

      - Parameters [3] {
        Parameter #0 [  $route = '' ]
        Parameter #1 [  $status = 0 ]
        Parameter #2 [  $key = 'ee' ]
      }
    }

    /**
     * @param string  $route     - "pretty" public alias for module method
     * @param integer $status    - integer value corresponding  to status constant strings set in module parent class,
     *                           allows different views to be served based on status
     * @param string  $view
     * @param string  $key       - url param key indicating a route is being called
     * @return bool
     * @deprecated 5.0.21.p
     */
    Method [  static public method register_view ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 1242 - 1259

      - Parameters [4] {
        Parameter #0 [  $route = '' ]
        Parameter #1 [  $status = 0 ]
        Parameter #2 [  $view = '' ]
        Parameter #3 [  $key = 'ee' ]
      }
    }

    /**
     * @param array|string|null $route  - "pretty" public alias for module method
     * @param integer           $status - integer value corresponding  to status constant strings set in module parent
     *                                  class, allows different views to be served based on status
     * @param string            $key    - url param key indicating a route is being called
     * @return string
     * @deprecated 5.0.21.p
     */
    Method [  static public method get_view ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 1270 - 1286

      - Parameters [3] {
        Parameter #0 [  $route = '' ]
        Parameter #1 [  $status = 0 ]
        Parameter #2 [  $key = 'ee' ]
      }
    }
  }

  - Properties [15] {
    Property [ private ?EventEspresso\core\services\shortcodes\LegacyShortcodesManager $legacy_shortcodes_manager = NULL ]
    Property [ private ?EventEspresso\core\services\modules\ModuleRoutesManager $module_routes_manager = NULL ]
    Property [ public StdClass $addons ]
    Property [ public ?EE_Admin_Config $admin = NULL ]
    Property [ public ?EE_Core_Config $core = NULL ]
    Property [ public ?EE_Currency_Config $currency = NULL ]
    Property [ public ?EE_Organization_Config $organization = NULL ]
    Property [ public ?EE_Registration_Config $registration = NULL ]
    Property [ public ?EE_Template_Config $template_settings = NULL ]
    Property [ public ?EE_Environment_Config $environment = NULL ]
    Property [ public ?EE_Map_Config $map_settings = NULL ]
    Property [ public ?EE_Tax_Config $tax_settings = NULL ]
    Property [ public ?EE_Messages_Config $messages = NULL ]
    Property [ public ?EE_Gateway_Config $gateway = NULL ]
    Property [ private array $_addon_option_names = [] ]
  }

  - Methods [21] {
    /**
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  private method __construct ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 129 - 153
    }

    /**
     * @return void
     * @since 5.0.21.p
     */
    Method [  private method loadLegacyConfigClasses ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 160 - 191
    }

    /**
     * @return void
     */
    Method [  private method _initialize_config ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 219 - 225
    }

    /**
     * load core plugin configuration
     *
     * @return void
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  private method _load_core_config ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 235 - 271
    }

    /**
     * @return void
     */
    Method [  protected method _verify_config ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 277 - 345
    }

    /**
     * @return mixed espresso config stuff
     */
    Method [  public method get_espresso_config ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 351 - 358
    }

    /**
     * @param string $option
     * @param mixed  $old_value
     * @param mixed  $value
     */
    Method [  public method double_check_config_comparison ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 366 - 390

      - Parameters [3] {
        Parameter #0 [  string $option ]
        Parameter #1 [  $old_value ]
        Parameter #2 [  $value ]
      }
    }

    /**
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  protected method _reset_espresso_addon_config ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 397 - 407
    }

    /**
     * @param bool $add_success
     * @param bool $add_error
     * @return bool
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method update_espresso_config ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 417 - 480

      - Parameters [2] {
        Parameter #0 [  bool $add_success = false ]
        Parameter #1 [  bool $add_error = true ]
      }
      - Return [ bool ]
    }

    /**
     * @param string              $section
     * @param string              $name
     * @param string              $config_class
     * @param EE_Config_Base|array|null $config_obj
     * @param array               $tests_to_run
     * @param bool                $display_errors
     * @return bool    TRUE on success, FALSE on fail
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  private method _verify_config_params ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 494 - 661

      - Parameters [6] {
        Parameter #0 [  string $section = '' ]
        Parameter #1 [  string $name = '' ]
        Parameter #2 [  string $config_class = '' ]
        Parameter #3 [  $config_obj = NULL ]
        Parameter #4 [  array $tests_to_run = [1, 2, 3, 4, 5, 6, 7, 8] ]
        Parameter #5 [  bool $display_errors = true ]
      }
      - Return [ bool ]
    }

    /**
     * @param string $section
     * @param string $name
     * @return string
     */
    Method [  private method _generate_config_option_name ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 669 - 672

      - Parameters [2] {
        Parameter #0 [  string $section = '' ]
        Parameter #1 [  string $name = '' ]
      }
      - Return [ string ]
    }

    /**
     * ensures that a config class is set, either from a passed config class or one generated from the config name
     *
     * @param string $config_class
     * @param string $name
     * @return string
     */
    Method [  private method _set_config_class ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 682 - 687

      - Parameters [2] {
        Parameter #0 [  string $config_class = '' ]
        Parameter #1 [  string $name = '' ]
      }
      - Return [ string ]
    }

    /**
     * @param string              $section
     * @param string              $name
     * @param string              $config_class
     * @param EE_Config_Base|array|null $config_obj
     * @return EE_Config_Base|null
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method set_config ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 699 - 759

      - Parameters [4] {
        Parameter #0 [  string $section = '' ]
        Parameter #1 [  string $name = '' ]
        Parameter #2 [  string $config_class = '' ]
        Parameter #3 [  $config_obj = NULL ]
      }
      - Return [ ?EE_Config_Base ]
    }

    /**
     * Important: the config object must ALREADY be set, otherwise this will produce an error.
     *
     * @param string                     $section
     * @param string                     $name
     * @param EE_Config_Base|string|null $config_obj
     * @param bool                       $throw_errors
     * @return bool
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method update_config ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 773 - 839

      - Parameters [4] {
        Parameter #0 [  string $section = '' ]
        Parameter #1 [  string $name = '' ]
        Parameter #2 [  $config_obj = '' ]
        Parameter #3 [  bool $throw_errors = true ]
      }
      - Return [ bool ]
    }

    /**
     * @param string $section
     * @param string $name
     * @param string $config_class
     * @return EE_Config_Base|null
     * @throws EE_Error
     * @throws ReflectionException
     */
    Method [  public method get_config ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 850 - 888

      - Parameters [3] {
        Parameter #0 [  string $section = '' ]
        Parameter #1 [  string $name = '' ]
        Parameter #2 [  string $config_class = '' ]
      }
      - Return [ ?EE_Config_Base ]
    }

    /**
     * @param string $config_option_name
     * @return EE_Config_Base|array
     */
    Method [  public method get_config_option ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 895 - 903

      - Parameters [1] {
        Parameter #0 [  string $config_option_name = '' ]
      }
    }

    Method [  public method update_addon_option_names ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 943 - 946
    }

    Method [  public method shutdown ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 949 - 952
    }

    /**
     * @return void
     * @deprecated 5.0.21.p
     */
    Method [  public method register_shortcodes_and_modules ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 1012 - 1023
    }

    /**
     * @return void
     * @deprecated 5.0.21.p
     */
    Method [  public method initialize_shortcodes_and_modules ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 1030 - 1041
    }

    /**
     * @return void
     * @deprecated 5.0.21.p
     */
    Method [  public method widgets_init ] {
      @@ /home/rowansho/public_html/wp-content/plugins/event-espresso-core-reg/core/EE_Config.core.php 1070 - 1084
    }
  }
}