Customization Framework - Revision history

Demitri: /* Automatically Updating Custom Code */

2014-05-27T19:59:35Z

‎Automatically Updating Custom Code

Demitri: /* Automatically Updating Custom Code */

2014-05-27T19:18:10Z

‎Automatically Updating Custom Code

Demitri: /* Automatically Updating Custom Code */

2014-04-02T22:04:34Z

‎Automatically Updating Custom Code

Demitri: /* Automatically Updating Custom Code */

2014-04-02T22:03:53Z

‎Automatically Updating Custom Code

Demitri: /* Automatically Updating Custom Code */

2014-04-02T22:03:33Z

‎Automatically Updating Custom Code

Demitri: /* Automatically Updating Custom Code */

2014-04-02T22:03:05Z

‎Automatically Updating Custom Code

Demitri at 18:44, 2 April 2014

2014-04-02T18:44:33Z

Demitri: /* Custom App Configuration */

2014-04-02T17:34:32Z

‎Custom App Configuration

Demitri at 23:57, 6 February 2014

2014-02-06T23:57:15Z

Jake: /* Custom App Configuration */

2013-08-26T20:34:55Z

‎Custom App Configuration

@@ Line 44: / Line 44: @@
 Finally, the process to update is as follows:
-# In <tt>protected/</tt>, run: <syntaxhighlight lang="bash">./yiic migratecustom --origin=<version of X2Engine updating from> --target=<version of X2Engine updating to> --gitdir=<path to the Git repository></syntaxhighlight>
+# In <tt>protected/</tt>, run: <syntaxhighlight lang="bash">./yiic migratecustom --origin=<version of X2Engine updating from> --target=<version of X2Engine updating to> --gitdir=<path to base level of the Git repository> --source=<path to "custom" directory></syntaxhighlight>
 # If there were any merge conflicts, they should be displayed in the output. You should then resolve the conflicts, commit the changes, and follow the instructions printed by the command.
 = Known Issues =

@@ Line 33: / Line 33: @@
 For all non-controller components overriding core classes, a console command has been written to ease the process of merging upstream changes. This command, [[x2doc:MigrateCustomCommand]], will perform this by automating the following procedural steps:
-# Copy all custom code into an up-to-date clone of the X2Engine Git repository.
+# Create a temporary branch for performing the merge in an up-to-date clone of the X2Engine Git repository, from the revision corresponding to the version updating from.
-# Commit differences between the custom code and base code at the version where customization was performed into a temporary branch
+# Copy all custom code into the repository on that new branch
 # Merge changes from the latter version into the temporary branch, leaving the user to sort out merge conflicts (if any)
 # Copy the updated custom files back into place

@@ Line 44: / Line 44: @@
 Finally, the process to update is as follows:
 # In <tt>protected/</tt>, run: <syntaxhighlight lang="bash">./yiic migratecustom --origin=<version of X2Engine updating from> --target=<version of X2Engine updating to> --gitdir=<path to the Git repository></syntaxhighlight>
-# If there were any merge conflicts, they should be displayed in the output. You should then resolve the conflicts, commit the changes to the git repository
+# If there were any merge conflicts, they should be displayed in the output. You should then resolve the conflicts, commit the changes, and follow the instructions printed by the command.
 Note, the "migratecustom" command also accepts an optional <tt>--source</tt> argument pointing to the path of the custom source directory, if in a different directory than the installation of X2Engine in which the command is being run.

@@ Line 43: / Line 43: @@
 Finally, the process to update is as follows:
-# In <tt>protected/</tt>, run: <syntaxhighlight lang="bash">./yiic migratecustom --origin={version of X2Engine updating from} --target={version of X2Engine updating to} --gitdir={path to the Git repository}</syntaxhighlight>
+# In <tt>protected/</tt>, run: <syntaxhighlight lang="bash">./yiic migratecustom --origin=<version of X2Engine updating from> --target=<version of X2Engine updating to> --gitdir=<path to the Git repository></syntaxhighlight>
 # If there were any merge conflicts, they should be displayed in the output. You should then resolve the conflicts, commit the changes to the git repository

