Development

ref/DirBase (diff)

You must first sign up to be able to contribute.

Changes from Version 1 of ref/DirBase

Show
Ignore:
Author:
bshirley (IP: 206.231.146.2)
Timestamp:
01/16/09 23:36:15 (9 years ago)
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • ref/DirBase

    v0 v1  
     1= base = 
     2 
     3When Doctrine tasks are executed and generate files they generally make two files.  One that will change each time the task is executed (possibly being updated by modified configuration files), and a second that subclasses the first and is intended for developer customization.  The second will only be created if it is not present; subsequent executions of the generating task will not overwrite the existing version (whether it has been customized or not).  
     4 
     5The developer should never directly, manually alter the contents of these directories. 
     6 
     7== Locations == 
     8 
     9  {{{/lib/model/doctrine/base 
     10  /lib/form/doctrine/base 
     11  /lib/filter/doctrine/base}}} 
     12 
     13== Contents == 
     14 
     15The generated files in the directories should never be modified.  If they contain code you don't want, there are mechanisms to change that in the subclasses.  Also, the defined means of changing what is in the generated file is to change the meta-data used to generate them, and then re-execute the generation command. 
     16 
     17The contents will be files with names of the form Base<name>.class.php, Base<name>Form.class.php, and Base<name>FormFilter.class.php, respectively for each of the three locations listed above. 
     18 
     19== Examples == 
     20 
     21listing from [http://www.symfony-project.org/jobeet/1_2/Propel/en/ Jobeet]: 
     22 
     23{{{ 
     24ls -l lib/filter/doctrine/base 
     25-rw-r--r--  1 user  staff  3204 Jan  9 14:56 BaseJobeetAffiliateFormFilter.class.php 
     26-rw-r--r--  1 user  staff   916 Jan  9 14:56 BaseJobeetCategoryAffiliateFormFilter.class.php 
     27-rw-r--r--  1 user  staff  2725 Jan  9 14:56 BaseJobeetCategoryFormFilter.class.php 
     28-rw-r--r--  1 user  staff  4386 Jan  9 14:56 BaseJobeetJobFormFilter.class.php 
     29}}} 
     30 
     31{{{ 
     32ls -l lib/form/doctrine/base 
     33-rw-r--r--  1 user  staff  3006 Jan  9 14:56 BaseJobeetAffiliateForm.class.php 
     34-rw-r--r--  1 user  staff  1059 Jan  9 14:56 BaseJobeetCategoryAffiliateForm.class.php 
     35-rw-r--r--  1 user  staff  2750 Jan  9 14:56 BaseJobeetCategoryForm.class.php 
     36-rw-r--r--  1 user  staff  3000 Jan  9 14:56 BaseJobeetJobForm.class.php 
     37}}} 
     38 
     39{{{ 
     40ls -l lib/model/doctrine/base 
     41-rw-r--r--  1 user  staff  1274 Jan  9 14:56 BaseJobeetAffiliate.class.php 
     42-rw-r--r--  1 user  staff  1193 Jan  9 14:56 BaseJobeetCategory.class.php 
     43-rw-r--r--  1 user  staff   894 Jan  9 14:56 BaseJobeetCategoryAffiliate.class.php 
     44-rw-r--r--  1 user  staff  2021 Jan  9 14:56 BaseJobeetJob.class.php 
     45}}} 
     46 
     47== References == 
     48 
     49 * Task: [wiki:TaskDoctrineBuildAll Doctrine Build All] 
     50 * Task: [wiki:TaskDoctrineBuildModel Doctrine Build Model] 
     51 * Task: [wiki:TaskDoctrineBuildForms Doctrine Build Forms] 
     52 * Task: [wiki:TaskDoctrineBuildFilters Doctrine Build Filters]