Introduction To Development - Revision history

Demitri: /* Using Classes */

2013-02-01T01:49:05Z

‎Using Classes

Demitri: /* Dependencies */

2013-02-01T01:48:32Z

‎Dependencies

Demitri: /* File Structure */

2012-10-25T01:21:48Z

‎File Structure

Demitri: /* File Structure */

2012-10-25T01:20:10Z

‎File Structure

Demitri: /* How a Request To The Web Application Translates To Execution */

2012-10-25T01:18:04Z

‎How a Request To The Web Application Translates To Execution

Demitri: /* How a Request To The Web Application Translates To Execution */

2012-09-19T18:42:14Z

‎How a Request To The Web Application Translates To Execution

Demitri: /* File Structure */

2012-09-19T18:41:34Z

‎File Structure

Demitri: /* File Structure */

2012-09-15T16:56:01Z

‎File Structure

50.76.38.36: /* Using Classes */

2012-09-14T23:42:15Z

‎Using Classes

Demitri: /* File Structure */

2012-09-13T23:49:23Z

‎File Structure

← Older revision		Revision as of 01:49, 1 February 2013
Line 55:		Line 55:
	Relevant page: [[yiiguide:basics.namespace\|Fundamentals: Path Alias and Namespace]] in [[yiiguide:\|The Definitive Guide to Yii]].		Relevant page: [[yiiguide:basics.namespace\|Fundamentals: Path Alias and Namespace]] in [[yiiguide:\|The Definitive Guide to Yii]].

