[Solar-talk] Solar 0.26.0 alpha released, and new site!

Wed Jan 31 11:19:58 PST 2007

Hi guys --

As promised, Solar 0.26 is now available.  You can get it from the  
usual location.

Also , the new site is up!

   <http://solarphp.com/>

In addition to being a lot prettier, the manual pages are easier to  
navigate, and the site as a whole is faster due to full-page caching  
magic from Clay Loveless.

I'm attaching the full change notes below; because it's been three  
months since the last release, they're much longer.  There are  
various BC breaks as well, but if you've been following SVN, you know  
what they are and how to approach them.

As always, please let me know if you have any questions, comments, or  
concerns, and thank you for using Solar.

* * *

Solar 0.26.0 Release Notes
==========================

* [BRK] Naming standards change: "submit" is now "process".

   Previously, we had "controller", "action", "submit", and  
submission buttons
   were named 'submit'. Rodrigo Moraes pointed out, and Clay Loveless  
verified,
   that having buttons named 'submit' makes it difficult to work in  
JavaScript
   (such as calling a submit() method on a button named 'submit', etc).

   To fix this, we need a standards change. Henceforth, we will use  
"process"
   in place of "submit". So the progression is now "controller",  
"action",
   "process". Also, locale keys are changed from SUBMIT_* to PROCESS_*.

   This release effects the new standard across the entire Solar code  
base,
   and is essentially a global search-and-replace from 'submit' to  
'process'.
   Notable exceptions are Solar_Form, Solar_View_Helper_Form,
   Solar_View_Helper_FormSubmit.

* [CHG] Global removal of func_num_args() and func_get_arg().

   In the interest of speeding things up when possible, this change  
introduces
   a new global constant: SOLAR_IGNORE_PARAM. This constant is used  
when we
   need an optional method param that may or may not be present.

   Previously, we would check for added optional params using  
func_num_args(),
   and then get the values of those params using func_get_arg(). The  
func_*()
   functions are known to be quite slow.

   Now, we set the param default value to SOLAR_IGNORE_PARAM. If the  
param is
   that value, we know it was not passed.

   Why do this instead of using null or some other empty value? Because
   sometimes you want to pass a null or empty value; using the
   SOLAR_IGNORE_PARAM value lets you state that normally no parameter  
is to be
   passed at all.

   Hope this makes sense to everyone.

* [CHG] Removed ending ?> from all scripts to avoid "headers cannot  
be sent,
   output started at line X" error due to accidental trailing  
newlines in
   scripts.

* [CHG] Updated example .htaccess file with better rewrite rules.  
Also added
   some php flag & value defaults.

* [CHG] Changed "e.g." to "for example". This helps the documentation
   generator not get stuck on the periods (which indicate the summary is
   complete).

* [NEW] Class: Solar_View_Helper_FormXhtml.

* [NEW] Class: Solar_DataFilter. Using PHP's "filter" extension,  
combines
   methods from Solar_Valid and Solar_Filter into a single class. Will
   eventually replace Solar_Valid and Solar_Filter ... but not just yet.

Solar
-----

* [CHG] Method locale() now accepts an object as the first param

* [CHG] Method exception() now accepts an object as the first param

* [ADD] Property $config_base to store inherited Solar_Base class  
configs

* [CHG] Per discussions w/Travis Swicegood about testing, move  
cleaning of
   globals (and config fetching) to independently-testable locations.
   Effectively, this means two new methods: cleanGlobals() and  
fetchConfig().

* [CHG] The factory() method now checks to see if the new object  
itself has a
   `solarFactory()` method; if so, it returns the result from *that*  
factory.
   This allows for factory classes to return specific adapters.

* [CHG] The dependency() method no longer checks that the dependency  
object is
   an instance of the $class parameter value; this is because factory  
classes
   will return an adapter instance, not an instance of the factory class
   itself.

* [CHG] Method registry() doesn't check if the string $spec is  
registered;
   lets the registry itself do that. We want it to fail if the string  
$spec is
   not registered, not pass on to creating a new object.

* [FIX] Method config() now allows empty values as valid config values
   (changed from an empty() check to a ! isset() check; thanks, Travis
   Swicegood).

* [CHG] The fileExists() method now returns the full-path file- 
location it
   found instead of boolean true. Still returns boolean false when  
