Nextcloud PHP API (master)

AddMissingColumnsEvent extends Event
in package

Event to allow apps to register information about missing database columns

This event will be dispatched for checking on the admin settings and when running occ db:add-missing-columns which will then create those columns

Tags
since
28.0.0

Table of Contents

Properties

$missingColumns  : array<string|int, array{tableName: string, columnName: string, typeName: string, options: array{}}>
$propagationStopped  : bool

Methods

__construct()  : mixed
Compatibility constructor
addMissingColumn()  : void
getMissingColumns()  : array<string|int, array{tableName: string, columnName: string, typeName: string, options: array{}}>
isPropagationStopped()  : bool
{@inheritDoc}
stopPropagation()  : void
Stops the propagation of the event to further event listeners

Properties

$missingColumns

private array<string|int, array{tableName: string, columnName: string, typeName: string, options: array{}}> $missingColumns = []

$propagationStopped

private bool $propagationStopped = false
Tags
since
22.0.0

Methods

__construct()

Compatibility constructor

public __construct() : mixed

In Nextcloud 17.0.0 this event class used a now deprecated/removed Symfony base class that had a constructor (with default arguments). To lower the risk of a breaking change (PHP won't allow parent constructor calls if there is none), this empty constructor's only purpose is to hopefully not break existing sub- classes of this class.

Tags
since
18.0.0

addMissingColumn()

public addMissingColumn(string $tableName, string $columnName, string $typeName, array<string|int, mixed> $options) : void
Parameters
$tableName : string
$columnName : string
$typeName : string
$options : array<string|int, mixed>
Tags
since
28.0.0

getMissingColumns()

public getMissingColumns() : array<string|int, array{tableName: string, columnName: string, typeName: string, options: array{}}>
Tags
since
28.0.0
Return values
array<string|int, array{tableName: string, columnName: string, typeName: string, options: array{}}>

isPropagationStopped()

{@inheritDoc}

public isPropagationStopped() : bool
Tags
since
22.0.0
see
StoppableEventInterface
Return values
bool

stopPropagation()

Stops the propagation of the event to further event listeners

public stopPropagation() : void
Tags
since
22.0.0

        
On this page

Search results