−	Typically, when you use a class in Yii, you will never have to use an "include" statement. That is because Yii will automatically recognize when you intend to use a class and automatically load it. Directories can be scanned by Yii to recognize class files for automatic inclusion using [[yii:YiiBase#import-detail\|Yii::import()]]. Furthermore, many directories are already imported, so there is no need to call the import method a second time. The bulk of importing in ~~X2EngineCRM~~ is done in [[x2doc:ApplicationConfigBehavior\|ApplicationConfigBehavior]].	+	Typically, when you use a class in Yii, you will never have to use an "include" statement. That is because Yii will automatically recognize when you intend to use a class and automatically load it. Directories can be scanned by Yii to recognize class files for automatic inclusion using [[yii:YiiBase#import-detail\|Yii::import()]]. Furthermore, many directories are already imported, so there is no need to call the import method a second time. The bulk of importing in X2CRM is done in [[x2doc:ApplicationConfigBehavior\|ApplicationConfigBehavior]].

@@ Line 2: / Line 2: @@
 = Dependencies =
-X2EngineCRM is built using the following frameworks. Hence, the majority of necessary knowledge for development in X2Engine can be found in their respective documentation.
+X2CRM is built using the following frameworks. Hence, the majority of necessary knowledge for development in X2Engine can be found in their respective documentation.
 == [http://www.yiiframework.com/ Yii Framework] ==

@@ Line 30: / Line 30: @@
 Modifying the codebase requires an understanding of where the relevant files are located. All PHP files used in the web application, which don't belong to the framework, are under the <tt>protected/</tt> directory. This directory is not accessible from the web per the access rules defined in the .htaccess file; rather, these files are executed by the framework as the application runs. Within <tt>protected</tt> are the following directories:
 ;<tt>components/</tt>
-: Miscellaneous classes used throughout the application, especially those which are extended by other classes.
+: Miscellaneous classes used throughout the application, especially those which are extended by other classes. Contains its own <tt>views</tt> folder, which is used for storing templates for [[Widgets]].
 ;<tt>config/</tt>
 : Core configuration files for the web application.

@@ Line 36: / Line 36: @@
 : Base-level controller classes.
 ;<tt>data/</tt>
-: (Currently unused) Miscellaneous data files, i.e. SQL scripts
+: Miscellaneous data files. Currently used to store SQL scripts that are run during installation.
 ;<tt>extensions/</tt>
 : The designated folder for storing third-party classes.

@@ Line 23: / Line 23: @@
 Relevant pages: [[yiiguide:basics.controller|Controller]], [[yiiguide:basics.model|Model]], [[yiiguide:basics.view|View]] and [[yiiguide:basics.convention|Fundamentals: Conventions]] in [[yiiguide:|The Definitive Guide to Yii]]
-A request to the server translates to the instantiation of a controller class. Which controller is instantiated depends upon the [http://www.yiiframework.com/doc/guide/1.1/en/basics.controller#route route], which contains the first part of the controller class's name with the first letter in lowercase. Then, the method of the class whose name begins with "action" is run based on the [http://www.yiiframework.com/doc/guide/1.1/en/basics.controller#action action ID] of the request URL. As the action runs, it will retrieve data from the database using a model class. Actions which respond with content will then typically make a call to [[yii:CController#render-detail|render]] or [[yii:CController#renderPartial-detail|renderPartial]], methods inherited from the [[yii:CController|CController]] class. The [[yiiguide:basics.view|view]] file, specified by the first argument to that method, will then be used to display the content (contained in the model) that is then passed back to the client.
+A request to the server translates to the instantiation of a controller class. Which controller is instantiated depends upon the [http://www.yiiframework.com/doc/guide/1.1/en/basics.controller#route route], which contains the first part of the controller class's name with the first letter in lowercase. Then, the method of the class whose name begins with "action" is run based on the [http://www.yiiframework.com/doc/guide/1.1/en/basics.controller#action action ID] of the request URL. As the action runs, it will retrieve data from the database using a model class. Actions which respond with content will then typically make a call to [[yii:CController#render-detail|render]] or [[yii:CController#renderPartial-detail|renderPartial]], methods inherited from the [[yii:CController|CController]] class. The [[yiiguide:basics.view|view]] file, specified by the first argument to <tt>render</tt> or <tt>renderPartial</tt>, will then be used to display the content (contained in the model) which is then passed back to the client as markup (or json, text, etc.)
 == File Structure ==

@@ Line 21: / Line 21: @@
 = MVC In a Nutshell =
 == How a Request To The Web Application Translates To Execution ==
-Relevant pages: [[yiiguide:basics.controller|Controller]], [[yiiguide:basics.model|Model]] and [[yiiguide:basics.view|View]] in [[yiiguide:|The Definitive Guide to Yii]]
+Relevant pages: [[yiiguide:basics.controller|Controller]], [[yiiguide:basics.model|Model]], [[yiiguide:basics.view|View]] and [[yiiguide:basics.convention|Fundamentals: Conventions]] in [[yiiguide:|The Definitive Guide to Yii]]
 A request to the server translates to the instantiation of a controller class. Which controller is instantiated depends upon the [http://www.yiiframework.com/doc/guide/1.1/en/basics.controller#route route], which contains the first part of the controller class's name with the first letter in lowercase. Then, the method of the class whose name begins with "action" is run based on the [http://www.yiiframework.com/doc/guide/1.1/en/basics.controller#action action ID] of the request URL. As the action runs, it will retrieve data from the database using a model class. Actions which respond with content will then typically make a call to [[yii:CController#render-detail|render]] or [[yii:CController#renderPartial-detail|renderPartial]], methods inherited from the [[yii:CController|CController]] class. The [[yiiguide:basics.view|view]] file, specified by the first argument to that method, will then be used to display the content (contained in the model) that is then passed back to the client.

@@ Line 38: / Line 38: @@
 : The designated folder for storing third-party classes.
 ;<tt>messages/</tt>
-: Files containing translations of messages within the application (used by [http://www.yiiframework.com/doc/api/1.1/YiiBase#t-detail Yii::t])
+: Files containing translations of messages within the application (used by [[yii:YiiBase#t-detail|Yii::t]])
 ;<tt>models/</tt>
 : All core/base level model classes.

← Older revision		Revision as of 23:42, 14 September 2012
Line 53:		Line 53:
	Relevant page: [[yiiguide:basics.namespace\|Fundamentals: Path Alias and Namespace]] in [[yiiguide:\|The Definitive Guide to Yii]].		Relevant page: [[yiiguide:basics.namespace\|Fundamentals: Path Alias and Namespace]] in [[yiiguide:\|The Definitive Guide to Yii]].

−	Typically, when you use a class in Yii, you will never have to use an "include" statement. That is because Yii will automatically recognize when you intend to use a class and automatically load it. Directories can be scanned by Yii to recognize class files for automatic inclusion using [[yii:YiiBase#import-detail\|Yii::import()]]. Furthermore, many directories are already imported, so there is no need to call the import method a second time. The bulk of importing in ~~X2Engine~~ is done in [[x2doc:ApplicationConfigBehavior\|ApplicationConfigBehavior]].	+	Typically, when you use a class in Yii, you will never have to use an "include" statement. That is because Yii will automatically recognize when you intend to use a class and automatically load it. Directories can be scanned by Yii to recognize class files for automatic inclusion using [[yii:YiiBase#import-detail\|Yii::import()]]. Furthermore, many directories are already imported, so there is no need to call the import method a second time. The bulk of importing in X2EngineCRM is done in [[x2doc:ApplicationConfigBehavior\|ApplicationConfigBehavior]].

@@ Line 42: / Line 42: @@
 : All core/base level model classes.
 ;<tt>modules/</tt>
-: Self-contained modules. Most of the subdirectories here contain modules whose names appear in the main menu. Each subdirectory typically has the same structure as the base application; they each will have directories named <tt>controllers</tt>, <tt>models</tt> and <tt>views</tt>. See [http://www.yiiframework.com/doc/guide/1.1/en/basics.module Fundamentals:Module] in [http://www.yiiframework.com/doc/guide/ The Definitive Guide to Yii] for more information.
+: Self-contained modules. Most of the subdirectories here contain modules whose names appear in the main menu. Each subdirectory typically has the same structure as the base application; they each will have directories named <tt>controllers</tt>, <tt>models</tt> and <tt>views</tt>. See [[yiiguide:basics.module|Fundamentals:Module]] in [[yiiguide:|The Definitive Guide to Yii]] for more information.
 ;<tt>runtime/</tt>
 : (For the application's use) Temporary files written to by the application