Class CachedCollection

Extends the schema collection class to provide caching

Cake\Database\Schema\Collection
Extended by Cake\Database\Schema\CachedCollection
Namespace: Cake\Database\Schema
Location: Database/Schema/CachedCollection.php

Properties summary

  • $_cache protected
    string|boolean

    The name of the cache config key to use for caching table metadata, of false if disabled.

Inherited Properties

Method Summary

  • __construct() public
    Constructor.
  • cacheKey() public
    Get the cache key for a given name.
  • cacheMetadata() public deprecated

    Sets the cache config name to use for caching table metadata, or disables it if false is passed. If called with no arguments it returns the current configuration name.

  • describe() public
    Get the column metadata for a table.
  • Gets the cache config name to use for caching table metadata, false means disabled.

  • Sets the cache config name to use for caching table metadata, or disables it if false is passed.

Method Detail

__construct()source public 

__construct( Cake\Datasource\ConnectionInterface $connection , string|boolean $cacheKey = true )

Constructor.

Parameters

Cake\Datasource\ConnectionInterface $connection
The connection instance.
string|boolean $cacheKey optional true
The cache key or boolean false to disable caching.

Overrides

Cake\Database\Schema\Collection::__construct()

cacheKey()source public 

cacheKey( string $name )

Get the cache key for a given name.

Parameters

string $name
The name to get a cache key for.

Returns

string
The cache key.

cacheMetadata()source public deprecated 

cacheMetadata( boolean|null $enable = null )

Sets the cache config name to use for caching table metadata, or disables it if false is passed. If called with no arguments it returns the current configuration name.

Deprecated

3.4.0 Use setCacheMetadata()/getCacheMetadata()

Parameters

boolean|null $enable optional null
Whether or not to enable caching

Returns

string|boolean

describe()source public 

describe( string $name , array $options = [] )

Get the column metadata for a table.

Parameters

string $name
The name of the table to describe.
array $options optional []
The options to use, see above.

Returns

Cake\Database\Schema\TableSchema
Object with column metadata.

Throws

Cake\Database\Exception
when table cannot be described.

Overrides

Cake\Database\Schema\Collection::describe()

getCacheMetadata()source public 

getCacheMetadata( )

Gets the cache config name to use for caching table metadata, false means disabled.

Returns

string|boolean

setCacheMetadata()source public 

setCacheMetadata( boolean $enable )

Sets the cache config name to use for caching table metadata, or disables it if false is passed.

Parameters

boolean $enable
Whether or not to enable caching

Returns


$this

Methods inherited from Cake\Database\Schema\Collection

_reflect()source protected 

_reflect( string $stage , string $name , array $config , Cake\Database\Schema\TableSchema $schema )

Helper method for running each step of the reflection process.

Parameters

string $stage
The stage name.
string $name
The table name.
array $config
The config data.
Cake\Database\Schema\TableSchema $schema
The table instance

Throws

Cake\Database\Exception
on query failure.

listTables()source public 

listTables( )

Get the list of tables available in the current connection.

Returns

array
The list of tables in the connected database/schema.

Properties detail

$_cachesource

protected string|boolean

The name of the cache config key to use for caching table metadata, of false if disabled.

false

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.7/class-Cake.Database.Schema.CachedCollection.html