@@ Line 43: / Line 43: @@
 Finally, the process to update is as follows:
-# In <tt>protected/</tt>, run:
+# In <tt>protected/</tt>, run: <syntaxhighlight lang="bash">./yiic migratecustom --origin={version of X2Engine updating from} --target={version of X2Engine updating to} --gitdir={path to the Git repository}</syntaxhighlight>
 # If there were any merge conflicts, they should be displayed in the output. You should then resolve the conflicts, commit the changes to the git repository

@@ Line 30: / Line 30: @@
 An array which mirrors the modified parts of main.php (the default configuration file) should be returned within the custom config file. To customize the configuration of the application, i.e. to add parameters to <tt>Yii::app()->params</tt>, one only need add/remove/alter the values and keys within <tt>$config</tt>.
 = Known Issues =
 * Currently, only PHP files can be substituted. To change a CSS or Javascript file you would have to edit the original file.
 * There is no guarantee a customized installation will still work after an update. You will still have to manually merge changes if you want (or need) to use an updated version of a customized file. Depending on the file, you may have to do this for most automatic updates (since some files are changed far more often than others). Luckilly, most of our changes are usually in controller files, which can be extended rather than just replaced, so the updates are less likely to be incompatible with your modifications.

@@ Line 26: / Line 26: @@
 = Custom App Configuration =
-The configuration for the Yii application can also be customized through the files "web.php", "console.php" and "test.php" in <tt>custom/protected/config</tt>. These files will be included and run in the default configuration files for X2Engine running as a web application, console application or unit testing environment (respectively).
+The configuration for the Yii application can also be customized through the files "web.php", "console.php" and "test.php" in <tt>custom/protected/config</tt>. These files will be run in the default configuration files for X2Engine running as a web application, console application or unit testing environment (respectively).
 An array which mirrors the modified parts of main.php (the default configuration file) should be returned within the custom config file. To customize the configuration of the application, i.e. to add parameters to <tt>Yii::app()->params</tt>, one only need add/remove/alter the values and keys within <tt>$config</tt>.

@@ Line 1: / Line 1: @@
 [[Category:Development]]
 = Introduction =
-X2CRM's source code is completely transparent and totally under your control. There's no need to compiled PHP, so altering your software is a simply a matter of hacking around in the files. Traditionally, this meant directly altering the source code within X2Engine's file structure. But this could be problematic to keep track of, given the vast number of files. On top of that, automatic updates to any of those files would wipe out all of your changes, so you would have to choose between customization and receiving updates.
+X2Engine's source code is completely transparent and totally under your control. There's no need to compiled PHP, so altering your software is a simply a matter of hacking around in the files. Traditionally, this meant directly altering the source code within X2Engine's file structure. But this could be problematic to keep track of, given the vast number of files. On top of that, automatic updates to any of those files would wipe out all of your changes, so you would have to choose between customization and receiving updates.
 X2Engine provides a means to alter classes and templates without modifying the original source files. You can create an alternate version of any PHP file, while preserving the original, which makes it much easier to keep track of your changes as well as preserving your alterations through updates. You may still need to rework your custom code when an update is incompatible, but it will be much easier.
@@ Line 26: / Line 26: @@
 = Custom App Configuration =
-The configuration for the Yii application can also be customized through the files "web.php", "console.php" and "test.php" in <tt>custom/protected/config</tt>. These files will be included and run in the default configuration files for X2CRM running as a web application, console application or unit testing environment (respectively).
+The configuration for the Yii application can also be customized through the files "web.php", "console.php" and "test.php" in <tt>custom/protected/config</tt>. These files will be included and run in the default configuration files for X2Engine running as a web application, console application or unit testing environment (respectively).
 An array which mirrors the modified parts of main.php (the default configuration file) should be returned within the custom config file. To customize the configuration of the application, i.e. to add parameters to <tt>Yii::app()->params</tt>, one only need add/remove/alter the values and keys within <tt>$config</tt>.