Skip to content

Commit eee2c48

Browse files
committed
Properly nest AbstractMigration attribute and methods under class
1 parent bdccc5d commit eee2c48

File tree

1 file changed

+36
-36
lines changed

1 file changed

+36
-36
lines changed

docs/plugins/data.rst

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -291,64 +291,64 @@ Define migrations in the Plugin's ``Migrations`` directory. The file and class n
291291
292292
.. php:class:: Mautic\IntegrationsBundle\Migration\AbstractMigration
293293
294-
.. php:attr:: protected tablePrefix
294+
.. php:attr:: protected tablePrefix
295295
296-
Mautic's configured database table prefix.
296+
Mautic's configured database table prefix.
297297

298-
.. php:method:: protected abstract isApplicable(Schema $schema)
298+
.. php:method:: protected abstract isApplicable(Schema $schema)
299299
300-
:param Doctrine\\DBAL\\Schema\\Schema $schema: Use the ``Schema`` object to evaluate Mautic's current schema.
300+
:param Doctrine\\DBAL\\Schema\\Schema $schema: Use the ``Schema`` object to evaluate Mautic's current schema.
301301

302-
:returns: Return ``FALSE`` to skip this migration. Otherwise, ``TRUE``.
303-
:returntype: bool
302+
:returns: Return ``FALSE`` to skip this migration. Otherwise, ``TRUE``.
303+
:returntype: bool
304304

305-
.. php:method:: protected abstract up()
305+
.. php:method:: protected abstract up()
306306
307-
Define the SQL queries through :php:meth:`addSql`.
307+
Define the SQL queries through :php:meth:`addSql`.
308308

309-
:returntype: void
309+
:returntype: void
310310

311-
.. php:method:: protected addSql(string $sql)
311+
.. php:method:: protected addSql(string $sql)
312312
313-
:param string $sql: SQL query to execute. Prefix table and index names with :php:attr:`tablePrefix` or use :php:meth:`concatPrefix`.
313+
:param string $sql: SQL query to execute. Prefix table and index names with :php:attr:`tablePrefix` or use :php:meth:`concatPrefix`.
314314

315-
:returntype: void
315+
:returntype: void
316316

317-
.. php:method:: protected columnsToString(array $columns)
317+
.. php:method:: protected columnsToString(array $columns)
318318
319-
:param array $columns: Array of column names.
319+
:param array $columns: Array of column names.
320320

321-
:return: Returns a comma separated value list from the values given in the array. For example, ``$this->columnsToString(['a', 'b', 'c'])`` will return ``'a,b,c'``.
322-
:returntype: string
321+
:return: Returns a comma separated value list from the values given in the array. For example, ``$this->columnsToString(['a', 'b', 'c'])`` will return ``'a,b,c'``.
322+
:returntype: string
323323

324-
.. php:method:: protected concatPrefix(string $name)
324+
.. php:method:: protected concatPrefix(string $name)
325325
326-
Prefixes the given name with the configured table prefix.
326+
Prefixes the given name with the configured table prefix.
327327

328-
:param string $name: Name of column or index to prefix.
328+
:param string $name: Name of column or index to prefix.
329329

330-
:return: Prefixed name.
331-
:returntype: string
330+
:return: Prefixed name.
331+
:returntype: string
332332

333-
.. php:method:: protected generateAlterTableForeignKeyStatement(string $table, array $columns, string $referenceTable, array $referenceColumns[, string $suffix = ''])
333+
.. php:method:: protected generateAlterTableForeignKeyStatement(string $table, array $columns, string $referenceTable, array $referenceColumns[, string $suffix = ''])
334334
335-
Generates full SQL statement to add a new foreign key to a table.
335+
Generates full SQL statement to add a new foreign key to a table.
336336

337-
:param string $table: Name of the current table without the table prefix.
338-
:param array $columns: Array of columns for the current table.
339-
:param string $referenceTable: Name of the referenced table without the table prefix.
340-
:param array $referenceColumns: Array of columns for the referenced table.
341-
:param string $suffix: String to append to the query such as ``ON DELETE CASCADE``.
337+
:param string $table: Name of the current table without the table prefix.
338+
:param array $columns: Array of columns for the current table.
339+
:param string $referenceTable: Name of the referenced table without the table prefix.
340+
:param array $referenceColumns: Array of columns for the referenced table.
341+
:param string $suffix: String to append to the query such as ``ON DELETE CASCADE``.
342342

343-
:return: SQL statement for adding a new foreign key.
344-
:returntype: string
343+
:return: SQL statement for adding a new foreign key.
344+
:returntype: string
345345

346-
.. php:method:: protected generateIndexStatement(string $table, array $columns)
346+
.. php:method:: protected generateIndexStatement(string $table, array $columns)
347347
348-
Generates an ``INDEX`` statement to be used within a ``CREATE TABLE`` or ``ALTER TABLE`` statement to create an index.
348+
Generates an ``INDEX`` statement to be used within a ``CREATE TABLE`` or ``ALTER TABLE`` statement to create an index.
349349

350-
:param string $table: Name of the table where the index will be added.
351-
:param array $columns: Array of columns to included in the index.
350+
:param string $table: Name of the table where the index will be added.
351+
:param array $columns: Array of columns to included in the index.
352352

353-
:return: ``INDEX {tableName} ($columns...)`` statement
354-
:returntype: string
353+
:return: ``INDEX {tableName} ($columns...)`` statement
354+
:returntype: string

0 commit comments

Comments
 (0)