Development

ref/DirDoctrine (diff)

You must first sign up to be able to contribute.

Changes from Version 1 of ref/DirDoctrine

Show
Ignore:
Author:
bshirley (IP: 206.231.146.2)
Timestamp:
01/19/09 21:35:02 (9 years ago)
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • ref/DirDoctrine

    v0 v1  
     1= doctrine = 
     2 
     3This subdirectory exists in various directories, typically where doctrine tasks generate code.  This mostly includes the [wiki:ref/DirModel model], [wiki:ref/DirForm form], and [wiki:ref/DirFilter filter] locations. 
     4 
     5There is also a config subdirectory of this name that contains the data description of the model objects used in the project. 
     6 
     7== Locations == 
     8 
     9{{{ 
     10/<projname>/config/doctrine 
     11/<projname>/filter/doctrine 
     12/<projname>/form/doctrine 
     13/<projname>/migration/doctrine 
     14/<projname>/model/doctrine 
     15}}} 
     16 
     17== Contents == 
     18 
     19Each of these directories contains values that are particular to their parent directories.  The ''model/doctrine'' directory contains two php class files for each model type:  [wiki:ref/FileModelnameClassPhp <modelname>.class.php] and [wiki:ref/FileModelnameTableClassPhp <modelname>Table.class.php]. 
     20 
     21The ''form/doctrine'' directory contains files that correspond to the same model classes but provide the typical forms used to enter or display the related model.  They are of the name [wiki:ref/FileModelnameFormClassPhp <modelname>Form.class.php]. 
     22 
     23The ''filter/doctrine'' directory contains files that correspond to the same model classes but provide filters to the data.  They are named [wiki:ref/FileModelnameFormFilterClassPhp <modelname>FormFilter.class.php]. 
     24 
     25The above directories all contain a [wiki:ref/DirBase base] directory that contains generated code that should not be changed.  The classes in the respective directories subclass those in the ''base'' directory.  
     26 
     27The ''config/doctrine'' contains the full description of the data used project wide in [wiki:ref/FileSchemaYml schema.yml]. 
     28 
     29== Examples == 
     30 
     31listing from [http://www.symfony-project.org/jobeet/1_2/Propel/en/ Jobeet]: 
     32 
     33{{{ 
     34kallichore:jobeet user$ find . -name doctrine -print -exec ls -l '{}' \; 
     35./config/doctrine 
     36-rw-r--r--@ 1 user  staff  1974 Jan  9 14:40 schema.yml 
     37 
     38./lib/filter/doctrine 
     39-rw-r--r--   1 user  staff  281 Jan  9 14:56 BaseFormFilterDoctrine.class.php 
     40-rw-r--r--   1 user  staff  311 Jan  9 14:56 JobeetAffiliateFormFilter.class.php 
     41-rw-r--r--   1 user  staff  343 Jan  9 14:56 JobeetCategoryAffiliateFormFilter.class.php 
     42-rw-r--r--   1 user  staff  307 Jan  9 14:56 JobeetCategoryFormFilter.class.php 
     43-rw-r--r--   1 user  staff  287 Jan  9 14:56 JobeetJobFormFilter.class.php 
     44drwxr-xr-x   7 user  staff  238 Dec 12 10:25 base 
     45drwxr-xr-x  11 user  staff  374 Jan  8 13:42 sfDoctrineGuardPlugin 
     46 
     47./lib/form/doctrine 
     48-rw-r--r--@  1 user  staff   795 Jan  9 14:56 BackendJobeetJobForm.class.php 
     49-rw-r--r--   1 user  staff   249 Jan  9 14:56 BaseFormDoctrine.class.php 
     50-rw-r--r--@  1 user  staff   991 Jan 12 13:57 JobeetAffiliateForm.class.php 
     51-rw-r--r--   1 user  staff   312 Jan  9 14:56 JobeetCategoryAffiliateForm.class.php 
     52-rw-r--r--@  1 user  staff   328 Jan  9 14:56 JobeetCategoryForm.class.php 
     53-rw-r--r--@  1 user  staff  2040 Jan  9 14:56 JobeetJobForm.class.php 
     54drwxr-xr-x   7 user  staff   238 Dec 12 10:25 base 
     55drwxr-xr-x  11 user  staff   374 Jan  8 13:42 sfDoctrineGuardPlugin 
     56 
     57./lib/migration/doctrine 
     58 
     59./lib/model/doctrine 
     60-rw-r--r--@  1 user  staff  1006 Jan 15 10:55 JobeetAffiliate.class.php 
     61-rw-r--r--@  1 user  staff   230 Jan 15 10:41 JobeetAffiliateTable.class.php 
     62-rw-r--r--@  1 user  staff   649 Jan  8 10:35 JobeetCategory.class.php 
     63-rw-r--r--   1 user  staff   153 Dec 12 10:19 JobeetCategoryAffiliate.class.php 
     64-rw-r--r--   1 user  staff   144 Dec 12 10:19 JobeetCategoryAffiliateTable.class.php 
     65-rw-r--r--@  1 user  staff   322 Dec 24 12:13 JobeetCategoryTable.class.php 
     66-rw-r--r--@  1 user  staff  4017 Jan 14 15:02 JobeetJob.class.php 
     67-rw-r--r--@  1 user  staff  2748 Jan 14 14:23 JobeetJobTable.class.php 
     68drwxr-xr-x   7 user  staff   238 Dec 12 10:20 base 
     69drwxr-xr-x  18 user  staff   612 Jan  8 13:43 sfDoctrineGuardPlugin 
     70}}} 
     71 
     72== References == 
     73 
     74 
     75''(many references for these items in Doctrine document and Jobeet/Doctrine document)''