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 4.6 Strawberry API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 4.6
      • 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
    • Command
    • Console
    • Controller
    • Core
    • Database
    • Datasource
      • Exception
      • Locator
      • Paging
    • Error
    • Event
    • Filesystem
    • Form
    • Http
    • I18n
    • Log
    • Mailer
    • Network
    • ORM
    • Routing
    • Shell
    • TestSuite
    • Utility
    • Validation
    • View

Class AbstractLocator

Provides an abstract registry/factory for repository objects.

Abstract
Namespace: Cake\Datasource\Locator

Property Summary

  • $instances protected
    array<string, \Cake\Datasource\RepositoryInterface>

    Instances that belong to the registry.

  • $options protected
    array<string, array>

    Contains a list of options that were passed to get() method.

Method Summary

  • clear() public

    Clears the registry of configuration and instances.

  • createInstance() abstract protected

    Create an instance of a given classname.

  • exists() public

    Check to see if an instance exists in the registry.

  • get() public

    Get a repository instance from the registry.

  • remove() public

    Removes an repository instance from the registry.

  • set() public

    Set a repository instance.

Method Detail

clear() ¶ public

clear(): void

Clears the registry of configuration and instances.

Returns
void

createInstance() ¶ abstract protected

createInstance(string $alias, array<string, mixed> $options): Cake\Datasource\RepositoryInterface

Create an instance of a given classname.

Parameters
string $alias

Repository alias.

array<string, mixed> $options

The options you want to build the instance with.

Returns
Cake\Datasource\RepositoryInterface

exists() ¶ public

exists(string $alias): bool

Check to see if an instance exists in the registry.

Parameters
string $alias
Returns
bool

get() ¶ public

get(string $alias, array<string, mixed> $options = []): Cake\Datasource\RepositoryInterface

Get a repository instance from the registry.

Parameters
string $alias

The alias name you want to get.

array<string, mixed> $options optional

The options you want to build the table with.

Returns
Cake\Datasource\RepositoryInterface
Throws
RuntimeException
When trying to get alias for which instance has already been created with different options.

remove() ¶ public

remove(string $alias): void

Removes an repository instance from the registry.

Parameters
string $alias
Returns
void

set() ¶ public

set(string $alias, Cake\Datasource\RepositoryInterface $repository): Cake\Datasource\RepositoryInterface

Set a repository instance.

Parameters
string $alias
Cake\Datasource\RepositoryInterface $repository
Returns
Cake\Datasource\RepositoryInterface

Property Detail

$instances ¶ protected

Instances that belong to the registry.

Type
array<string, \Cake\Datasource\RepositoryInterface>

$options ¶ protected

Contains a list of options that were passed to get() method.

Type
array<string, array>
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