33 * Copyright © Magento, Inc. All rights reserved.
44 * See COPYING.txt for license details.
55 */
6+
67namespace Magento \Framework \DB \Adapter ;
78
89use Magento \Framework \DB \Ddl \Table ;
@@ -365,6 +366,7 @@ public function getIndexList($tableName, $schemaName = null);
365366
366367 /**
367368 * Add new Foreign Key to table
369+ *
368370 * If Foreign Key with same name is exist - it will be deleted
369371 *
370372 * @param string $fkName
@@ -373,7 +375,6 @@ public function getIndexList($tableName, $schemaName = null);
373375 * @param string $refTableName
374376 * @param string $refColumnName
375377 * @param string $onDelete
376- * @param string $onUpdate
377378 * @param boolean $purge trying remove invalid data
378379 * @param string $schemaName
379380 * @param string $refSchemaName
@@ -484,6 +485,7 @@ public function insert($table, array $bind);
484485
485486 /**
486487 * Inserts a table row with specified data
488+ *
487489 * Special for Zero values to identity column
488490 *
489491 * @param string $table
@@ -502,50 +504,52 @@ public function insertForce($table, array $bind);
502504 * If the $where parameter is an array of multiple clauses, they will be joined by AND, with each clause wrapped in
503505 * parenthesis. If you wish to use an OR, you must give a single clause that is an instance of {@see Zend_Db_Expr}
504506 *
505- * @param mixed $table The table to update.
506- * @param array $bind Column-value pairs.
507- * @param mixed $where UPDATE WHERE clause(s).
507+ * @param mixed $table The table to update.
508+ * @param array $bind Column-value pairs.
509+ * @param mixed $where UPDATE WHERE clause(s).
508510 * @return int The number of affected rows.
509511 */
510512 public function update ($ table , array $ bind , $ where = '' );
511513
512514 /**
513515 * Deletes table rows based on a WHERE clause.
514516 *
515- * @param mixed $table The table to update.
516- * @param mixed $where DELETE WHERE clause(s).
517+ * @param mixed $table The table to update.
518+ * @param mixed $where DELETE WHERE clause(s).
517519 * @return int The number of affected rows.
518520 */
519521 public function delete ($ table , $ where = '' );
520522
521523 /**
522524 * Prepares and executes an SQL statement with bound data.
523525 *
524- * @param mixed $sql The SQL statement with placeholders.
526+ * @param mixed $sql The SQL statement with placeholders.
525527 * May be a string or \Magento\Framework\DB\Select.
526- * @param mixed $bind An array of data or data itself to bind to the placeholders.
528+ * @param mixed $bind An array of data or data itself to bind to the placeholders.
527529 * @return \Zend_Db_Statement_Interface
528530 */
529531 public function query ($ sql , $ bind = []);
530532
531533 /**
532534 * Fetches all SQL result rows as a sequential array.
535+ *
533536 * Uses the current fetchMode for the adapter.
534537 *
535- * @param string|\Magento\Framework\DB\Select $sql An SQL SELECT statement.
536- * @param mixed $bind Data to bind into SELECT placeholders.
537- * @param mixed $fetchMode Override current fetch mode.
538+ * @param string|\Magento\Framework\DB\Select $sql An SQL SELECT statement.
539+ * @param mixed $bind Data to bind into SELECT placeholders.
540+ * @param mixed $fetchMode Override current fetch mode.
538541 * @return array
539542 */
540543 public function fetchAll ($ sql , $ bind = [], $ fetchMode = null );
541544
542545 /**
543546 * Fetches the first row of the SQL result.
547+ *
544548 * Uses the current fetchMode for the adapter.
545549 *
546550 * @param string|\Magento\Framework\DB\Select $sql An SQL SELECT statement.
547551 * @param mixed $bind Data to bind into SELECT placeholders.
548- * @param mixed $fetchMode Override current fetch mode.
552+ * @param mixed $fetchMode Override current fetch mode.
549553 * @return array
550554 */
551555 public function fetchRow ($ sql , $ bind = [], $ fetchMode = null );
@@ -622,9 +626,9 @@ public function quote($value, $type = null);
622626 * // $safe = "WHERE date < '2005-01-02'"
623627 * </code>
624628 *
625- * @param string $text The text with a placeholder.
626- * @param mixed $value The value to quote.
627- * @param string $type OPTIONAL SQL datatype
629+ * @param string $text The text with a placeholder.
630+ * @param mixed $value The value to quote.
631+ * @param string $type OPTIONAL SQL datatype
628632 * @param integer $count OPTIONAL count of placeholders to replace
629633 * @return string An SQL-safe quoted value placed into the original text.
630634 */
@@ -633,7 +637,7 @@ public function quoteInto($text, $value, $type = null, $count = null);
633637 /**
634638 * Quotes an identifier.
635639 *
636- * Accepts a string representing a qualified indentifier . For Example:
640+ * Accepts a string representing a qualified identifier . For Example:
637641 * <code>
638642 * $adapter->quoteIdentifier('myschema.mytable')
639643 * </code>
@@ -721,7 +725,8 @@ public function disallowDdlCache();
721725
722726 /**
723727 * Reset cached DDL data from cache
724- * if table name is null - reset all cached DDL data
728+ *
729+ * If table name is null - reset all cached DDL data
725730 *
726731 * @param string $tableName
727732 * @param string $schemaName OPTIONAL
@@ -741,6 +746,7 @@ public function saveDdlCache($tableCacheKey, $ddlType, $data);
741746
742747 /**
743748 * Load DDL data from cache
749+ *
744750 * Return false if cache does not exists
745751 *
746752 * @param string $tableCacheKey the table cache key
@@ -784,6 +790,7 @@ public function prepareSqlCondition($fieldName, $condition);
784790
785791 /**
786792 * Prepare value for save in column
793+ *
787794 * Return converted to column data type value
788795 *
789796 * @param array $column the column describe array
@@ -813,6 +820,7 @@ public function getIfNullSql($expression, $value = 0);
813820
814821 /**
815822 * Generate fragment of SQL, that combine together (concatenate) the results from data array
823+ *
816824 * All arguments in data must be quoted
817825 *
818826 * @param array $data
@@ -823,6 +831,7 @@ public function getConcatSql(array $data, $separator = null);
823831
824832 /**
825833 * Generate fragment of SQL that returns length of character string
834+ *
826835 * The string argument must be quoted
827836 *
828837 * @param string $string
@@ -931,6 +940,7 @@ public function getDateExtractSql($date, $unit);
931940
932941 /**
933942 * Retrieve valid table name
943+ *
934944 * Check table name length and allowed symbols
935945 *
936946 * @param string $tableName
@@ -950,6 +960,7 @@ public function getTriggerName($tableName, $time, $event);
950960
951961 /**
952962 * Retrieve valid index name
963+ *
953964 * Check index name length and allowed symbols
954965 *
955966 * @param string $tableName
@@ -961,6 +972,7 @@ public function getIndexName($tableName, $fields, $indexType = '');
961972
962973 /**
963974 * Retrieve valid foreign key name
975+ *
964976 * Check foreign key name length and allowed symbols
965977 *
966978 * @param string $priTableName
@@ -1047,6 +1059,7 @@ public function supportStraightJoin();
10471059
10481060 /**
10491061 * Adds order by random to select object
1062+ *
10501063 * Possible using integer field for optimization
10511064 *
10521065 * @param \Magento\Framework\DB\Select $select
@@ -1074,6 +1087,7 @@ public function getPrimaryKeyName($tableName, $schemaName = null);
10741087
10751088 /**
10761089 * Converts fetched blob into raw binary PHP data.
1090+ *
10771091 * Some DB drivers return blobs as hex-coded strings, so we need to process them.
10781092 *
10791093 * @param mixed $value
@@ -1114,6 +1128,8 @@ public function dropTrigger($triggerName, $schemaName = null);
11141128 public function getTables ($ likeCondition = null );
11151129
11161130 /**
1131+ * Generates case SQL fragment
1132+ *
11171133 * Generate fragment of SQL, that check value against multiple condition cases
11181134 * and return different result depends on them
11191135 *
0 commit comments