\Dewdrop\Db\FieldProviderManyToMany

A field provider that allows checking and instantiating field objects for the ManyToMany relationships assigned to the provider's table object.

Summary

Methods
Properties
Constants
__construct()
has()
instantiate()
getAllNames()
augmentSelect()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$table
N/A

Properties

$table

$table : \Dewdrop\Db\Table

The table object containing this provider.

Type

\Dewdrop\Db\Table

Methods

__construct()

__construct(\Dewdrop\Db\Table  $table) 

Create a reference to the supplied table object.

Parameters

\Dewdrop\Db\Table $table

has()

has(string  $name) : boolean

Check to see if there is a many-to-many relationship with the supplied name.

Parameters

string $name

Returns

boolean

instantiate()

instantiate(string  $name) : \Dewdrop\Db\ManyToMany\Field

Create a field object for the many-to-many relationship matching the supplied name.

Parameters

string $name

Returns

\Dewdrop\Db\ManyToMany\Field

getAllNames()

getAllNames() : array

Get a list of field names supported by many-to-many relationships assigned to this provider's table object.

Returns

array

augmentSelect()

augmentSelect(\Dewdrop\Db\Select  $select) : \Dewdrop\Db\Select

Augment the provided Select by adding a comma-separated list of many-to-many values for all relationships in this field provider.

Parameters

\Dewdrop\Db\Select $select

Returns

\Dewdrop\Db\Select