Commit 120b30ba authored by Marco Pivetta's avatar Marco Pivetta

Merge pull request #582 from JeroenDeDauw/index

Various doc imporvements in Index
parents 867824b7 e547ee28
...@@ -43,6 +43,7 @@ class Index extends AbstractAsset implements Constraint ...@@ -43,6 +43,7 @@ class Index extends AbstractAsset implements Constraint
/** /**
* Platform specific flags for indexes. * Platform specific flags for indexes.
* array($flagName => true)
* *
* @var array * @var array
*/ */
...@@ -50,10 +51,10 @@ class Index extends AbstractAsset implements Constraint ...@@ -50,10 +51,10 @@ class Index extends AbstractAsset implements Constraint
/** /**
* @param string $indexName * @param string $indexName
* @param array $columns * @param string[] $columns
* @param boolean $isUnique * @param boolean $isUnique
* @param boolean $isPrimary * @param boolean $isPrimary
* @param array $flags * @param string[] $flags
*/ */
public function __construct($indexName, array $columns, $isUnique = false, $isPrimary = false, array $flags = array()) public function __construct($indexName, array $columns, $isUnique = false, $isPrimary = false, array $flags = array())
{ {
...@@ -110,7 +111,7 @@ class Index extends AbstractAsset implements Constraint ...@@ -110,7 +111,7 @@ class Index extends AbstractAsset implements Constraint
} }
/** /**
* @return array * @return string[]
*/ */
public function getUnquotedColumns() public function getUnquotedColumns()
{ {
...@@ -182,7 +183,7 @@ class Index extends AbstractAsset implements Constraint ...@@ -182,7 +183,7 @@ class Index extends AbstractAsset implements Constraint
/** /**
* Checks if the other index already fulfills all the indexing and constraint needs of the current one. * Checks if the other index already fulfills all the indexing and constraint needs of the current one.
* *
* @param \Doctrine\DBAL\Schema\Index $other * @param Index $other
* *
* @return boolean * @return boolean
*/ */
...@@ -219,7 +220,7 @@ class Index extends AbstractAsset implements Constraint ...@@ -219,7 +220,7 @@ class Index extends AbstractAsset implements Constraint
/** /**
* Detects if the other index is a non-unique, non primary index that can be overwritten by this one. * Detects if the other index is a non-unique, non primary index that can be overwritten by this one.
* *
* @param \Doctrine\DBAL\Schema\Index $other * @param Index $other
* *
* @return boolean * @return boolean
*/ */
...@@ -241,7 +242,7 @@ class Index extends AbstractAsset implements Constraint ...@@ -241,7 +242,7 @@ class Index extends AbstractAsset implements Constraint
/** /**
* Returns platform specific flags for indexes. * Returns platform specific flags for indexes.
* *
* @return array * @return string[]
*/ */
public function getFlags() public function getFlags()
{ {
...@@ -255,7 +256,7 @@ class Index extends AbstractAsset implements Constraint ...@@ -255,7 +256,7 @@ class Index extends AbstractAsset implements Constraint
* *
* @param string $flag * @param string $flag
* *
* @return \Doctrine\DBAL\Schema\Index * @return Index
*/ */
public function addFlag($flag) public function addFlag($flag)
{ {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment