CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Team
    • Issues (Github)
    • YouTube Channel
    • Get Involved
    • Bakery
    • Featured Resources
    • Newsletter
    • Certification
    • My CakePHP
    • CakeFest
    • Facebook
    • Twitter
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 3.8 Red Velvet API

  • Overview
  • Tree
  • Deprecated
  • Version:
    • 3.8
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Cake
    • Auth
      • Storage
    • Cache
      • Engine
    • Collection
      • Iterator
    • Command
    • Console
      • Exception
    • Controller
      • Component
      • Exception
    • Core
      • Configure
        • Engine
      • Exception
      • Retry
    • Database
      • Driver
      • Exception
      • Expression
      • Schema
      • Statement
      • Type
    • Datasource
      • Exception
    • Error
      • Middleware
    • Event
      • Decorator
    • Filesystem
    • Form
    • Http
      • Client
        • Adapter
        • Auth
      • Cookie
      • Exception
      • Middleware
      • Session
    • I18n
      • Formatter
      • Middleware
      • Parser
    • Log
      • Engine
    • Mailer
      • Exception
      • Transport
    • Network
      • Exception
    • ORM
      • Association
      • Behavior
        • Translate
      • Exception
      • Locator
      • Rule
    • Routing
      • Exception
      • Filter
      • Middleware
      • Route
    • Shell
      • Helper
      • Task
    • TestSuite
      • Fixture
      • Stub
    • Utility
      • Exception
    • Validation
    • View
      • Exception
      • Form
      • Helper
      • Widget
  • None

Classes

  • TableLocator

Interfaces

  • LocatorInterface

Traits

  • LocatorAwareTrait

Interface LocatorInterface

Registries for Table objects should implement this interface.

Direct Implementers
  • Cake\ORM\Locator\TableLocator
Namespace: Cake\ORM\Locator
Location: ORM/Locator/LocatorInterface.php

Method Summary

  • clear() public
    Clears the registry of configuration and instances.
  • config() public

    Stores a list of options to be used when instantiating an object with a matching alias.

  • exists() public
    Check to see if an instance exists in the registry.
  • get() public
    Get a table instance from the registry.
  • remove() public
    Removes an instance from the registry.
  • set() public
    Set an instance.

Method Detail

clear() public ¶

clear( )

Clears the registry of configuration and instances.

config() public ¶

config( string|null $alias = null , array|null $options = null )

Stores a list of options to be used when instantiating an object with a matching alias.

Parameters
string|null $alias optional null
Name of the alias
array|null $options optional null
list of options for the alias
Returns
array
The config data.

exists() public ¶

exists( string $alias )

Check to see if an instance exists in the registry.

Parameters
string $alias
The alias to check for.
Returns
boolean

get() public ¶

get( string $alias , array $options = [] )

Get a table instance from the registry.

Parameters
string $alias
The alias name you want to get.
array $options optional []
The options you want to build the table with.
Returns
Cake\ORM\Table

remove() public ¶

remove( string $alias )

Removes an instance from the registry.

Parameters
string $alias
The alias to remove.

set() public ¶

set( string $alias , Cake\ORM\Table $object )

Set an instance.

Parameters
string $alias
The alias to set.
Cake\ORM\Table $object
The table to set.
Returns
Cake\ORM\Table

Magic methods summary

getConfig() public ¶

getConfig( $alias )

Parameters
$alias
Returns
array
Follow @CakePHP
#IRC
OpenHub
Rackspace
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Logos & Trademarks
  • Community
  • Team
  • Issues (Github)
  • YouTube Channel
  • Get Involved
  • Bakery
  • Featured Resources
  • Newsletter
  • Certification
  • My CakePHP
  • CakeFest
  • Facebook
  • Twitter
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs