Trait Atk4\Core\DiContainerTrait

A class with this trait will have setDefaults() method that can be passed list of default properties.

$view->setDefaults(['ui' => 'segment']);

Typically you would want to do that inside your constructor. The default handling of the properties is:

only apply properties that are defined
only set property if it's current value is null
ignore defaults that have null value
if existing property and default have array, then both arrays will be merged

Several classes may opt to extend setDefaults, for example in Agile UI setDefaults is extended to support classes and content:

$segment->setDefaults(['Hello There', 'red', 'ui' => 'segment']);

WARNING: Do not use this trait unless you have a lot of properties to inject. Also follow the guidelines on https://github.com/atk4/ui/wiki/Object-Constructors

Relying on this trait excessively may cause anger management issues to some code reviewers.

Atk4\Core\DiContainerTrait
- Atk4\Ui\Js\JsConditionalForm implements JsExpressionable uses DiContainerTrait
- Atk4\Ui\Js\JsToast implements JsExpressionable uses DiContainerTrait
- Atk4\Ui\Js\JsExpression implements JsExpressionable uses DiContainerTrait
  - Atk4\Ui\Js\JsModal
  - Atk4\Ui\Js\JsChain
    - Atk4\Ui\Js\Jquery
- Atk4\Ui\Table\Column uses AppScopeTrait, DiContainerTrait, InitializerTrait, NameTrait, TrackableTrait
- Atk4\Data\Persistence uses ContainerTrait, DiContainerTrait, DynamicMethodTrait, HookTrait, NameTrait
- Atk4\Data\Persistence\Sql\Expression implements Expressionable, ArrayAccess<int|string, mixed> uses DiContainerTrait
- Atk4\Ui\App uses AppScopeTrait, DiContainerTrait, DynamicMethodTrait, HookTrait
- Atk4\Data\Persistence\Sql\Connection uses DiContainerTrait
- Atk4\Data\Reference uses DiContainerTrait, InitializerTrait, TrackableTrait
- Atk4\Data\Model implements IteratorAggregate<static> uses CollectionTrait, ContainerTrait, DiContainerTrait, DynamicMethodTrait, HintableModelTrait, HookTrait, InitializerTrait, JoinsTrait, ReferencesTrait, UserActionsTrait, ReadableCaptionTrait
- Atk4\Data\Model\Join uses DiContainerTrait, InitializerTrait, JoinLinkTrait, TrackableTrait
  - Atk4\Data\Persistence\Array_\Join
  - Atk4\Data\Persistence\Sql\Join
- Atk4\Core\Translator\Translator uses DiContainerTrait
- Atk4\Data\Field implements Expressionable uses DiContainerTrait, FieldPropertiesTrait, JoinLinkTrait, ReadableCaptionTrait, TrackableTrait
- Atk4\Data\Model\UserAction uses DiContainerTrait, InitializerTrait, TrackableTrait

Located at core/src/DiContainerTrait.php

Methods


					
	public

setDefaults(array<string, mixed> $properties, bool $passively = false): $this

Call from __construct() to initialize the properties allowing developer to pass Dependency Injector Container.

Parameters

$passively

If true, existing non-null values will be kept


					
	protected

setMissingProperty(string $propertyName, mixed $value): void


					
	public
					static

assertInstanceOf(object $object): static

Return the argument and assert it is instance of current class.

The best, typehinting-friendly, way to annotate object type if it not defined at method header or strong typing in method header cannot be used.


					
	private
					static

_fromSeedPrecheck(array<mixed>|object $seed, bool $unsafe): array<mixed>|object


					
	public
					static

fromSeed(array<mixed>|object $seed = [], array<mixed> $defaults = []): static

Create new object from seed and assert it is instance of current class.

The best, typehinting-friendly, way to create an object if it should not be immediately added to a parent (otherwise use addTo() method).

Parameters

$seed

the first element specifies a class name, other elements are seed


					
	public
					static

fromSeedUnsafe(array<mixed>|object $seed = [], array<mixed> $defaults = []): static

Same as fromSeed(), but the new object is not asserted to be an instance of this class.

Parameters

$seed

the first element specifies a class name, other elements are seed

Namespaces

Classes

Traits

Exceptions

Trait Atk4\Core\DiContainerTrait

Parameters

Parameters

Parameters