添加注释和README文件

fancyecommerce · fancyecommerce · commit cdcfb444a9c0 · 2017-07-04T18:38:47.000+08:00
diff --git a/app/README.md b/app/README.md
@@ -0,0 +1,5 @@
+fecshop的应用部分
+
+各个入口的模块，配置，模板等都在这里面
+
+详情可以打开各个入口包查看相应的功能
diff --git a/components/README.md b/components/README.md
@@ -0,0 +1 @@
+fecshop 自定义的组件部分
diff --git a/config/README.md b/config/README.md
@@ -0,0 +1,8 @@
+FECSHOP配置部分
+==============
+
+compoents 是组件部分的配置
+
+services是服务部分的配置
+
+xunsearch是xunsearch搜索引擎部分的配置
diff --git a/interfaces/README.md b/interfaces/README.md
@@ -0,0 +1 @@
+fecshop 接口定义部分
diff --git a/lib/README.md b/lib/README.md
@@ -0,0 +1 @@
+第三方库
diff --git a/migrations/README.md b/migrations/README.md
@@ -1,38 +1,42 @@
-### 1. ����Ǩ���ļ������
 
-1.1 ����mysql�ļ�:
+这里是执行的命令，在安装fecshop的时候，文档里面已经
+写好了migrate的命令，您不需要再次执行下面的操作。
+
+### 1. 生成迁移文件的命令：
+
+1.1 生成mysql文件:
 
 ```
 ./yii migrate/create   --migrationPath=@fecshop/migrations/mysqldb    fecshop_tables
 ```
 
-1.2 ����mongodb�ļ�:
+1.2 生成mongodb文件:
 
 ```
 ./yii mongodb-migrate/create   --migrationPath=@fecshop/migrations/mongodb    fecshop_tables
 ```
 
 
-### 2. Ǩ�Ƶ�����������ݿ����
+### 2. 迁移的命令（导入数据库表）
 
-2.1 mysql(����mysql�ı������ݣ�����):
+2.1 mysql(导入mysql的表，数据，索引):
 
 ```
 ./yii migrate --interactive=0 --migrationPath=@fecshop/migrations/mysqldb
 ```
 
 
-2.2 mongodb(����mongodb�ı������ݣ�����):
+2.2 mongodb(导入mongodb的表，数据，索引):
 
 ```
 ./yii mongodb-migrate  --interactive=0 --migrationPath=@fecshop/migrations/mongodb
 ```
 
-2.2.2 mongodb��ʾ�����ݴ��·��Ϊ��
+2.2.2 mongodb的示例数据存放路径为：
 
 /vendor/fancyecommerce/fecshop/migrations/mongodb-example-data/example_data.js
 
-����ͨ��mongodb�ĺ�̨������ͨ��php��rockmongo��װ��Щmongodb�е�ʾ�����ݡ�
+可以通过mongodb的后台，或者通过php的rockmongo安装这些mongodb中的示例数据。
 
 
 
