Changeset 4306

Show
Ignore:
Timestamp:
04/30/08 15:38:31 (14 months ago)
Author:
jwage
Message:

Documentation cleanup

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • branches/0.11/lib/Doctrine.php

    r4301 r4306  
    446446 
    447447    /** 
    448      * Path 
     448     * Path to Doctrine root 
    449449     * 
    450450     * @var string $path            doctrine root directory 
     
    453453 
    454454    /** 
    455      * Debug 
    456      * 
    457      * Bool true/false 
     455     * Debug bool true/false option 
    458456     * 
    459457     * @var boolean $_debug 
     
    462460 
    463461    /** 
    464      * _loadedModelFiles 
    465      * 
    466462     * Array of all the loaded models and the path to each one for autoloading 
    467463     * 
     
    471467 
    472468    /** 
    473      * _validators 
    474      * 
    475469     * Array of all the loaded validators 
     470     * 
    476471     * @var array 
    477472     */ 
     
    490485 
    491486    /** 
    492      * getLoadedModelFiles 
    493      * 
    494487     * Returns an array of all the loaded models and the path where each of them exists 
    495488     * 
     
    502495 
    503496    /** 
    504      * debug 
     497     * Turn on/off the debugging setting 
    505498     * 
    506499     * @param string $bool 
     
    517510 
    518511    /** 
    519      * getPath 
    520      * returns the doctrine root 
     512     * Get the root path to Doctrine 
    521513     * 
    522514     * @return string 
     
    532524 
    533525    /** 
    534      * loadModel 
    535      * 
    536      * @package default 
     526     * Load an individual model name and path in to the model loading registry 
     527     * 
     528     * @return null 
    537529     */ 
    538530    public static function loadModel($className, $path = null) 
     
    542534 
    543535    /** 
    544      * loadModels 
    545      * 
    546536     * Recursively load all models from a directory or array of directories 
    547537     * 
     
    601591 
    602592    /** 
    603      * getLoadedModels 
    604      * 
    605593     * Get all the loaded models, you can provide an array of classes or it will use get_declared_classes() 
    606594     * 
     
    622610 
    623611    /** 
    624      * initializeModels 
    625      * 
    626612     * Initialize all models so everything is present and loaded in to memory 
    627613     * This will also inheritently initialize any model behaviors and add 
     
    654640 
    655641    /** 
    656      * filterInvalidModels 
    657      * 
    658642     * Filter through an array of classes and return all the classes that are valid models. 
    659643     * This will inflect the class, causing it to be loaded in to memory. 
     
    676660 
    677661    /** 
    678      * isValidModelClass 
    679      * 
    680662     * Checks if what is passed is a valid Doctrine_Record 
    681663     * Will load class in to memory in order to inflect it and find out information about the class 
     
    708690 
    709691    /** 
    710      * getConnectionByTableName 
    711      * 
    712692     * Get the connection object for a table by the actual table name 
     693     * FIXME: I think this method is flawed because a individual connections could have the same table name 
    713694     * 
    714695     * @param string $tableName 
     
    731712 
    732713    /** 
    733      * generateModelsFromDb 
    734      * 
    735      * method for importing existing schema to Doctrine_Record classes 
     714     * Method for importing existing schema to Doctrine_Record classes 
    736715     * 
    737716     * @param string $directory Directory to write your models to 
     
    747726 
    748727    /** 
    749      * generateYamlFromDb 
    750      * 
    751728     * Generates models from database to temporary location then uses those models to generate a yaml schema file. 
    752729     * This should probably be fixed. We should write something to generate a yaml schema file directly from the database. 
     
    777754 
    778755    /** 
    779      * generateModelsFromYaml 
    780      * 
    781756     * Generate a yaml schema file from an existing directory of models 
    782757     * 
     
    795770 
    796771    /** 
    797      * createTablesFromModels 
    798      * 
    799772     * Creates database tables for the models in the specified directory 
    800773     * 
     
    808781 
    809782    /** 
    810      * createTablesFromArray 
    811      * 
    812783     * Creates database tables for the models in the supplied array 
    813784     * 
     
    821792 
    822793    /** 
    823      * generateSqlFromArray 
    824      * 
    825      * @param string $array 
    826      * @return void 
     794     * Generate a array of sql for the passed array of models 
     795     * 
     796     * @param  array $array 
     797     * @return array $sql 
    827798     */ 
    828799    public static function generateSqlFromArray($array) 
     
    832803 
    833804    /** 
    834      * generateSqlFromModels 
    835      * 
    836      * @param string $directory 
     805     * Generate a sql string to create the tables from all loaded models 
     806     * or the models found in the passed directory. 
     807     * 
     808     * @param  string $directory 
    837809     * @return string $build  String of sql queries. One query per line 
    838810     */ 
     
    850822 
    851823    /** 
    852      * generateYamlFromModels 
    853      * 
    854824     * Generate yaml schema file for the models in the specified directory 
    855825     * 
     
    866836 
    867837    /** 
    868      * createDatabases 
    869      * 
    870838     * Creates databases for connections 
    871839     * 
     
    879847 
    880848    /** 
    881      * dropDatabases 
    882      * 
    883849     * Drops databases for connections 
    884850     * 
     
    892858 
    893859    /** 
    894      * dumpData 
    895      * 
    896860     * Dump data to a yaml fixtures file 
    897861     * 
     
    908872 
    909873    /** 
    910      * loadData 
    911      * 
    912874     * Load data from a yaml fixtures file. 
    913875     * The output of dumpData can be fed to loadData 
     
    929891 
    930892    /** 
    931      * migrate 
    932      * 
    933893     * Migrate database to specified $to version. Migrates from current to latest if you do not specify. 
    934894     * 
     
    946906 
    947907    /** 
    948      * generateMigrationClass 
    949      * 
    950908     * Generate new migration class skeleton 
    951909     * 
     
    961919 
    962920    /** 
    963      * generateMigrationsFromDb 
     921     * Generate a set of migration classes from an existing database 
    964922     * 
    965923     * @param string $migrationsPath 
     
    975933 
    976934    /** 
    977      * generateMigrationsFromModels 
     935     * Generate a set of migration classes from an existing set of models 
    978936     * 
    979937     * @param string  $migrationsPath Path to your Doctrine migration classes 
     
    990948 
    991949    /** 
    992      * getTable 
     950     * Get the Doctrine_Table object for the passed model 
    993951     * 
    994952     * @param string $tableName 
     
    1001959 
    1002960    /** 
    1003      * compile 
    1004      * 
    1005      * method for making a single file of most used doctrine runtime components 
     961     * Method for making a single file of most used doctrine runtime components 
    1006962     * including the compiled file instead of multiple files (in worst 
    1007963     * cases dozens of files) can improve performance by an order of magnitude 
     
    1018974 
    1019975    /** 
    1020      * autoload 
    1021      * 
    1022976     * simple autoload function 
    1023977     * returns true if the class was loaded, otherwise false 
     
    10521006 
    10531007    /** 
    1054      * dump 
    1055      * 
    10561008     * dumps a given variable 
    10571009     *