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 A standard Maypole application\r
  34 \r
  35 A minimal Maypole application (such as the Beer database) consists of a \r
  36 custom driver class (BeerDB.pm), a set of auto-generated model classes, and a \r
  37 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. \r
  96 It is possible, and common, to override some or all of this stage and build a \r
  97 customised model.\r
  98 \r
  99 The standard model is built in 3 stages. \r
 100 \r
 101 First, C<Maypole::setup_model> calls C<setup_database> on the Maypole model\r
 102 class, in this case L<Maypole::Model::CDBI>. C<setup_database> then uses\r
 103 L<Class::DBI::Loader> to autogenerate individual L<Class::DBI> classes for each\r
 104 of the tables in the database (C<BeerDB::Beer>, C<BeerDB::Pub> etc).\r
 105 L<Class::DBI::Loader> identifies the appropriate L<Class::DBI> subclass and\r
 106 inserts it into each of these table classes' C<@ISA> ( C<<\r
 107 Class::DBI::<db_driver> >> in the diagrams)..\r
 108 \r
 109 Next, C<Maypole::setup> B<unshifts> L<Maypole::Model::CDBI> onto the C<@ISA> \r
 110 array of each of these classes. \r
 111 \r
 112 Finally, the relationships among these tables are set up. Either do this\r
 113 manually, perhaps with the help of L<Class::DBI::Relationship>, or use\r
 114 L<Maypole::Plugin::Relationship>. In the latter case, you need to set up the\r
 115 relationships configuration before calling C<setup()>.\r
 116 \r
 117 \r
 118 =head1 An advanced Maypole application\r
 119 \r
 120 We'll call it C<BeerDB2>.\r
 121 \r
 122 Maypole is a framework, and you can replace different bits as you wish. So what \r
 123 follows is one example of good practice, other people may do things differently. \r
 124 \r
 125 We assume this application is being built from the ground up, but it will often\r
 126 be straightforward to adapt an existing L<Class::DBI> application to this\r
 127 general model.\r
 128 \r
 129 The main idea is that the autogenerated Maypole model is used as a layer on top\r
 130 of a separate L<Class::DBI> model. I am going to refer to this model as the\r
 131 'Offline' model, and the Maypole classes as the 'Maypole' model. The idea is\r
 132 that the Offline model can (potentially or in actuality) be used as part of\r
 133 another application, perhaps a command line program or a cron script, whatever.\r
 134 The Offline model does not know about the Maypole model, whereas the Maypole\r
 135 model does know about the Offline model.\r
 136 \r
 137 Let's call the offline model C<OfflineBeer>. As a traditional L<Class::DBI>\r
 138 application, individual table classes in this model will inherit from a common\r
 139 base (C<OfflineBeer>), which inherits from L<Class::DBI>).\r
 140 \r
 141 One advantage of this approach is that you can still use Maypole's autogenerated\r
 142 model. Another is that you do not mix online and offline code in the same\r
 143 packages.\r
 144 \r
 145 =head2 Building it\r
 146 \r
 147 Build a driver in a similar way as for the basic app, calling C<setup()> after\r
 148 setting up all the configuration. \r
 149 \r
 150 It is a good habit to use a custom Maypole model class for each application, as\r
 151 it's a likely first target for customisation. Start it like this:\r
 152 \r
 153     package BeerDB2::Maypole::Model;\r
 154     use strict;\r
 155     use warnings;\r
 156     use base 'Maypole::Model::CDBI';\r
 157     1;\r
 158     \r
 159 You can add methods which should be shared by all table classes to this package \r
 160 as and when required.\r
 161     \r
 162 Configure it like this, before the C<setup()> call in the driver class:\r
 163 \r
 164     # in package BeerDB2\r
 165     __PACKAGE__->config->model('BeerDB2::Maypole::Model');\r
 166     __PACKAGE__->setup;\r
 167 \r
 168 The C<setup()> call will ensure your custom model is loaded via C<require>.\r
 169 \r
 170 B<Note>: by default, this will create Maypole/CDBI classes for all the tables in\r
 171 the database. You can control this by passing options for L<Class::DBI::Loader>\r
 172 in the call to C<setup()>.\r
 173 \r
 174 For each class in the model, you need to create a separate file. So for\r
 175 C<BeerDB2::Beer>, you would write:\r
 176 \r
 177     package BeerDB2::Beer;\r
 178     use strict;\r
 179     use warnings;\r
 180     use base 'OfflineBeer::Beer';\r
 181     1;\r
 182     \r
 183 From Maypole 2.11, this package will be loaded automatically during C<setup()>,\r
 184 and C<BeerDB2::Maypole::Model> is B<unshifted> onto it's C<@ISA>.\r
 185 \r
 186 Configure relationships either in the individual C<OfflineBeer::*> classes, or\r
 187 else all together in C<OfflineBeer> itself i.e. not in the Maypole model. This \r
 188 way, you only define the relationships in one place.\r
 189 \r
 190 The resulting model looks like this:\r
 191 \r
 192                                        Class::DBI\r
 193     MAYPOLE 'MODEL'                       |\r
 194                                           |\r
 195    Maypole::Model::Base                   |\r
 196            +                              |\r
 197            |       +-----------------+----+-----------------+\r
 198            |       |                 |                      |\r
 199            |       |                 |                      |\r
 200      Maypole::Model::CDBI            |                      |     OFFLINE\r
 201              +                       |                      |        MODEL\r
 202              |                       |                      |\r
 203      BeerDB2::Maypole::Model  Class::DBI::<db_driver>  OfflineBeer\r
 204        +                             +                      +\r
 205        |                             |                      |\r
 206        +-----------------------------+                      |\r
 207        |                                                    |\r
 208        +--- BeerDB2::Pub --------+ OfflineBeer::Pub --------+\r
 209        |                           beers();                 |\r
 210        |                                                    |\r
 211        |                           OfflineBeer::Handpump ---+\r
 212        |                           beer();                  |\r
 213        |                           pub();                   |\r
 214        |                                                    |\r
 215        +--- BeerDB2::Beer -------+ OfflineBeer::Beer -------+\r
 216        |                           pubs();                  |\r
 217        |                           brewery();               |\r
 218        |                           style();                 |\r
 219        |                                                    |\r
 220        +--- BeerDB2::Style ------+ OfflineBeer::Style ------+\r
 221        |                           beers();                 |\r
 222        |                                                    |\r
 223        +--- BeerDB2::Brewery ----+ OfflineBeer::Brewery ----+\r
 224                                    beers();\r
 225 \r
 226 \r
 227 \r
 228 =head3 Features\r
 229 \r
 230 1. Non-Maypole applications using the Offline model are completely isolated from\r
 231 the Maypole application, and need not know it exists at all.\r
 232 \r
 233 2. Methods defined in the Maypole table classes, override methods defined in the\r
 234 Offline table classes, because C<BeerDB2::Maypole::Model> was unshifted onto the\r
 235 beginning of each Maypole table class's C<@ISA>. Perl's depth first,\r
 236 left-to-right method lookup from e.g. C<BeerDB2::Beer> starts in\r
 237 C<BeerDB2::Beer>, then C<BeerDB2::Maypole::Model>, C<Maypole::Model::CDBI>,\r
 238 C<Maypole::Model::Base>, and C<Class::DBI>, before moving on to\r
 239 C<OfflineBeer::Beer> and finally C<OfflineBeer>.\r
 240 \r
 241 B<CAVEAT> - if your Offline model overrides L<Class::DBI> methods, these methods\r
 242 will B<not> be overridden when called from the Maypole application, because the\r
 243 Maypole model provides an alternative path to L<Class::DBI> which is searched\r
 244 first. The solution is to place such methods in a separate package, e.g.\r
 245 C<OfflineBeer::CDBI>. Place this B<first> in the C<@ISA> of both\r
 246 C<BeerDB2::Maypole::Model> and C<OfflineBeer>. Note that C<OfflineBeer::CDBI>\r
 247 does not itself need to inherit from L<Class::DBI>.\r
 248 \r
 249 3. Methods defined in the Maypole model base class (C<BeerDB2::Maypole::Model>),\r
 250 override methods in the individual Offline table classes, and in the Offline\r
 251 model base class (C<Offline>). \r
 252 \r
 253 4. Relationships defined in the Offline classes are inherited by the Maypole\r
 254 model.\r
 255 \r
 256 5. The Maypole model has full access to the underlying Offline model. \r
 257 \r
 258 =head3 Theory \r
 259 \r
 260 This layout illustrates more clearly why the Maypole model may be thought of as\r
 261 part of the controller, rather than part of the model of MVC. Its function is to \r
 262 mediate web requests, translating them into method calls on the Offline model, \r
 263 munging the results, and returning them via the Maypole request object. \r
 264 \r
 265 Another way of thinking about it is that Maypole implements a two-layer\r
 266 controller. The first layer translates a raw request into a single method call\r
 267 on the Maypole model layer, which then translates that call into one or more\r
 268 calls on the underlying model.\r
 269 \r
 270 Whatever label you prefer to use, this approach provides for clear separation of\r
 271 concerns between the underlying model and the web/user interface, and that's\r
 272 what it's all about.\r
 273           \r
 274 =head1 AUTHOR\r
 275 \r
 276 David Baird, C<< <cpan@riverside-cms.co.uk> >>\r
 277 \r
 278 =head1 COPYRIGHT & LICENSE\r
 279 \r
 280 Copyright 2005 David Baird, All Rights Reserved.\r
 281 \r
 282 This text is free documentation; you can redistribute it and/or modify it\r
 283 under the same terms as the Perl documentation itself.\r
 284 \r
 285 =cut\r
 286 \r