Overview

Abstract base class for all Solar objects.

This is the class from which almost all other Solar classes are extended. Solar_Base is relatively light, and provides ...

  • Construction-time reading of config file options for itself, and merging of those options with any options passed for instantation, along with the class-defined config defaults, into the Solar_Base::$_config property.

  • A Solar_Base::locale() convenience method to return locale strings.

  • A Solar_Base::_exception() convenience method to generate exception objects with translated strings from the locale file

Note that you do not define config defaults in $_config directly; instead, you use a protected property named for the class, with an underscore prefix. For exmple, a "Vendor_Class_Name" class would define the default config array in "$_Vendor_Class_Name". This convention lets child classes inherit parent config keys and values.

Package

This class is part of the Solar package.

Configuration Keys

None.

Constants

None.

Public Properties

The Solar_Base class has no public properties; try the list of all properties.

Public Methods

These are all the public methods in the Solar_Base class.

You can also view the list of all public, protected, and private methods.

__construct()

Constructor.

__destruct()

Default destructor; does nothing other than provide a safe fallback for calls to parent::__destruct().

dump()

Convenience method for getting a dump the whole object, or one of its properties, or an external variable.

locale()

Looks up class-specific locale strings based on a key.



Local