diff --git a/models/README.md b/models/README.md
@@ -0,0 +1 @@
+数据库的model部分
diff --git a/models/mongodb/Category.php b/models/mongodb/Category.php
@@ -17,11 +17,17 @@
  */
 class Category extends ActiveRecord
 {
+    /**
+     * mongodb collection 的名字，相当于mysql的table name
+     */
     public static function collectionName()
     {
         return 'category';
     }
-
+    /**
+     * mongodb是没有表结构的，因此不能像mysql那样取出来表结构的字段作为model的属性
+     * 因此，需要自己定义model的属性，下面的方法就是这个作用
+     */
     public function attributes()
     {
         return [
diff --git a/models/mongodb/FecshopServiceLog.php b/models/mongodb/FecshopServiceLog.php
@@ -17,11 +17,17 @@
  */
 class FecshopServiceLog extends ActiveRecord
 {
+    /**
+     * mongodb collection 的名字，相当于mysql的table name
+     */
     public static function collectionName()
     {
         return 'fecshop_service_log';
     }
-
+    /**
+     * mongodb是没有表结构的，因此不能像mysql那样取出来表结构的字段作为model的属性
+     * 因此，需要自己定义model的属性，下面的方法就是这个作用
+     */
     public function attributes()
     {
         return [
diff --git a/models/mongodb/Product.php b/models/mongodb/Product.php
@@ -20,9 +20,7 @@ class Product extends ActiveRecord
     public static $_customProductAttrs;
 
     /**
-     * 需要做的索引  [sku],[spu],
-     * [category_id,score],[category_id,created_at]
-     * [category_id,price].
+     * mongodb collection 的名字，相当于mysql的table name
      */
     public static function collectionName()
     {
@@ -36,7 +34,10 @@ public static function addCustomProductAttrs($attrs)
     {
         self::$_customProductAttrs = $attrs;
     }
-
+    /**
+     * mongodb是没有表结构的，因此不能像mysql那样取出来表结构的字段作为model的属性
+     * 因此，需要自己定义model的属性，下面的方法就是这个作用
+     */
     public function attributes()
     {
         $origin = [
@@ -96,7 +97,12 @@ public function attributes()
 
         return $origin;
     }
-
+    /**
+     * 给model对应的表创建索引的方法
+     * 在indexs数组中填写索引，如果有多个索引，可以填写多行
+     * 在migrate的时候会运行创建索引，譬如：
+     * @fecshop/migrations/mongodb/m170228_072455_fecshop_tables
+     */
     public static function create_index()
     {
         $indexs = [
diff --git a/models/mongodb/Search.php b/models/mongodb/Search.php
@@ -23,7 +23,9 @@ class Search extends ActiveRecord
      */
     public static $_lang;
     public static $_filterColumns;
-
+    /**
+     * mongodb collection 的名字，相当于mysql的table name
+     */
     public static function collectionName()
     {
         if (self::$_lang) {
@@ -33,7 +35,10 @@ public static function collectionName()
             return 'full_search_product_no_lang';
         }
     }
-
+    /**
+     * mongodb是没有表结构的，因此不能像mysql那样取出来表结构的字段作为model的属性
+     * 因此，需要自己定义model的属性，下面的方法就是这个作用
+     */
     public function attributes()
     {
         $origin = [
diff --git a/models/mongodb/cms/Article.php b/models/mongodb/cms/Article.php
@@ -17,11 +17,17 @@
  */
 class Article extends ActiveRecord
 {
+    /**
+     * mongodb collection 的名字，相当于mysql的table name
+     */
     public static function collectionName()
     {
         return 'article';
     }
-
+    /**
+     * mongodb是没有表结构的，因此不能像mysql那样取出来表结构的字段作为model的属性
+     * 因此，需要自己定义model的属性，下面的方法就是这个作用
+     */
     public function attributes()
     {
         return [
@@ -38,7 +44,12 @@ public function attributes()
 
         ];
     }
-
+    /**
+     * 给model对应的表创建索引的方法
+     * 在indexs数组中填写索引，如果有多个索引，可以填写多行
+     * 在migrate的时候会运行创建索引，譬如：
+     * @fecshop/migrations/mongodb/m170228_072455_fecshop_tables
+     */
     public static function create_index()
     {
         $indexs = [
diff --git a/models/mongodb/cms/StaticBlock.php b/models/mongodb/cms/StaticBlock.php
@@ -17,11 +17,17 @@
  */
 class StaticBlock extends ActiveRecord
 {
+    /**
+     * mongodb collection 的名字，相当于mysql的table name
+     */
     public static function collectionName()
     {
         return 'static_block';
     }
-
+    /**
+     * mongodb是没有表结构的，因此不能像mysql那样取出来表结构的字段作为model的属性
+     * 因此，需要自己定义model的属性，下面的方法就是这个作用
+     */
     public function attributes()
     {
         return [
@@ -35,7 +41,12 @@ public function attributes()
             'created_user_id',
         ];
     }
-
+    /**
+     * 给model对应的表创建索引的方法
+     * 在indexs数组中填写索引，如果有多个索引，可以填写多行
+     * 在migrate的时候会运行创建索引，譬如：
+     * @fecshop/migrations/mongodb/m170228_072455_fecshop_tables
+     */
     public static function create_index()
     {
         $indexs = [
diff --git a/models/mongodb/customer/Newsletter.php b/models/mongodb/customer/Newsletter.php
@@ -19,12 +19,17 @@ class Newsletter extends ActiveRecord
 {
     const ENABLE_STATUS = 1;
     const DISABLE_STATUS = 10;
-
+    /**
+     * mongodb collection 的名字，相当于mysql的table name
+     */
     public static function collectionName()
     {
         return 'newsletter';
     }
-
+    /**
+     * mongodb是没有表结构的，因此不能像mysql那样取出来表结构的字段作为model的属性
+     * 因此，需要自己定义model的属性，下面的方法就是这个作用
+     */
     public function attributes()
     {
         return [
@@ -40,7 +45,12 @@ public static function primaryKey()
     {
         return '_id';
     }
-
+    /**
+     * 给model对应的表创建索引的方法
+     * 在indexs数组中填写索引，如果有多个索引，可以填写多行
+     * 在migrate的时候会运行创建索引，譬如：
+     * @fecshop/migrations/mongodb/m170228_072455_fecshop_tables
+     */
     public static function create_index()
     {
         $indexs = [
diff --git a/models/mongodb/product/Favorite.php b/models/mongodb/product/Favorite.php
@@ -17,11 +17,17 @@
  */
 class Favorite extends ActiveRecord
 {
+    /**
+     * mongodb collection 的名字，相当于mysql的table name
+     */
     public static function collectionName()
     {
         return 'favorite';
     }
-
+    /**
+     * mongodb是没有表结构的，因此不能像mysql那样取出来表结构的字段作为model的属性
+     * 因此，需要自己定义model的属性，下面的方法就是这个作用
+     */
     public function attributes()
     {
         $origin = [
@@ -35,7 +41,12 @@ public function attributes()
 
         return $origin;
     }
-
+    /**
+     * 给model对应的表创建索引的方法
+     * 在indexs数组中填写索引，如果有多个索引，可以填写多行
+     * 在migrate的时候会运行创建索引，譬如：
+     * @fecshop/migrations/mongodb/m170228_072455_fecshop_tables
+     */
     public static function create_index()
     {
         $indexs = [
diff --git a/models/mongodb/product/Review.php b/models/mongodb/product/Review.php
@@ -24,7 +24,9 @@ class Review extends ActiveRecord
     const ACTIVE_STATUS = 1;
     // 审核拒绝的状态
     const REFUSE_STATUS = 2;
-
+    /**
+     * mongodb collection 的名字，相当于mysql的table name
+     */
     public static function collectionName()
     {
         return 'review';
@@ -35,7 +37,10 @@ public static function addCustomAttrs($attrs)
     {
         self::$_customAttrs = $attrs;
     }
-
+    /**
+     * mongodb是没有表结构的，因此不能像mysql那样取出来表结构的字段作为model的属性
+     * 因此，需要自己定义model的属性，下面的方法就是这个作用
+     */
     public function attributes($origin = false)
     {
         $origin = [
@@ -65,7 +70,12 @@ public function attributes($origin = false)
 
         return $origin;
     }
-
+    /**
+     * 给model对应的表创建索引的方法
+     * 在indexs数组中填写索引，如果有多个索引，可以填写多行
+     * 在migrate的时候会运行创建索引，譬如：
+     * @fecshop/migrations/mongodb/m170228_072455_fecshop_tables
+     */
     public static function create_index()
     {
         $indexs = [
diff --git a/models/mongodb/product/ViewLog.php b/models/mongodb/product/ViewLog.php
@@ -18,7 +18,9 @@
 class ViewLog extends ActiveRecord
 {
     public static $_collectionName;
-
+    /**
+     * mongodb collection 的名字，相当于mysql的table name
+     */
     public static function collectionName()
     {
         return self::$_collectionName;
@@ -28,7 +30,10 @@ public static function setCurrentCollectionName($name)
     {
         self::$_collectionName = $name;
     }
-
+    /**
+     * mongodb是没有表结构的，因此不能像mysql那样取出来表结构的字段作为model的属性
+     * 因此，需要自己定义model的属性，下面的方法就是这个作用
+     */
     public function attributes()
     {
         return [
diff --git a/models/mongodb/url/UrlRewrite.php b/models/mongodb/url/UrlRewrite.php
diff --git a/models/mysqldb/Customer.php b/models/mysqldb/Customer.php
diff --git a/models/xunsearch/Search.php b/models/xunsearch/Search.php
diff --git a/shell/README.md b/shell/README.md

Original file line number	Diff line number	Diff line change
`@@ -17,11 +17,17 @@`
`17`	`17`	`*/`
`18`	`18`	`class Category extends ActiveRecord`
`19`	`19`	`{`
	`20`	`+ /**`
	`21`	`+ * mongodb collection 的名字，相当于mysql的table name`
	`22`	`+ */`
`20`	`23`	`public static function collectionName()`
`21`	`24`	`{`
`22`	`25`	`return 'category';`
`23`	`26`	`}`
`24`		`-`
	`27`	`+ /**`
	`28`	`+ * mongodb是没有表结构的，因此不能像mysql那样取出来表结构的字段作为model的属性`
	`29`	`+ * 因此，需要自己定义model的属性，下面的方法就是这个作用`
	`30`	`+ */`
`25`	`31`	`public function attributes()`
`26`	`32`	`{`
`27`	`33`	`return [`
Original file line number	Diff line number	Diff line change
`@@ -20,9 +20,7 @@ class Product extends ActiveRecord`
`20`	`20`	`public static $_customProductAttrs;`
`21`	`21`
`22`	`22`	`/**`
`23`		`- * 需要做的索引 [sku],[spu],`
`24`		`- * [category_id,score],[category_id,created_at]`
`25`		`- * [category_id,price].`
	`23`	`+ * mongodb collection 的名字，相当于mysql的table name`
`26`	`24`	`*/`
`27`	`25`	`public static function collectionName()`
`28`	`26`	`{`
`@@ -36,7 +34,10 @@ public static function addCustomProductAttrs($attrs)`
`36`	`34`	`{`
`37`	`35`	`self::$_customProductAttrs = $attrs;`
`38`	`36`	`}`
`39`		`-`
	`37`	`+ /**`
	`38`	`+ * mongodb是没有表结构的，因此不能像mysql那样取出来表结构的字段作为model的属性`
	`39`	`+ * 因此，需要自己定义model的属性，下面的方法就是这个作用`
	`40`	`+ */`
`40`	`41`	`public function attributes()`
`41`	`42`	`{`
`42`	`43`	`$origin = [`
`@@ -96,7 +97,12 @@ public function attributes()`
`96`	`97`
`97`	`98`	`return $origin;`
`98`	`99`	`}`
`99`		`-`
	`100`	`+ /**`
	`101`	`+ * 给model对应的表创建索引的方法`
	`102`	`+ * 在indexs数组中填写索引，如果有多个索引，可以填写多行`
	`103`	`+ * 在migrate的时候会运行创建索引，譬如：`
	`104`	`+ * @fecshop/migrations/mongodb/m170228_072455_fecshop_tables`
	`105`	`+ */`
`100`	`106`	`public static function create_index()`
`101`	`107`	`{`
`102`	`108`	`$indexs = [`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,9 @@ class Search extends ActiveRecord`
`23`	`23`	`*/`
`24`	`24`	`public static $_lang;`
`25`	`25`	`public static $_filterColumns;`
`26`		`-`
	`26`	`+ /**`
	`27`	`+ * mongodb collection 的名字，相当于mysql的table name`
	`28`	`+ */`
`27`	`29`	`public static function collectionName()`
`28`	`30`	`{`
`29`	`31`	`if (self::$_lang) {`
`@@ -33,7 +35,10 @@ public static function collectionName()`
`33`	`35`	`return 'full_search_product_no_lang';`
`34`	`36`	`}`
`35`	`37`	`}`
`36`		`-`
	`38`	`+ /**`
	`39`	`+ * mongodb是没有表结构的，因此不能像mysql那样取出来表结构的字段作为model的属性`
	`40`	`+ * 因此，需要自己定义model的属性，下面的方法就是这个作用`
	`41`	`+ */`
`37`	`42`	`public function attributes()`
`38`	`43`	`{`
`39`	`44`	`$origin = [`
Original file line number	Diff line number	Diff line change
`@@ -19,12 +19,17 @@ class Newsletter extends ActiveRecord`
`19`	`19`	`{`
`20`	`20`	`const ENABLE_STATUS = 1;`
`21`	`21`	`const DISABLE_STATUS = 10;`
`22`		`-`
	`22`	`+ /**`
	`23`	`+ * mongodb collection 的名字，相当于mysql的table name`
	`24`	`+ */`
`23`	`25`	`public static function collectionName()`
`24`	`26`	`{`
`25`	`27`	`return 'newsletter';`
`26`	`28`	`}`
`27`		`-`
	`29`	`+ /**`
	`30`	`+ * mongodb是没有表结构的，因此不能像mysql那样取出来表结构的字段作为model的属性`
	`31`	`+ * 因此，需要自己定义model的属性，下面的方法就是这个作用`
	`32`	`+ */`
`28`	`33`	`public function attributes()`
`29`	`34`	`{`
`30`	`35`	`return [`
`@@ -40,7 +45,12 @@ public static function primaryKey()`
`40`	`45`	`{`
`41`	`46`	`return '_id';`
`42`	`47`	`}`
`43`		`-`
	`48`	`+ /**`
	`49`	`+ * 给model对应的表创建索引的方法`
	`50`	`+ * 在indexs数组中填写索引，如果有多个索引，可以填写多行`
	`51`	`+ * 在migrate的时候会运行创建索引，譬如：`
	`52`	`+ * @fecshop/migrations/mongodb/m170228_072455_fecshop_tables`
	`53`	`+ */`
`44`	`54`	`public static function create_index()`
`45`	`55`	`{`
`46`	`56`	`$indexs = [`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,9 @@ class Review extends ActiveRecord`
`24`	`24`	`const ACTIVE_STATUS = 1;`
`25`	`25`	`// 审核拒绝的状态`
`26`	`26`	`const REFUSE_STATUS = 2;`
`27`		`-`
	`27`	`+ /**`
	`28`	`+ * mongodb collection 的名字，相当于mysql的table name`
	`29`	`+ */`
`28`	`30`	`public static function collectionName()`
`29`	`31`	`{`
`30`	`32`	`return 'review';`
`@@ -35,7 +37,10 @@ public static function addCustomAttrs($attrs)`
`35`	`37`	`{`
`36`	`38`	`self::$_customAttrs = $attrs;`
`37`	`39`	`}`
`38`		`-`
	`40`	`+ /**`
	`41`	`+ * mongodb是没有表结构的，因此不能像mysql那样取出来表结构的字段作为model的属性`
	`42`	`+ * 因此，需要自己定义model的属性，下面的方法就是这个作用`
	`43`	`+ */`
`39`	`44`	`public function attributes($origin = false)`
`40`	`45`	`{`
`41`	`46`	`$origin = [`
`@@ -65,7 +70,12 @@ public function attributes($origin = false)`
`65`	`70`
`66`	`71`	`return $origin;`
`67`	`72`	`}`
`68`		`-`
	`73`	`+ /**`
	`74`	`+ * 给model对应的表创建索引的方法`
	`75`	`+ * 在indexs数组中填写索引，如果有多个索引，可以填写多行`
	`76`	`+ * 在migrate的时候会运行创建索引，譬如：`
	`77`	`+ * @fecshop/migrations/mongodb/m170228_072455_fecshop_tables`
	`78`	`+ */`
`69`	`79`	`public static function create_index()`
`70`	`80`	`{`
`71`	`81`	`$indexs = [`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,9 @@`
`18`	`18`	`class ViewLog extends ActiveRecord`
`19`	`19`	`{`
`20`	`20`	`public static $_collectionName;`
`21`		`-`
	`21`	`+ /**`
	`22`	`+ * mongodb collection 的名字，相当于mysql的table name`
	`23`	`+ */`
`22`	`24`	`public static function collectionName()`
`23`	`25`	`{`
`24`	`26`	`return self::$_collectionName;`
`@@ -28,7 +30,10 @@ public static function setCurrentCollectionName($name)`
`28`	`30`	`{`
`29`	`31`	`self::$_collectionName = $name;`
`30`	`32`	`}`
`31`		`-`
	`33`	`+ /**`
	`34`	`+ * mongodb是没有表结构的，因此不能像mysql那样取出来表结构的字段作为model的属性`
	`35`	`+ * 因此，需要自己定义model的属性，下面的方法就是这个作用`
	`36`	`+ */`
`32`	`37`	`public function attributes()`
`33`	`38`	`{`
`34`	`39`	`return [`