Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
Y
yii2
Project
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
PSDI Army
yii2
Commits
a57aeb2a
Commit
a57aeb2a
authored
Dec 23, 2014
by
Paul Klimov
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Doc comments at `yii\mongodb\*` fixed
parent
0adcd06c
Show whitespace changes
Inline
Side-by-side
Showing
6 changed files
with
14 additions
and
14 deletions
+14
-14
ActiveFixture.php
extensions/mongodb/ActiveFixture.php
+4
-4
ActiveQuery.php
extensions/mongodb/ActiveQuery.php
+2
-2
ActiveRecord.php
extensions/mongodb/ActiveRecord.php
+2
-2
Cache.php
extensions/mongodb/Cache.php
+1
-1
Generator.php
extensions/mongodb/gii/model/Generator.php
+3
-3
model.php
extensions/mongodb/gii/model/default/model.php
+2
-2
No files found.
extensions/mongodb/ActiveFixture.php
View file @
a57aeb2a
...
@@ -18,7 +18,7 @@ use yii\test\BaseActiveFixture;
...
@@ -18,7 +18,7 @@ use yii\test\BaseActiveFixture;
* specified by [[dataFile]] or overriding [[getData()]] if you want to use code to generate the fixture data.
* specified by [[dataFile]] or overriding [[getData()]] if you want to use code to generate the fixture data.
*
*
* When the fixture is being loaded, it will first call [[resetCollection()]] to remove any existing data in the collection.
* When the fixture is being loaded, it will first call [[resetCollection()]] to remove any existing data in the collection.
* It will then populate the
table
with the data returned by [[getData()]].
* It will then populate the
collection
with the data returned by [[getData()]].
*
*
* After the fixture is loaded, you can access the loaded data via the [[data]] property. If you set [[modelClass]],
* After the fixture is loaded, you can access the loaded data via the [[data]] property. If you set [[modelClass]],
* you will also be able to retrieve an instance of [[modelClass]] with the populated data via [[getModel()]].
* you will also be able to retrieve an instance of [[modelClass]] with the populated data via [[getModel()]].
...
@@ -34,7 +34,7 @@ class ActiveFixture extends BaseActiveFixture
...
@@ -34,7 +34,7 @@ class ActiveFixture extends BaseActiveFixture
public
$db
=
'mongodb'
;
public
$db
=
'mongodb'
;
/**
/**
* @var string|array the collection name that this fixture is about. If this property is not set,
* @var string|array the collection name that this fixture is about. If this property is not set,
* the
table
name will be determined via [[modelClass]].
* the
collection
name will be determined via [[modelClass]].
* @see Connection::getCollection()
* @see Connection::getCollection()
*/
*/
public
$collectionName
;
public
$collectionName
;
...
@@ -53,7 +53,7 @@ class ActiveFixture extends BaseActiveFixture
...
@@ -53,7 +53,7 @@ class ActiveFixture extends BaseActiveFixture
/**
/**
* Loads the fixture data.
* Loads the fixture data.
* The default implementation will first reset the
DB table
and then populate it with the data
* The default implementation will first reset the
MongoDB collection
and then populate it with the data
* returned by [[getData()]].
* returned by [[getData()]].
*/
*/
public
function
load
()
public
function
load
()
...
@@ -90,7 +90,7 @@ class ActiveFixture extends BaseActiveFixture
...
@@ -90,7 +90,7 @@ class ActiveFixture extends BaseActiveFixture
* This method is called by [[loadData()]] to get the needed fixture data.
* This method is called by [[loadData()]] to get the needed fixture data.
*
*
* The default implementation will try to return the fixture data by including the external file specified by [[dataFile]].
* The default implementation will try to return the fixture data by including the external file specified by [[dataFile]].
* The file should return an array of data rows (column name => column value), each corresponding to a row in the
table
.
* The file should return an array of data rows (column name => column value), each corresponding to a row in the
collection
.
*
*
* If the data file does not exist, an empty array will be returned.
* If the data file does not exist, an empty array will be returned.
*
*
...
...
extensions/mongodb/ActiveQuery.php
View file @
a57aeb2a
...
@@ -48,9 +48,9 @@ use yii\db\ActiveRelationTrait;
...
@@ -48,9 +48,9 @@ use yii\db\ActiveRelationTrait;
* a getter method which calls one of the above methods and returns the created ActiveQuery object.
* a getter method which calls one of the above methods and returns the created ActiveQuery object.
*
*
* A relation is specified by [[link]] which represents the association between columns
* A relation is specified by [[link]] which represents the association between columns
* of different
table
s; and the multiplicity of the relation is indicated by [[multiple]].
* of different
collection
s; and the multiplicity of the relation is indicated by [[multiple]].
*
*
* If a relation involves a junction
table
, it may be specified by [[via()]].
* If a relation involves a junction
collection
, it may be specified by [[via()]].
* This methods may only be called in a relational context. Same is true for [[inverseOf()]], which
* This methods may only be called in a relational context. Same is true for [[inverseOf()]], which
* marks a relation as inverse of another relation.
* marks a relation as inverse of another relation.
*
*
...
...
extensions/mongodb/ActiveRecord.php
View file @
a57aeb2a
...
@@ -111,7 +111,7 @@ abstract class ActiveRecord extends BaseActiveRecord
...
@@ -111,7 +111,7 @@ abstract class ActiveRecord extends BaseActiveRecord
*
*
* By default this method returns the class name as the collection name by calling [[Inflector::camel2id()]].
* By default this method returns the class name as the collection name by calling [[Inflector::camel2id()]].
* For example, 'Customer' becomes 'customer', and 'OrderItem' becomes
* For example, 'Customer' becomes 'customer', and 'OrderItem' becomes
* 'order_item'. You may override this method if the
table
is not named after this convention.
* 'order_item'. You may override this method if the
collection
is not named after this convention.
* @return string|array the collection name
* @return string|array the collection name
*/
*/
public
static
function
collectionName
()
public
static
function
collectionName
()
...
@@ -332,7 +332,7 @@ abstract class ActiveRecord extends BaseActiveRecord
...
@@ -332,7 +332,7 @@ abstract class ActiveRecord extends BaseActiveRecord
/**
/**
* Returns a value indicating whether the given active record is the same as the current one.
* Returns a value indicating whether the given active record is the same as the current one.
* The comparison is made by comparing the
table
names and the primary key values of the two active records.
* The comparison is made by comparing the
collection
names and the primary key values of the two active records.
* If one of the records [[isNewRecord|is new]] they are also considered not equal.
* If one of the records [[isNewRecord|is new]] they are also considered not equal.
* @param ActiveRecord $record record to compare to
* @param ActiveRecord $record record to compare to
* @return boolean whether the two active records refer to the same row in the same Mongo collection.
* @return boolean whether the two active records refer to the same row in the same Mongo collection.
...
...
extensions/mongodb/Cache.php
View file @
a57aeb2a
...
@@ -16,7 +16,7 @@ use yii\di\Instance;
...
@@ -16,7 +16,7 @@ use yii\di\Instance;
*
*
* By default, Cache stores session data in a MongoDB collection named 'cache' inside the default database.
* By default, Cache stores session data in a MongoDB collection named 'cache' inside the default database.
* This collection is better to be pre-created with fields 'id' and 'expire' indexed.
* This collection is better to be pre-created with fields 'id' and 'expire' indexed.
* The
table
name can be changed by setting [[cacheCollection]].
* The
collection
name can be changed by setting [[cacheCollection]].
*
*
* Please refer to [[\yii\caching\Cache]] for common cache operations that are supported by Cache.
* Please refer to [[\yii\caching\Cache]] for common cache operations that are supported by Cache.
*
*
...
...
extensions/mongodb/gii/model/Generator.php
View file @
a57aeb2a
...
@@ -194,7 +194,7 @@ class Generator extends \yii\gii\Generator
...
@@ -194,7 +194,7 @@ class Generator extends \yii\gii\Generator
}
}
/**
/**
* Generates validation rules for the specified
table
.
* Generates validation rules for the specified
collection
.
* @param array $attributes the list of attributes
* @param array $attributes the list of attributes
* @return array the generated validation rules
* @return array the generated validation rules
*/
*/
...
@@ -262,8 +262,8 @@ class Generator extends \yii\gii\Generator
...
@@ -262,8 +262,8 @@ class Generator extends \yii\gii\Generator
}
}
/**
/**
* Generates a class name from the specified
table
name.
* Generates a class name from the specified
collection
name.
* @param string $collectionName the
table
name (which may contain schema prefix)
* @param string $collectionName the
collection
name (which may contain schema prefix)
* @return string the generated class name
* @return string the generated class name
*/
*/
protected
function
generateClassName
(
$collectionName
)
protected
function
generateClassName
(
$collectionName
)
...
...
extensions/mongodb/gii/model/default/model.php
View file @
a57aeb2a
<?php
<?php
/**
/**
* This is the template for generating the model class of a specified
table
.
* This is the template for generating the model class of a specified
collection
.
*/
*/
/* @var $this yii\web\View */
/* @var $this yii\web\View */
/* @var $generator yii\mongodb\gii\model\Generator */
/* @var $generator yii\mongodb\gii\model\Generator */
/* @var $collectionName string full
table
name */
/* @var $collectionName string full
collection
name */
/* @var $attributes array list of attribute names */
/* @var $attributes array list of attribute names */
/* @var $className string class name */
/* @var $className string class name */
/* @var $labels string[] list of attribute labels (name => label) */
/* @var $labels string[] list of attribute labels (name => label) */
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment