Merge pull request #327 from halkyon/doc_changes

MINOR Documentation about renaming sapphire to framework
This commit is contained in:
Ingo Schommer 2012-04-16 01:56:21 -07:00
commit c7ef4abe5d

View File

@ -14,17 +14,18 @@
## Upgrading ## ## Upgrading ##
### References to sapphire replaced with ModulePath ### ### sapphire renamed to framework ###
`sapphire` module has been renamed to `framework` for new installations of SilverStripe. `sapphire` has been renamed to `framework`.
Existing code bases can retain `sapphire` as the framework directory name, and a new template variable Please ensure the framework now resides in the new folder when upgrading.
`$ModulePath` is now used in place of hardcoding "sapphire" in the core code base, this allows easier
transitions if you want to rename the framework directory.
In your templates, `$ModulePath(framework)` gives whatever directory the SilverStripe framework resides in. Here's a list of steps to check:
It takes the value from the `FRAMEWORK_DIR` constant, which is automatically worked out based on where the
framework directory is, but can be set manually by defining `FRAMEWORK_DIR` in your `_ss_environment.php` file. * Remove your existing `sapphire` directory, and replace with `framework` from the new SilverStripe 3.0 package
* Rename references of `sapphire` to `framework` in `.htaccess`, `web.config` and `/usr/bin/sake` (the last is only necessary if you use `sake`)
* Find and replace any references to `sapphire` in your custom code to `framework`. In your PHP code, you can use the constant `FRAMEWORK_DIR`,
which points to the framework directory, and in the templates you can use `$ModulePath(framework)`
### New ORM: More flexible and expressive querying via `DataList` ### ### New ORM: More flexible and expressive querying via `DataList` ###