However as a lot of refactoring work has taken place, and several changes have
been made which could cause incompatibilities. If your application or plugin
is using deprecated code, or relying on side-effects, then you could have
-issues upgrding to this release.
+issues upgrading to this release.
Most issues found with pre-existing components have been easy to solve, and a
-complete description of behavior changes which may cause compatibility issues,
+complete description of behaviour changes which may cause compatibility issues,
or warnings which are now emitted is included below to help if you have problems.
If you think you have found an upgrade related issue which is not covered in
use Moose;
BEGIN { extends 'Catalyst::Component' }; # Or ::Controller, or whatever
-Note that the C< extends > decleration needs to occur in a begin block for
+Note that the C< extends > declaration needs to occur in a begin block for
L<attributes> to operate correctly. You also don't get the L<Moose::Object>
constructor, and therefore attribute initialization will not work as normally
expected. If you want to use Moose attributes, then they need to be made lazy
Previously, writing to a class data accessor would copy the accessor method
down into your package.
-This behavior has been removed. Whilst the class data is still stored
+This behaviour has been removed. Whilst the class data is still stored
per-class, it is stored on the metaclass of the class defining the accessor.
Therefore anything relying on the side-effect of the accessor being copied down
Previously, it was possible to add additional accessors to Catalyst::Request
(or other classes) by calling the mk_accessors class method.
-This is no longer supported - users should make a sub-class of the class whos
-behavior they would like to change, rather than globally polluting the
+This is no longer supported - users should make a sub-class of the class whose
+behaviour they would like to change, rather than globally polluting the
Catalyst objects.
=head2 Confused multiple inheritance with Catalyst::Component::COMPONENT
-Warning message:
+Previously, Catalyst's COMPONENT method would delegate to the method on the
+right hand side, which could then delegate back again with NEXT. This (as it
+is insane AND makes no sense with C3 method dispatch order), and is therefore
+no longer supported.
+
+If a COMPONENT method is detected in the inheritance hierarchy to the right
+hand side of Catalyst::Component::COMPONENT, then the following warning
+message will be emitted:
There is a COMPONENT method resolving after Catalyst::Component
in ${next_package}.
-This means that one of the packages on the right hand side of
-Catalyst::Component in your Class' inheritance hierarchy defines a COMPONENT
-method.
-
-Previously, Catalyst's COMPONENT method would delegate to the method on the
-right hand side, which could then delegate back again with NEXT. This (as it
-is insane), is no longer supported, as it makes no sense with C3 method
-dispatch order.
-
-Therefore the correct fix is to re-arrange your class' inheritance hierarchy
-so that the COMPONENT method you would like to inherit is the first COMPONENT
-method in your @ISA.
+The correct fix is to re-arrange your class' inheritance hierarchy so that the
+COMPONENT method you would like to inherit is the first (left-hand most)
+COMPONENT method in your @ISA.
=head1 WARNINGS
=head2 Methods in Catalyst::Dispatcher
-The following methods in Catalyst::Dispatcher are both an implementation detail,
-and also likely to change significantly in the 5.8X release series, and therefore
-their use is highly deprecated.
+The following methods in Catalyst::Dispatcher are both an implementation
+detail, which may change in the 5.8X release series, and therefore their use
+is highly deprecated.
=over
The first time one of these methods is called, a warning will be emitted:
- Class $class is calling the deprecated method Catalyst::Dispatcher::$public_method_name,\n"
- . "this will be removed in Catalyst 5.9X"
+ Class $class is calling the deprecated method Catalyst::Dispatcher::$public_method_name,
+ this will be removed in Catalyst 5.9X
You should B<NEVER> be calling any of these methods from application code.
-Plugins authors and maintainers whos plugins currently call these methods
+Plugins authors and maintainers whose plugins currently call these methods
should change to using the public API, or, if you do not feel the public API
-adaquately supports your use-case, please email the development list to
+adequately supports your use-case, please email the development list to
discuss what API features you need so that you can be appropriately supported.
-=head2 require $class was successful but the package is not defined.
+=head2 Class naming to packages defined does not correspond.
In this version of Catalyst, if a component is loaded from disk, but no
-symbols are defined in that component's namespace after it is loaded, this
-warning will be issued.
+symbols are defined in that component's name space after it is loaded, this
+warning will be issued:
-This is to protect against confusing bugs caused by mis-typing package names.
+ require $class was successful but the package is not defined.
-This will become a fatal error in a future version.
+This is to protect against confusing bugs caused by mis-typing package names,
+and will become a fatal error in a future version.
+
+Please note that 'inner packages' (via L<Devel::InnerPackage>) are still fully
+supported, this warning is only issued when component file naming does not map
+to B<any> of the packages defined within that component.
=head2 $c->plugin method
deprecated>.
Instead you are recommended to use L< Catalyst::Model::Adaptor > or similar to
-compose the functionality you need outside of the main application namespace.
+compose the functionality you need outside of the main application name space.
+
+Calling the plugin method at runtime will not be supported past Catalyst 5.81.
=cut
projects / catagits/Catalyst-Runtime.git / blobdiff