the file is
   not found. Thanks, Clay, for the suggestion.

* [CHG] Method run() is more friendly to opcode caches (takes the  
include()
   out of a conditional).

* [BRK] Now uses 'solarFactory' as the Solar::factory() auto-factory  
method
   name (vice 'factory').

* [CHG] Solar::dump() no longer takes values by reference.

Solar_Access
------------

* [BRK] Converted from "facade" pattern to "factory" pattern. Is now  
a factory
   class, not a facade, and returns adapter instances instead of an  
instance of
   itself. Although I note this as a BC-break, you should be able to  
continue
   using it almost exactly the way you have; i.e., through  
Solar::factory().
   The only difference should be that you get back an adapter  
instance instead
   of the facade instance.

Solar_Access_Adapter
--------------------

* [BRK] Now contains all the methods and properties previously  
contained in
   the Facade wrapper. I note this as a BC break, but if you have  
been using
   Solar::factory() all along, you should experience few if any  
problems on
   upgrade.

* [BRK] All 'submit' keys in access lists are now 'process' keys.

Solar_Access_Adapter_File
-------------------------

* [CHG] The fetch() method now checks to see if $this->_config 
['file'] exists
   and throws an exception if it does not.

Solar_App_Bookmarks
-------------------

* [BRK] All actions and views use a 'process' name and ID for all  
submit buttons.

* [BRK] All locale strings for SUBMIT_* are now PROCESS_*.

* [BRK] All calls to _isSubmit() are now _isProcess().

* [DEL] Removed methods actionUserFeed() and actionTagFeed();  
replaced by new extension-aware formatting (.rss)

* [ADD] New browse.rss.php view to generate RSS feeds when the .rss  
format is specified

* [DEL] Removed "feed" view, supplanted by "browse.rss".

* [CHG] Bookmark actions now assume layout is turned off for RSS format.

* [CHG] Added $_action_format map to say which actions support which  
formats.

Solar_Auth
----------

* [BRK] Is now a factory class, not a facade, and returns adapter
   instances instead of an instance of itself. Although I note this as a
   BC-break, you should be able to continue using it almost exactly  
the way
   you have; i.e., through Solar::factory(). The only difference  
should be
   that you get back an adapter instance instead of the facade instance.

* [BRK] Moved locale files to Solar/Auth/Adapter/Locale.

Solar_Auth_Adapter
------------------

* [BRK] Now contains all the methods and properties previously contained
   in the facade wrapper. I note this as a BC break, but if you have  
been
   using Solar::factory() all along, you should experience few if any
   problems on upgrade.

* [BRK] No more use of the 'common' config key; since adapters are
   factoried (not behind a facade) those elements can become part of the
   regular config array.

* [CHG] Streamlined start() method internals.

* [CHG] Removed _setup() method entirely, now using _loadSession()
   intelligently.

* [BRK] Renamed isLoginValid() to processLogin().

* [BRK] Renamed _verify() to _processLogin(). Instead of returning  
true/false,
   it should return an array of user info on success; or, on failure,  
return a
   string error code or an empty value.

* [NEW] Added processLogout() and _processLogout() methods.

* [CHG] Removed _setInfo() method, modified reset() to take a second  
param
   for user information.

* [CHG] Now forces a temporary 'ANON' state when attempting to log in.

* [CHG] Method isValid() now loads the session before checking

* [ADD] Added config key 'session_class'. This allows you to pick  
what name to
   use as the session segment; e.g., different adapters can refer to  
the same
   session values.

* [CHG] Config key 'session_class' now defaults to  
'Solar_Auth_Adapter', not
   the actual adapter class name. This mimics the previous facade-based
   behavior.

* [BRK] Config keys for 'source_submit', 'submit_login', and  
'submit_logout'
   are now 'source_process', 'process_login', and 'process_logout'
   respectively.

* [NEW] Adds support for automated redirection to a specified URI on  
valid
   login.

Solar_Auth_Adapter_*
--------------------

* [CHG] Each adapter now sets public values for $this->handle, email,  
uri,
   and moniker (as needed) instead of the protected versions.

Solar_Auth_Adapter_Htpasswd
---------------------------

* [CHG] Now uses $this->_handle and $this->_passwd directly.