CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (Github)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 3.2 Red Velvet API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 3.2
      • 5.2
      • 5.1
      • 5.0
      • 4.6
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 3.9
      • 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

  • Global
  • Cake
    • Auth
    • Cache
    • Collection
    • Console
    • Controller
    • Core
    • Database
    • Datasource
    • Error
    • Event
    • Filesystem
    • Form
    • I18n
    • Log
    • Mailer
    • Network
    • ORM
      • Association
      • Behavior
      • Exception
      • Locator
      • Rule
    • Routing
    • Shell
    • TestSuite
    • Utility
    • Validation
    • View

Interface LocatorInterface

Registries for Table objects should implement this interface.

Namespace: Cake\ORM\Locator

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(): void

Clears the registry of configuration and instances.

Returns
void

config() ¶ public

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

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

Parameters
string|null $alias optional

Name of the alias

array|null $options optional

list of options for the alias

Returns
array

exists() ¶ public

exists(string $alias): bool

Check to see if an instance exists in the registry.

Parameters
string $alias

The alias to check for.

Returns
bool

get() ¶ public

get(string $alias, array $options = []): Cake\ORM\Table

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): void

Removes an instance from the registry.

Parameters
string $alias

The alias to remove.

Returns
void

set() ¶ public

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

Set an instance.

Parameters
string $alias

The alias to set.

Cake\ORM\Table $object

The table to set.

Returns
Cake\ORM\Table
OpenHub
Pingping
Linode
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (Github)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs