diff --git a/.appveyor.yml b/.appveyor.yml index 2cda9a7..3f10630 100644 --- a/.appveyor.yml +++ b/.appveyor.yml @@ -19,6 +19,7 @@ before_test: - echo extension=php_curl.dll >> php.ini - echo extension=php_gd2.dll >> php.ini - echo extension=php_tidy.dll >> php.ini + - echo extension=php_fileinfo.dll >> php.ini - php -r "readfile('http://getcomposer.org/installer');" | php - php -r "readfile('https://dl.dropboxusercontent.com/u/7129062/sqlsrv_unofficial_3.0.2.2.zip');" > sqlsrv.zip - unzip sqlsrv.zip @@ -40,4 +41,4 @@ test_script: environment: DB: MSSQL - CORE_RELEASE: 3 \ No newline at end of file + CORE_RELEASE: master diff --git a/.upgrade.yml b/.upgrade.yml new file mode 100644 index 0000000..a343f0e --- /dev/null +++ b/.upgrade.yml @@ -0,0 +1,8 @@ +mappings: + MSSQLAzureDatabase: SilverStripe\MSSQL\MSSQLAzureDatabase + MSSQLDatabase: SilverStripe\MSSQL\MSSQLDatabase + MSSQLDatabaseConfigurationHelper: SilverStripe\MSSQL\MSSQLDatabaseConfigurationHelper + MSSQLQueryBuilder: SilverStripe\MSSQL\MSSQLQueryBuilder + MSSQLSchemaManager: SilverStripe\MSSQL\MSSQLSchemaManager + SQLServerConnector: SilverStripe\MSSQL\SQLServerConnector + SQLServerQuery: SilverStripe\MSSQL\SQLServerQuery diff --git a/_config/connectors.yml b/_config/connectors.yml index bdd9117..250ddfe 100644 --- a/_config/connectors.yml +++ b/_config/connectors.yml @@ -4,22 +4,29 @@ name: mssqlconnectors Injector: # Connect using PDO MSSQLPDODatabase: - class: 'MSSQLDatabase' + class: 'SilverStripe\MSSQL\MSSQLDatabase' properties: connector: %$PDOConnector schemaManager: %$MSSQLSchemaManager queryBuilder: %$MSSQLQueryBuilder # Uses sqlsrv_connect MSSQLDatabase: - class: 'MSSQLDatabase' + class: 'SilverStripe\MSSQL\MSSQLDatabase' properties: connector: %$SQLServerConnector schemaManager: %$MSSQLSchemaManager queryBuilder: %$MSSQLQueryBuilder # Uses sqlsrv_connect to connect to a MS Azure Database MSSQLAzureDatabase: - class: 'MSSQLAzureDatabase' + class: 'SilverStripe\MSSQL\MSSQLAzureDatabase' properties: connector: %$SQLServerConnector schemaManager: %$MSSQLSchemaManager - queryBuilder: %$MSSQLQueryBuilder \ No newline at end of file + queryBuilder: %$MSSQLQueryBuilder + SQLServerConnector: + class: 'SilverStripe\MSSQL\SQLServerConnector' + type: prototype + MSSQLSchemaManager: + class: 'SilverStripe\MSSQL\MSSQLSchemaManager' + MSSQLQueryBuilder: + class: 'SilverStripe\MSSQL\MSSQLQueryBuilder' diff --git a/_register_database.php b/_register_database.php index 1cb9006..db5de30 100644 --- a/_register_database.php +++ b/_register_database.php @@ -1,6 +1,7 @@ 'MSSQLPDODatabase', 'title' => 'SQL Server 2008 (using PDO)', @@ -13,6 +14,7 @@ DatabaseAdapterRegistry::register(array( )); // Basic driver using sqlsrv connector +/** @skipUpgrade */ DatabaseAdapterRegistry::register(array( 'class' => 'MSSQLDatabase', 'title' => 'SQL Server 2008 (using sqlsrv)', @@ -31,6 +33,7 @@ DatabaseAdapterRegistry::register(array( )); // MS Azure uses an online database +/** @skipUpgrade */ DatabaseAdapterRegistry::register(array( 'class' => 'MSSQLAzureDatabase', 'title' => 'MS Azure Database (using sqlsrv)', diff --git a/code/MSSQLAzureDatabase.php b/code/MSSQLAzureDatabase.php index 9b9c734..24d58e8 100644 --- a/code/MSSQLAzureDatabase.php +++ b/code/MSSQLAzureDatabase.php @@ -1,29 +1,31 @@ * @package mssql */ class MSSQLAzureDatabase extends MSSQLDatabase { - + /** * List of parameters used to create new Azure connections between databases - * + * * @var array */ protected $parameters = array(); @@ -47,15 +49,15 @@ class MSSQLAzureDatabase extends MSSQLDatabase * - database: The database to connect to * - windowsauthentication: Not supported for Azure */ - protected function connect($parameters) + public function connect($parameters) { $this->parameters = $parameters; $this->connectDatabase($parameters['database']); } - + /** * Connect to a database using the provided parameters - * + * * @param string $database */ protected function connectDatabase($database) @@ -85,10 +87,11 @@ class MSSQLAzureDatabase extends MSSQLDatabase * to reinitialize the database connection with the requested * database name. * @see http://msdn.microsoft.com/en-us/library/windowsazure/ee336288.aspx - * - * @param type $name The database name to switch to - * @param type $create - * @param type $errorLevel + * + * @param string $name The database name to switch to + * @param bool $create + * @param bool|int $errorLevel + * @return bool */ public function selectDatabase($name, $create = false, $errorLevel = E_USER_ERROR) { diff --git a/code/MSSQLDatabase.php b/code/MSSQLDatabase.php index 27bf4aa..bce8568 100644 --- a/code/MSSQLDatabase.php +++ b/code/MSSQLDatabase.php @@ -1,4 +1,17 @@ update('MSSQLDatabase', 'collation', $collation); + Config::inst()->update('SilverStripe\\MSSQL\\MSSQLDatabase', 'collation', $collation); } - + /** * The default collation of the MSSQL nvarchar fields that we create. * We don't apply this to the database as a whole, so that we can use * unicode collations. - * + * * @return string */ public static function get_collation() { - return Config::inst()->get('MSSQLDatabase', 'collation'); + return Config::inst()->get('SilverStripe\\MSSQL\\MSSQLDatabase', 'collation'); } /** @@ -94,7 +107,7 @@ class MSSQLDatabase extends SS_Database * - username: The username to log on with * - password: The password to log on with * - database: The database to connect to - * - windowsauthentication: Set to true to use windows authentication + * - windowsauthentication: Set to true to use windows authentication * instead of username/password */ public function connect($parameters) @@ -119,7 +132,7 @@ class MSSQLDatabase extends SS_Database } return $this->fullTextEnabled; } - + /** * Checks whether the current SQL Server version has full-text * support installed and full-text is enabled for this database. @@ -133,7 +146,7 @@ class MSSQLDatabase extends SS_Database if (!$isInstalled) { return false; } - + // Check if current database is enabled $database = $this->getSelectedDatabase(); $enabledForDb = $this->preparedQuery( @@ -157,11 +170,11 @@ class MSSQLDatabase extends SS_Database { return "sqlsrv"; } - + public function selectDatabase($name, $create = false, $errorLevel = E_USER_ERROR) { $this->fullTextEnabled = null; - + return parent::selectDatabase($name, $create, $errorLevel); } @@ -191,9 +204,16 @@ class MSSQLDatabase extends SS_Database * Picks up the fulltext-indexed tables from the database and executes search on all of them. * Results are obtained as ID-ClassName pairs which is later used to reconstruct the DataObjectSet. * - * @param array classesToSearch computes all descendants and includes them. Check is done via WHERE clause. + * @param array $classesToSearch computes all descendants and includes them. Check is done via WHERE clause. * @param string $keywords Keywords as a space separated string - * @return object DataObjectSet of result pages + * @param int $start + * @param int $pageLength + * @param string $sortBy + * @param string $extraFilter + * @param bool $booleanSearch + * @param string $alternativeFileFilter + * @param bool $invertedMatch + * @return PaginatedList DataObjectSet of result pages */ public function searchEngine($classesToSearch, $keywords, $start, $pageLength, $sortBy = "Relevance DESC", $extraFilter = "", $booleanSearch = false, $alternativeFileFilter = "", $invertedMatch = false) { @@ -239,8 +259,7 @@ class MSSQLDatabase extends SS_Database // Create one query per each table, $columns not used. We want just the ID and the ClassName of the object from this query. foreach ($tables as $tableName => $columns) { - $baseClass = ClassInfo::baseDataClass($tableName); - + $class = DataObject::getSchema()->tableClass($tableName); $join = $this->fullTextSearchMSSQL($tableName, $keywords); if (!$join) { return $results; @@ -248,25 +267,25 @@ class MSSQLDatabase extends SS_Database // Check if we need to add ShowInSearch $where = null; - if (strpos($tableName, 'SiteTree') === 0) { + if ($class === 'SiteTree') { $where = array("\"$tableName\".\"ShowInSearch\"!=0"); - } elseif (strpos($tableName, 'File') === 0) { + } elseif ($class === 'File') { // File.ShowInSearch was added later, keep the database driver backwards compatible // by checking for its existence first - $fields = $this->fieldList($tableName); + $fields = $this->getSchemaManager()->fieldList($tableName); if (array_key_exists('ShowInSearch', $fields)) { $where = array("\"$tableName\".\"ShowInSearch\"!=0"); } } - $queries[$tableName] = DataList::create($tableName)->where($where, '')->dataQuery()->query(); + $queries[$tableName] = DataList::create($class)->where($where)->dataQuery()->query(); $queries[$tableName]->setOrderBy(array()); - + // Join with CONTAINSTABLE, a full text searcher that includes relevance factor $queries[$tableName]->setFrom(array("\"$tableName\" INNER JOIN $join AS \"ft\" ON \"$tableName\".\"ID\"=\"ft\".\"KEY\"")); // Join with the base class if needed, as we want to test agains the ClassName - if ($tableName != $baseClass) { - $queries[$tableName]->setFrom("INNER JOIN \"$baseClass\" ON \"$baseClass\".\"ID\"=\"$tableName\".\"ID\""); + if ($tableName != $tableName) { + $queries[$tableName]->setFrom("INNER JOIN \"$tableName\" ON \"$tableName\".\"ID\"=\"$tableName\".\"ID\""); } $queries[$tableName]->setSelect(array("\"$tableName\".\"ID\"")); @@ -278,7 +297,7 @@ class MSSQLDatabase extends SS_Database if (count($allClassesToSearch)) { $classesPlaceholder = DB::placeholders($allClassesToSearch); $queries[$tableName]->addWhere(array( - "\"$baseClass\".\"ClassName\" IN ($classesPlaceholder)" => + "\"$tableName\".\"ClassName\" IN ($classesPlaceholder)" => $allClassesToSearch )); } @@ -289,6 +308,7 @@ class MSSQLDatabase extends SS_Database $querySQLs = array(); $queryParameters = array(); foreach ($queries as $query) { + /** @var SQLSelect $query */ $querySQLs[] = $query->sql($parameters); $queryParameters = array_merge($queryParameters, $parameters); } @@ -326,9 +346,9 @@ class MSSQLDatabase extends SS_Database /** * Allow auto-increment primary key editing on the given table. * Some databases need to enable this specially. - * - * @param $table The name of the table to have PK editing allowed on - * @param $allow True to start, false to finish + * + * @param string $table The name of the table to have PK editing allowed on + * @param bool $allow True to start, false to finish */ public function allowPrimaryKeyEditing($table, $allow = true) { @@ -338,11 +358,10 @@ class MSSQLDatabase extends SS_Database /** * Returns a SQL fragment for querying a fulltext search index * - * @param $tableName specific - table name - * @param $keywords string The search query - * @param $fields array The list of field names to search on, or null to include all - * - * @returns null if keyword set is empty or the string with JOIN clause to be added to SQL query + * @param string $tableName specific - table name + * @param string $keywords The search query + * @param array $fields The list of field names to search on, or null to include all + * @return string Clause, or null if keyword set is empty or the string with JOIN clause to be added to SQL query */ public function fullTextSearchMSSQL($tableName, $keywords, $fields = null) { @@ -361,7 +380,7 @@ class MSSQLDatabase extends SS_Database // Remove stopwords, concat with ANDs $keywordList = explode(' ', $keywords); $keywordList = $this->removeStopwords($keywordList); - + // remove any empty values from the array $keywordList = array_filter($keywordList); if (empty($keywordList)) { @@ -408,7 +427,7 @@ class MSSQLDatabase extends SS_Database /** * This is a quick lookup to discover if the database supports particular extensions * Currently, MSSQL supports no extensions - * + * * @param array $extensions List of extensions to check for support of. The key of this array * will be an extension name, and the value the configuration for that extension. This * could be one of partitions, tablespaces, or clustering @@ -426,9 +445,12 @@ class MSSQLDatabase extends SS_Database return false; } } - + /** * Start transaction. READ ONLY not supported. + * + * @param bool $transactionMode + * @param bool $sessionCharacteristics */ public function transactionStart($transactionMode = false, $sessionCharacteristics = false) { @@ -454,7 +476,7 @@ class MSSQLDatabase extends SS_Database $this->query('ROLLBACK TRANSACTION'); } } - + public function transactionEnd($chain = false) { if ($this->connector instanceof SQLServerConnector) { @@ -463,7 +485,7 @@ class MSSQLDatabase extends SS_Database $this->query('COMMIT TRANSACTION'); } } - + public function comparisonClause($field, $value, $exact = false, $negate = false, $caseSensitive = null, $parameterised = false) { if ($exact) { @@ -474,7 +496,7 @@ class MSSQLDatabase extends SS_Database $comp = 'NOT ' . $comp; } } - + // Field definitions are case insensitive by default, // change used collation for case sensitive searches. $collateClause = ''; @@ -505,7 +527,7 @@ class MSSQLDatabase extends SS_Database /** * Function to return an SQL datetime expression for MSSQL * used for querying a datetime in a certain format - * + * * @param string $date to be formated, can be either 'now', literal datetime like '1973-10-14 10:30:00' or field name, e.g. '"SiteTree"."Created"' * @param string $format to be used, supported specifiers: * %Y = Year (four digits) @@ -571,7 +593,7 @@ class MSSQLDatabase extends SS_Database /** * Function to return an SQL datetime expression for MSSQL. * used for querying a datetime addition - * + * * @param string $date, can be either 'now', literal datetime like '1973-10-14 10:30:00' or field name, e.g. '"SiteTree"."Created"' * @param string $interval to be added, use the format [sign][integer] [qualifier], e.g. -1 Day, +15 minutes, +1 YEAR * supported qualifiers: @@ -616,7 +638,7 @@ class MSSQLDatabase extends SS_Database /** * Function to return an SQL datetime expression for MSSQL. * used for querying a datetime substraction - * + * * @param string $date1, can be either 'now', literal datetime like '1973-10-14 10:30:00' or field name, e.g. '"SiteTree"."Created"' * @param string $date2 to be substracted of $date1, can be either 'now', literal datetime like '1973-10-14 10:30:00' or field name, e.g. '"SiteTree"."Created"' * @return string SQL datetime expression to query for the interval between $date1 and $date2 in seconds which is the result of the substraction diff --git a/code/MSSQLDatabaseConfigurationHelper.php b/code/MSSQLDatabaseConfigurationHelper.php index e949df3..4b52bd6 100644 --- a/code/MSSQLDatabaseConfigurationHelper.php +++ b/code/MSSQLDatabaseConfigurationHelper.php @@ -1,24 +1,32 @@ $databaseConfig['username'], 'PWD' => $databaseConfig['password'] ); - + // Azure has additional parameter requirements if ($this->isAzure($databaseConfig)) { $parameters['database'] = $databaseConfig['database']; @@ -44,7 +53,7 @@ class MSSQLDatabaseConfigurationHelper implements DatabaseConfigurationHelper if ($conn) { return $conn; } - + // Get error if ($errors = sqlsrv_errors()) { $error = ''; @@ -73,10 +82,10 @@ class MSSQLDatabaseConfigurationHelper implements DatabaseConfigurationHelper return null; } } - + /** * Helper function to quote a string value - * + * * @param mixed $conn Connection object/resource * @param string $value Value to quote * @return string Quoted strieng @@ -93,10 +102,10 @@ class MSSQLDatabaseConfigurationHelper implements DatabaseConfigurationHelper user_error('Invalid database connection', E_USER_ERROR); } } - + /** * Helper function to execute a query - * + * * @param mixed $conn Connection object/resource * @param string $sql SQL string to execute * @return array List of first value from each resulting row @@ -132,7 +141,7 @@ class MSSQLDatabaseConfigurationHelper implements DatabaseConfigurationHelper { $conn = $this->createConnection($databaseConfig, $error); $success = !empty($conn); - + return array( 'success' => $success, 'error' => $error @@ -143,7 +152,7 @@ class MSSQLDatabaseConfigurationHelper implements DatabaseConfigurationHelper { $conn = $this->createConnection($databaseConfig, $error); $success = !empty($conn); - + return array( 'success' => $success, 'connection' => $conn, @@ -160,7 +169,7 @@ class MSSQLDatabaseConfigurationHelper implements DatabaseConfigurationHelper /** * Ensure that the SQL Server version is at least 10.00.2531 (SQL Server 2008 SP1). - * + * * @see http://www.sqlteam.com/article/sql-server-versions * @param array $databaseConfig Associative array of db configuration, e.g. "server", "username" etc * @return array Result - e.g. array('success' => true, 'error' => 'details of error') @@ -189,6 +198,7 @@ class MSSQLDatabaseConfigurationHelper implements DatabaseConfigurationHelper public function requireDatabaseOrCreatePermissions($databaseConfig) { $conn = $this->createConnection($databaseConfig, $error); + /** @skipUpgrade */ if (empty($conn)) { $success = false; $alreadyExists = false; @@ -227,7 +237,7 @@ class MSSQLDatabaseConfigurationHelper implements DatabaseConfigurationHelper $permissions = $this->query($conn, "select COUNT(*) from sys.fn_my_permissions(NULL,'DATABASE') WHERE permission_name like 'create table';"); $success = $permissions[0] > 0; } - + return array( 'success' => $success, 'applies' => true diff --git a/code/MSSQLQueryBuilder.php b/code/MSSQLQueryBuilder.php index f01efea..ac5918a 100644 --- a/code/MSSQLQueryBuilder.php +++ b/code/MSSQLQueryBuilder.php @@ -1,5 +1,14 @@ database->fullTextEnabled()) { return; } - + $this->query("EXEC sp_fulltext_catalog 'ftCatalog', 'Rebuild';"); // Busy wait until it's done updating, but no longer than 15 seconds. @@ -93,7 +100,7 @@ class MSSQLSchemaManager extends DBSchemaManager /** * Check if a fulltext index exists on a particular table name. - * + * * @param string $tableName * @return boolean TRUE index exists | FALSE index does not exist | NULL no support */ @@ -115,7 +122,7 @@ class MSSQLSchemaManager extends DBSchemaManager /** * MSSQL stores the primary key column with an internal identifier, * so a lookup needs to be done to determine it. - * + * * @param string $tableName Name of table with primary key column "ID" * @return string Internal identifier for primary key */ @@ -135,7 +142,7 @@ class MSSQLSchemaManager extends DBSchemaManager /** * Gets the identity column of a table - * + * * @param string $tableName * @return string|null */ @@ -158,7 +165,7 @@ class MSSQLSchemaManager extends DBSchemaManager { $this->query("CREATE DATABASE \"$name\""); } - + public function dropDatabase($name) { $this->query("DROP DATABASE \"$name\""); @@ -174,7 +181,7 @@ class MSSQLSchemaManager extends DBSchemaManager } return false; } - + public function databaseList() { return $this->query('SELECT NAME FROM sys.sysdatabases')->column(); @@ -182,13 +189,14 @@ class MSSQLSchemaManager extends DBSchemaManager /** * Create a new table. - * @param $tableName The name of the table - * @param $fields A map of field names to field types - * @param $indexes A map of indexes - * @param $options An map of additional options. The available keys are as follows: + * @param string $tableName The name of the table + * @param array $fields A map of field names to field types + * @param array $indexes A map of indexes + * @param array $options An map of additional options. The available keys are as follows: * - 'MSSQLDatabase'/'MySQLDatabase'/'PostgreSQLDatabase' - database-specific options such as "engine" for MySQL. * - 'temporary' - If true, then a temporary table will be created - * @return The table name generated. This may be different from the table name, for example with temporary tables. + * @param array $advancedOptions + * @return string The table name generated. This may be different from the table name, for example with temporary tables. */ public function createTable($tableName, $fields = null, $indexes = null, $options = null, $advancedOptions = null) { @@ -227,18 +235,20 @@ class MSSQLSchemaManager extends DBSchemaManager /** * Alter a table's schema. - * @param $table The name of the table to alter - * @param $newFields New fields, a map of field name => field schema - * @param $newIndexes New indexes, a map of index name => index type - * @param $alteredFields Updated fields, a map of field name => field schema - * @param $alteredIndexes Updated indexes, a map of index name => index type + * @param string $tableName The name of the table to alter + * @param array $newFields New fields, a map of field name => field schema + * @param array $newIndexes New indexes, a map of index name => index type + * @param array $alteredFields Updated fields, a map of field name => field schema + * @param array $alteredIndexes Updated indexes, a map of index name => index type + * @param array $alteredOptions + * @param array $advancedOptions */ public function alterTable($tableName, $newFields = null, $newIndexes = null, $alteredFields = null, $alteredIndexes = null, $alteredOptions=null, $advancedOptions=null) { $alterList = array(); // drop any fulltext indexes that exist on the table before altering the structure - if ($this->fullTextIndexExists($tableName)) { + if ($this->fulltextIndexExists($tableName)) { $alterList[] = "\nDROP FULLTEXT INDEX ON \"$tableName\";"; } @@ -276,7 +286,7 @@ class MSSQLSchemaManager extends DBSchemaManager /** * Given the table and column name, retrieve the constraint name for that column * in the table. - * + * * @param string $tableName Table name column resides in * @param string $columnName Column name the constraint is for * @return string|null @@ -294,11 +304,11 @@ class MSSQLSchemaManager extends DBSchemaManager /** * Given a table and column name, return a check constraint clause for that column in * the table. - * + * * This is an expensive query, so it is cached per-request and stored by table. The initial * call for a table that has not been cached will query all columns and store that * so subsequent calls are fast. - * + * * @param string $tableName Table name column resides in * @param string $columnName Column name the constraint is for * @return string The check string @@ -325,7 +335,7 @@ class MSSQLSchemaManager extends DBSchemaManager $checks[$record['COLUMN_NAME']] = $record['CHECK_CLAUSE']; } self::$cached_checks[$tableName] = $checks; - + // Return via cached records return $this->getConstraintCheckClause($tableName, $columnName); } @@ -333,7 +343,7 @@ class MSSQLSchemaManager extends DBSchemaManager /** * Return the name of the default constraint applied to $tableName.$colName. * Will return null if no such constraint exists - * + * * @param string $tableName Name of the table * @param string $colName Name of the column * @return string|null @@ -354,7 +364,7 @@ class MSSQLSchemaManager extends DBSchemaManager /** * Get enum values from a constraint check clause. - * + * * @param string $clause Check clause to parse values from * @return array Enum values */ @@ -413,7 +423,7 @@ class MSSQLSchemaManager extends DBSchemaManager // SET null / not null $nullFragment = empty($matches['null']) ? '' : " {$matches['null']}"; $alterQueries[] = "$prefix ALTER COLUMN \"$colName\" {$matches['definition']}$nullFragment;"; - + // Add a default back if (!empty($matches['default'])) { $alterQueries[] = "$prefix ADD {$matches['default']} FOR \"$colName\";"; @@ -583,10 +593,10 @@ class MSSQLSchemaManager extends DBSchemaManager { $this->query($this->getIndexSqlDefinition($tableName, $indexName, $indexSpec)); } - + /** * Return SQL for dropping and recreating an index - * + * * @param string $tableName Name of table to create this index against * @param string $indexName Name of this index * @param array|string $indexSpec Index specification, either as a raw string @@ -698,7 +708,7 @@ class MSSQLSchemaManager extends DBSchemaManager array($tableName) )->column(); } - + public function tableList() { $tables = array(); @@ -712,7 +722,7 @@ class MSSQLSchemaManager extends DBSchemaManager * Return a boolean type-formatted string * We use 'bit' so that we can do numeric-based comparisons * - * @params array $values Contains a tokenised list of info about this data type + * @param array $values Contains a tokenised list of info about this data type * @return string */ public function boolean($values) @@ -724,7 +734,7 @@ class MSSQLSchemaManager extends DBSchemaManager /** * Return a date type-formatted string. * - * @params array $values Contains a tokenised list of info about this data type + * @param array $values Contains a tokenised list of info about this data type * @return string */ public function date($values) @@ -735,7 +745,7 @@ class MSSQLSchemaManager extends DBSchemaManager /** * Return a decimal type-formatted string * - * @params array $values Contains a tokenised list of info about this data type + * @param array $values Contains a tokenised list of info about this data type * @return string */ public function decimal($values) @@ -758,7 +768,7 @@ class MSSQLSchemaManager extends DBSchemaManager /** * Return a enum type-formatted string * - * @params array $values Contains a tokenised list of info about this data type + * @param array $values Contains a tokenised list of info about this data type * @return string */ public function enum($values) @@ -785,7 +795,7 @@ class MSSQLSchemaManager extends DBSchemaManager /** * Return a float type-formatted string. * - * @params array $values Contains a tokenised list of info about this data type + * @param array $values Contains a tokenised list of info about this data type * @return string */ public function float($values) @@ -796,7 +806,7 @@ class MSSQLSchemaManager extends DBSchemaManager /** * Return a int type-formatted string * - * @params array $values Contains a tokenised list of info about this data type + * @param array $values Contains a tokenised list of info about this data type * @return string */ public function int($values) @@ -807,7 +817,7 @@ class MSSQLSchemaManager extends DBSchemaManager /** * Return a bigint type-formatted string * - * @params array $values Contains a tokenised list of info about this data type + * @param array $values Contains a tokenised list of info about this data type * @return string */ public function bigint($values) @@ -819,10 +829,10 @@ class MSSQLSchemaManager extends DBSchemaManager * Return a datetime type-formatted string * For MS SQL, we simply return the word 'timestamp', no other parameters are necessary * - * @params array $values Contains a tokenised list of info about this data type + * @param array $values Contains a tokenised list of info about this data type * @return string */ - public function ss_datetime($values) + public function datetime($values) { return 'datetime null'; } @@ -830,7 +840,7 @@ class MSSQLSchemaManager extends DBSchemaManager /** * Return a text type-formatted string * - * @params array $values Contains a tokenised list of info about this data type + * @param array $values Contains a tokenised list of info about this data type * @return string */ public function text($values) @@ -843,7 +853,7 @@ class MSSQLSchemaManager extends DBSchemaManager /** * Return a time type-formatted string. * - * @params array $values Contains a tokenised list of info about this data type + * @param array $values Contains a tokenised list of info about this data type * @return string */ public function time($values) @@ -854,7 +864,7 @@ class MSSQLSchemaManager extends DBSchemaManager /** * Return a varchar type-formatted string * - * @params array $values Contains a tokenised list of info about this data type + * @param array $values Contains a tokenised list of info about this data type * @return string */ public function varchar($values) @@ -866,6 +876,8 @@ class MSSQLSchemaManager extends DBSchemaManager /** * Return a 4 digit numeric type. + * + * @param array $values * @return string */ public function year($values) @@ -875,6 +887,9 @@ class MSSQLSchemaManager extends DBSchemaManager /** * This returns the column which is the primary key for each table + * + * @param bool $asDbValue + * @param bool $hasAutoIncPK * @return string */ public function IdColumn($asDbValue = false, $hasAutoIncPK = true) @@ -899,6 +914,10 @@ class MSSQLSchemaManager extends DBSchemaManager /** * Returns the values of the given enum field * NOTE: Experimental; introduced for db-abstraction and may changed before 2.4 is released. + * + * @param string $tableName + * @param string $fieldName + * @return array */ public function enumValuesForField($tableName, $fieldName) { @@ -918,6 +937,9 @@ class MSSQLSchemaManager extends DBSchemaManager * * For instance, MSSQL uses 'BIGINT', while MySQL uses 'UNSIGNED' * and PostgreSQL uses 'INT'. + * + * @param string $type + * @return string */ public function dbDataType($type) { @@ -930,7 +952,7 @@ class MSSQLSchemaManager extends DBSchemaManager return ''; } } - + protected function indexKey($table, $index, $spec) { return $index; diff --git a/code/SQLServerConnector.php b/code/SQLServerConnector.php index 315093f..1547553 100644 --- a/code/SQLServerConnector.php +++ b/code/SQLServerConnector.php @@ -1,16 +1,23 @@ $charset, 'MultipleActiveResultSets' => $multiResultSets ); - + if (!(defined('MSSQL_USE_WINDOWS_AUTHENTICATION') && MSSQL_USE_WINDOWS_AUTHENTICATION == true) && empty($parameters['windowsauthentication']) ) { $options['UID'] = $parameters['username']; $options['PWD'] = $parameters['password']; } - + // Required by MS Azure database if ($selectDB && !empty($parameters['database'])) { $options['Database'] = $parameters['database']; } $this->dbConn = sqlsrv_connect($parameters['server'], $options); - + if (empty($this->dbConn)) { $this->databaseError("Couldn't connect to SQL Server database"); } elseif ($selectDB && !empty($parameters['database'])) { @@ -68,7 +75,7 @@ class SQLServerConnector extends DBConnector $this->selectedDatabase = $parameters['database']; } } - + /** * Start transaction. READ ONLY not supported. */ @@ -79,7 +86,7 @@ class SQLServerConnector extends DBConnector $this->databaseError("Couldn't start the transaction."); } } - + /** * Commit everything inside this transaction so far */ @@ -90,7 +97,7 @@ class SQLServerConnector extends DBConnector $this->databaseError("Couldn't commit the transaction."); } } - + /** * Rollback or revert to a savepoint if your queries encounter problems * If you encounter a problem at any point during a transaction, you may @@ -108,7 +115,7 @@ class SQLServerConnector extends DBConnector { return $this->lastAffectedRows; } - + public function getLastError() { $errorMessages = array(); @@ -130,7 +137,7 @@ class SQLServerConnector extends DBConnector { // Reset state $this->lastAffectedRows = 0; - + // Run query $parsedParameters = $this->parameterValues($parameters); if (empty($parsedParameters)) { @@ -138,13 +145,13 @@ class SQLServerConnector extends DBConnector } else { $handle = sqlsrv_query($this->dbConn, $sql, $parsedParameters); } - + // Check for error if (!$handle) { $this->databaseError($this->getLastError(), $errorLevel, $sql, $parsedParameters); return null; } - + // Report result $this->lastAffectedRows = sqlsrv_rows_affected($handle); return new SQLServerQuery($this, $handle); @@ -190,19 +197,19 @@ class SQLServerConnector extends DBConnector $this->selectDatabase('Master'); $this->selectedDatabase = null; } - + /** * Quotes a string, including the "N" prefix so unicode * strings are saved to the database correctly. * - * @param string $string String to be encoded + * @param string $value String to be encoded * @return string Processed string ready for DB */ public function quoteString($value) { return "N'" . $this->escapeString($value) . "'"; } - + public function escapeString($value) { $value = str_replace("'", "''", $value); diff --git a/code/SQLServerQuery.php b/code/SQLServerQuery.php index 70c7c9d..932247d 100644 --- a/code/SQLServerQuery.php +++ b/code/SQLServerQuery.php @@ -1,5 +1,12 @@ =3.2" + "silverstripe/framework": "^4" }, "extra": { "branch-alias": { - "dev-master": "1.0.x-dev" + "dev-master": "2.x-dev" + } + }, + "autoload": { + "psr-4": { + "SilverStripe\\MSSQL\\": "code/" } }, "prefer-stable": true, diff --git a/tests/MSSQLDatabaseQueryTest.php b/tests/MSSQLDatabaseQueryTest.php index 7be352f..0e80909 100644 --- a/tests/MSSQLDatabaseQueryTest.php +++ b/tests/MSSQLDatabaseQueryTest.php @@ -1,4 +1,6 @@ 'Date', - 'TestDatetime' => 'SS_Datetime' + 'TestDatetime' => 'Datetime' ); }