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 5.4 Chiffon API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 5.4
      • 5.4
      • 5.3
      • 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
    • Cache
    • Collection
    • Command
    • Console
    • Container
      • Argument
      • Definition
      • Exception
      • Inflector
      • ServiceProvider
    • Controller
    • Core
    • Database
    • Datasource
    • Error
    • Event
    • Form
    • Http
    • I18n
    • Lock
    • Log
    • Mailer
    • Network
    • ORM
    • Routing
    • TestSuite
    • Utility
    • Validation
    • View

Interface DefinitionContainerInterface

Namespace: Cake\Container

Method Summary

  • add() public
  • addDefinitions() public

    Add multiple definitions at once.

  • addServiceProvider() public
  • addShared() public
  • extend() public
  • get() public

    Finds an entry of the container by its identifier and returns it.

  • getNew() public
  • has() public

    Returns true if the container can return an entry for the given identifier. Returns false otherwise.

  • hasDefinition() public

    Check if the container has a registered definition for the given id.

  • inflector() public

Method Detail

add() ¶ public

add(string $id, mixed $concrete = null): Cake\Container\Definition\DefinitionInterface
Parameters
string $id
mixed $concrete optional
Returns
Cake\Container\Definition\DefinitionInterface

addDefinitions() ¶ public

addDefinitions(array<int|string, array<class-string>|class-string> $definitions): self

Add multiple definitions at once.

Supports multiple formats:

  • [Foo::class] - class name as value, registers as itself
  • ['alias' => Foo::class] - alias as key, class as value
  • [Foo::class => [Bar::class]] - class with constructor arguments
Parameters
array<int|string, array<class-string>|class-string> $definitions
Returns
self

addServiceProvider() ¶ public

addServiceProvider(Cake\Container\ServiceProvider\ServiceProviderInterface $provider): self
Parameters
Cake\Container\ServiceProvider\ServiceProviderInterface $provider
Returns
self

addShared() ¶ public

addShared(string $id, mixed $concrete = null): Cake\Container\Definition\DefinitionInterface
Parameters
string $id
mixed $concrete optional
Returns
Cake\Container\Definition\DefinitionInterface

extend() ¶ public

extend(string $id): Cake\Container\Definition\DefinitionInterface
Parameters
string $id
Returns
Cake\Container\Definition\DefinitionInterface

get() ¶ public

get(string $id): mixed

Finds an entry of the container by its identifier and returns it.

Parameters
string $id

Identifier of the entry to look for.

Returns
mixed

Entry.

Throws
NotFoundExceptionInterface
No entry was found for **this** identifier.
ContainerExceptionInterface
Error while retrieving the entry.

getNew() ¶ public

getNew(mixed $id): mixed
Parameters
mixed $id
Returns
mixed

has() ¶ public

has(string $id): bool

Returns true if the container can return an entry for the given identifier. Returns false otherwise.

has($id) returning true does not mean that get($id) will not throw an exception. It does however mean that get($id) will not throw a NotFoundExceptionInterface.

Parameters
string $id

Identifier of the entry to look for.

Returns
bool

hasDefinition() ¶ public

hasDefinition(string $id): bool

Check if the container has a registered definition for the given id.

Unlike has(), this only checks explicit definitions, not service providers or delegate containers.

Parameters
string $id
Returns
bool

inflector() ¶ public

inflector(string $type, callable|null $callback = null): Cake\Container\Inflector\InflectorInterface
Parameters
string $type
callable|null $callback optional
Returns
Cake\Container\Inflector\InflectorInterface
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