Overview

Namespaces

  • Charcoal
    • Loader
    • Model
      • Service
      • ServiceProvider
    • Source
      • Database
    • Validator

Classes

  • AbstractSource
  • DatabaseSource
  • DatabaseSourceConfig
  • Filter
  • Order
  • Pagination
  • SourceConfig

Interfaces

  • DatabaseSourceInterface
  • FilterInterface
  • OrderInterface
  • PaginationInterface
  • SourceInterface
  • StorableInterface

Traits

  • StorableTrait
  • Overview
  • Namespace
  • Class

Interface DatabaseSourceInterface

Direct known implementers

Charcoal\Source\DatabaseSource
Namespace: Charcoal\Source
Located at Charcoal/Source/DatabaseSourceInterface.php
Methods summary
public Charcoal\Source\DatabaseSource
# setTable( string $table )

Set the database's table to use.

Set the database's table to use.

Parameters

$table
The database table.

Returns

Charcoal\Source\DatabaseSource
Chainable
public string
# table( )

Get the database's current table.

Get the database's current table.

Returns

string
public boolean
# createTable( )

Create a table from a model's metadata.

Create a table from a model's metadata.

Returns

boolean
Success / Failure
public boolean
# alterTable( )

Alter an existing table to match the model's metadata.

Alter an existing table to match the model's metadata.

Returns

boolean
Success / Failure
public boolean
# tableExists( )

Returns

boolean
public array
# tableStructure( )

Get the table columns information.

Get the table columns information.

Returns

array
public boolean
# tableIsEmpty( )

Check wether the source table is empty (true) or not (false)

Check wether the source table is empty (true) or not (false)

Returns

boolean
public PDO
# db( )

Returns

PDO
API documentation generated by ApiGen