lib/Maypole/Manual/Inheritance.pod

   1 \r
   2 =head1 NAME\r
   3 \r
   4 Maypole::Manual::Inheritance - structure of a Maypole application\r
   5 \r
   6 =head1 DESCRIPTION\r
   7 \r
   8 Discusses the inheritance structure of a basic and a more advanced Maypole\r
   9 application.\r
  10 \r
  11 =head1 CONVENTIONS\r
  12           \r
  13 =over 4\r
  14 \r
  15 =item inheritance\r
  16 \r
  17         +\r
  18         |\r
  19      +-   -+\r
  20         |\r
  21         +\r
  22         \r
  23 =item notes\r
  24 \r
  25     target *-------- note about the target\r
  26 \r
  27 =item association\r
  28 \r
  29     source ------> target\r
  30 \r
  31 =back\r
  32 \r
  33 =head1 Structure of a standard Maypole application\r
  34 \r
  35 A minimal Maypole application (such as the Beer database example from the\r
  36 L<Maypole> synopsis) consists of a custom driver class (BeerDB.pm), a set of\r
  37 auto-generated model classes, and a view class:\r
  38 \r
  39 \r
  40            THE DRIVER\r
  41                                           +------- init() is a factory method,\r
  42                    1      Maypole         |           it sets up the view\r
  43    Maypole::Config <----- config();       |              classes\r
  44    model();               init(); *-------+                           THE VIEW\r
  45     |                     view_object(); -------+\r
  46     |    +--------------* setup();              |      Maypole::View::Base\r
  47     |    |                   +                  |              +\r
  48     |    |                   |                  |     1        |\r
  49     |    |    PLUGINS    Apache::MVC *-----+    +-----> Maypole::View::TT\r
  50     |    |       +           +             |             (or another view class)\r
  51     |    |       |           |             |\r
  52     |    |       +-----+-----+             |\r
  53     |    |             |                   |\r
  54     |    |           BeerDB                +----- or CGI::Maypole\r
  55     |    |                                         or MasonX:::Maypole\r
  56     |    |\r
  57     |   setup() is a factory method,\r
  58     |     it sets up the model\r
  59     |         classes\r
  60     |\r
  61     |                                             THE MODEL\r
  62     |\r
  63     |  Maypole::Model::Base    Class::DBI\r
  64     |             +             +      +\r
  65     |             |             |      |\r
  66     +-------> Maypole::Model::CDBI   Class::DBI::<db_driver>\r
  67                       +                     +\r
  68                       |                     |\r
  69            +------------+--------+-------+---------+\r
  70            |            |        |       |         |\r
  71        BeerDB::Pub      |   BeerDB::Beer | BeerDB::Brewery\r
  72        beers();         |   pubs();      | beers();\r
  73                         |   brewery();   |\r
  74                         |   style();     |\r
  75           BeerDB::Handpump               |\r
  76           pub();                      BeerDB::Style\r
  77           beer();                     beers();\r
  78 \r
  79 =head2 What about Maypole::Application - loading plugins\r
  80 \r
  81 The main job of L<Maypole::Application> is to insert the plugins into the\r
  82 hierarchy. It is also the responsibility of L<Maypole::Application> to decide\r
  83 which frontend to use. It builds the list of plugins, then pushes them onto the\r
  84 driver's C<@ISA>, then pushes the frontend onto the end of the driver's C<@ISA>.\r
  85 So method lookup first searches all the plugins, before searching the frontend\r
  86 and finally L<Maypole> itself.\r
  87 \r
  88 From Maypole 2.11, L<Maypole::Application> makes no appearance in the\r
  89 inheritance structure of a Maypole application. (In prior versions,\r
  90 L<Maypole::Application> would make itself inherit the plugins, and then insert\r
  91 itself in the hierarchy, but this was unnecessary).\r
  92 \r
  93 =head2 Who builds the model?\r
  94 \r
  95 First, remember we are talking about the standard, unmodified Maypole here. It\r
  96 is possible, and common, to override some or all of this stage and build a\r
  97 customised model. See below - An advanced Maypole application - for one\r
  98 approach. Also, see L<Maypole's|Maypole> C<setup_model()> method. \r
  99 \r
 100 The standard model is built in 3 stages. \r
 101 \r
 102 First, C<Maypole::setup_model> calls C<setup_database> on the Maypole model\r
 103 class, in this case L<Maypole::Model::CDBI>. C<setup_database> then uses\r
 104 L<Class::DBI::Loader> to autogenerate individual L<Class::DBI> classes for each\r
 105 of the tables in the database (C<BeerDB::Beer>, C<BeerDB::Pub> etc).\r
 106 L<Class::DBI::Loader> identifies the appropriate L<Class::DBI> subclass and\r
 107 inserts it into each of these table classes' C<@ISA> ( C<<\r
 108 Class::DBI::<db_driver> >> in the diagrams)..\r
 109 \r
 110 Next, C<Maypole::setup> B<unshifts> L<Maypole::Model::CDBI> onto the C<@ISA> \r
 111 array of each of these classes. \r
 112 \r
 113 Finally, the relationships among these tables are set up. Either do this\r
 114 manually, using the standard L<Class::DBI> syntax for configuring table\r
 115 relationships, or try L<Class::DBI::Relationship> (which you can use via\r
 116 L<Maypole::Plugin::Relationship>). If you use the plugin, you need to set up the\r
 117 relationships configuration before calling C<setup()>. Be aware that some people\r
 118 like the convenience of L<Class::DBI::Relationship>, others dislike the\r
 119 abstraction. YMMV. \r
 120 \r
 121 =head1 An advanced Maypole application\r
 122 \r
 123 We'll call it C<BeerDB2>.\r
 124 \r
 125 Maypole is a framework, and you can replace different bits as you wish. So what \r
 126 follows is one example of good practice, other people may do things differently. \r
 127 \r
 128 We assume this application is being built from the ground up, but it will often\r
 129 be straightforward to adapt an existing L<Class::DBI> application to this\r
 130 general model.\r
 131 \r
 132 The main idea is that the autogenerated Maypole model is used as a layer on top\r
 133 of a separate L<Class::DBI> model. I am going to refer to this model as the\r
 134 'Offline' model, and the Maypole classes as the 'Maypole' model. The idea is\r
 135 that the Offline model can (potentially or in actuality) be used as part of\r
 136 another application, perhaps a command line program or a cron script, whatever.\r
 137 The Offline model does not know about the Maypole model, whereas the Maypole\r
 138 model does know about the Offline model.\r
 139 \r
 140 Let's call the offline model C<OfflineBeer>. As a traditional L<Class::DBI>\r
 141 application, individual table classes in this model will inherit from a common\r
 142 base (C<OfflineBeer>), which inherits from L<Class::DBI>).\r
 143 \r
 144 One advantage of this approach is that you can still use Maypole's autogenerated\r
 145 model. Another is that you do not mix online and offline code in the same\r
 146 packages.\r
 147 \r
 148 =head2 Building it\r
 149 \r
 150 Build a driver in a similar way as for the basic app, calling C<setup()> after\r
 151 setting up all the configuration. \r
 152 \r
 153 It is a good habit to use a custom Maypole model class for each application, as\r
 154 it's a likely first target for customisation. Start it like this:\r
 155 \r
 156     package BeerDB2::Maypole::Model;\r
 157     use strict;\r
 158     use warnings;\r
 159     use base 'Maypole::Model::CDBI';\r
 160     1;\r
 161     \r
 162 You can add methods which should be shared by all table classes to this package \r
 163 as and when required.\r
 164     \r
 165 Configure it like this, before the C<setup()> call in the driver class:\r
 166 \r
 167     # in package BeerDB2\r
 168     __PACKAGE__->config->model('BeerDB2::Maypole::Model');\r
 169     __PACKAGE__->setup;\r
 170 \r
 171 The C<setup()> call will ensure your custom model is loaded via C<require>.\r
 172 \r
 173 B<Note>: by default, this will create Maypole/CDBI classes for all the tables in\r
 174 the database. You can control this by passing options for L<Class::DBI::Loader>\r
 175 in the call to C<setup()>.\r
 176 \r
 177 For each class in the model, you need to create a separate file. So for\r
 178 C<BeerDB2::Beer>, you would write:\r
 179 \r
 180     package BeerDB2::Beer;\r
 181     use strict;\r
 182     use warnings;\r
 183     use base 'OfflineBeer::Beer';\r
 184     1;\r
 185     \r
 186 From Maypole 2.11, this package will be loaded automatically during C<setup()>,\r
 187 and C<BeerDB2::Maypole::Model> is B<unshifted> onto it's C<@ISA>.\r
 188 \r
 189 Configure relationships either in the individual C<OfflineBeer::*> classes, or\r
 190 else all together in C<OfflineBeer> itself i.e. not in the Maypole model. This \r
 191 way, you only define the relationships in one place.\r
 192 \r
 193 The resulting model looks like this:\r
 194 \r
 195                                        Class::DBI\r
 196     MAYPOLE 'MODEL'                       |\r
 197                                           |\r
 198    Maypole::Model::Base                   |\r
 199            +                              |\r
 200            |       +-----------------+----+-----------------+\r
 201            |       |                 |                      |\r
 202            |       |                 |                      |\r
 203      Maypole::Model::CDBI            |                      |     OFFLINE\r
 204              +                       |                      |        MODEL\r
 205              |                       |                      |\r
 206      BeerDB2::Maypole::Model  Class::DBI::<db_driver>  OfflineBeer\r
 207        +                             +                      +\r
 208        |                             |                      |\r
 209        +-----------------------------+                      |\r
 210        |                                                    |\r
 211        +--- BeerDB2::Pub --------+ OfflineBeer::Pub --------+\r
 212        |                           beers();                 |\r
 213        |                                                    |\r
 214        |                           OfflineBeer::Handpump ---+\r
 215        |                           beer();                  |\r
 216        |                           pub();                   |\r
 217        |                                                    |\r
 218        +--- BeerDB2::Beer -------+ OfflineBeer::Beer -------+\r
 219        |                           pubs();                  |\r
 220        |                           brewery();               |\r
 221        |                           style();                 |\r
 222        |                                                    |\r
 223        +--- BeerDB2::Style ------+ OfflineBeer::Style ------+\r
 224        |                           beers();                 |\r
 225        |                                                    |\r
 226        +--- BeerDB2::Brewery ----+ OfflineBeer::Brewery ----+\r
 227                                    beers();\r
 228 \r
 229 \r
 230 \r
 231 =head3 Features\r
 232 \r
 233 1. Non-Maypole applications using the Offline model are completely isolated from\r
 234 the Maypole application, and need not know it exists at all.\r
 235 \r
 236 2. Methods defined in the Maypole table classes, override methods defined in the\r
 237 Offline table classes, because C<BeerDB2::Maypole::Model> was unshifted onto the\r
 238 beginning of each Maypole table class's C<@ISA>. Perl's depth first,\r
 239 left-to-right method lookup from e.g. C<BeerDB2::Beer> starts in\r
 240 C<BeerDB2::Beer>, then C<BeerDB2::Maypole::Model>, C<Maypole::Model::CDBI>,\r
 241 C<Maypole::Model::Base>, and C<Class::DBI>, before moving on to\r
 242 C<OfflineBeer::Beer> and finally C<OfflineBeer>.\r
 243 \r
 244 B<CAVEAT> - if your Offline model overrides L<Class::DBI> methods, these methods\r
 245 will B<not> be overridden when called from the Maypole application, because the\r
 246 Maypole model provides an alternative path to L<Class::DBI> which is searched\r
 247 first. The solution is to place such methods in a separate package, e.g.\r
 248 C<OfflineBeer::CDBI>. Place this B<first> in the C<@ISA> of both\r
 249 C<BeerDB2::Maypole::Model> and C<OfflineBeer>. Note that C<OfflineBeer::CDBI>\r
 250 does not itself need to inherit from L<Class::DBI>.\r
 251 \r
 252 3. Methods defined in the Maypole model base class (C<BeerDB2::Maypole::Model>),\r
 253 override methods in the individual Offline table classes, and in the Offline\r
 254 model base class (C<Offline>). \r
 255 \r
 256 4. Relationships defined in the Offline classes are inherited by the Maypole\r
 257 model.\r
 258 \r
 259 5. The Maypole model has full access to the underlying Offline model. \r
 260 \r
 261 =head3 Theory \r
 262 \r
 263 This layout illustrates more clearly why the Maypole model may be thought of as\r
 264 part of the controller, rather than part of the model of MVC. Its function is to \r
 265 mediate web requests, translating them into method calls on the Offline model, \r
 266 munging the results, and returning them via the Maypole request object. \r
 267 \r
 268 Another way of thinking about it is that Maypole implements a two-layer\r
 269 controller. The first layer translates a raw request into a single method call\r
 270 on the Maypole model layer, which then translates that call into one or more\r
 271 calls on the underlying model.\r
 272 \r
 273 Whatever label you prefer to use, this approach provides for clear separation of\r
 274 concerns between the underlying model and the web/user interface, and that's\r
 275 what it's all about.\r
 276 \r
 277 =head1 Advanced applications - building the model by hand ** TODO\r
 278 \r
 279 - using Maypole::Model::CDBI::Plain or Maypole::FormBuilder::Model::Plain\r
 280 - setup_model() and load_model_subclass()\r
 281 - cutting out all those separate paths to CDBI - they're confusing \r
 282 \r
 283 \r
 284 =head1 Method inheritance ** TODO\r
 285 \r
 286 More description of Perl's left-to-right, depth-first method lookup, and where\r
 287 it's particularly important in Maypole.\r
 288 \r
 289 \r
 290           \r
 291 =head1 AUTHOR\r
 292 \r
 293 David Baird, C<< <cpan@riverside-cms.co.uk> >>\r
 294 \r
 295 =head1 COPYRIGHT & LICENSE\r
 296 \r
 297 Copyright 2005 David Baird, All Rights Reserved.\r
 298 \r
 299 This text is free documentation; you can redistribute it and/or modify it\r
 300 under the same terms as the Perl documentation itself.\r
 301 \r
 302 =cut\r
 303 \r