0 follower

Yii Framework 3.0 API Documentation

This is the Yii Framework API Documentation. Here you will find detailed information about all classes provided by the Framework. Below you find a list of the existing classes, interfaces, and traits, ordered by their fully qualified name (including the namespace). Each of them has a dedicated page which contains a description about the purpose of the class, a list of the available methods, properties and constants, and detailed description on how to use each of them.

On this page you find all the classes included in version 3.0 of the framework. You can use the dropdown menu on the top right to switch between versions.

You can search API documentation using the search form on the top. You can search for class names and also method and property names, e.g. ActiveRecord.save() or just .save() or ::save().

This page is also available in JSON format:
curl https://www.yiiframework.com/doc/api/3.0/hydrator -H 'Accept: application/json'

Class Description
Yiisoft\Hydrator\ArrayData Holds data to hydrate an object from and a map to use when populating an object.
Yiisoft\Hydrator\AttributeHandling\DataAttributesHandler Handles data attributes that implement {@see DataAttributeInterface}.
Yiisoft\Hydrator\AttributeHandling\Exception\AttributeResolverNonInstantiableException Thrown when an attribute resolver is not instantiable.
Yiisoft\Hydrator\AttributeHandling\Exception\UnexpectedAttributeException Thrown when an attribute isn't of the expected class. Used in data and parameter attribute handlers.
Yiisoft\Hydrator\AttributeHandling\ParameterAttributeResolveContext Holds attribute resolving context data.
Yiisoft\Hydrator\AttributeHandling\ParameterAttributesHandler Handles parameters' attributes that implement {@see ParameterAttributeInterface}.
Yiisoft\Hydrator\AttributeHandling\ResolverFactory\AttributeResolverFactoryInterface An interface for attribute resolver factories.
Yiisoft\Hydrator\AttributeHandling\ResolverFactory\ContainerAttributeResolverFactory A factory for attribute resolvers that are instantiable by a container.
Yiisoft\Hydrator\AttributeHandling\ResolverFactory\ReflectionAttributeResolverFactory A factory for attribute resolvers that are instantiable via reflection.
Yiisoft\Hydrator\Attribute\Data\DataAttributeInterface An interface for data attributes (allowed only in classes). Can be used to change the way data to be assigned is obtained.
Yiisoft\Hydrator\Attribute\Data\DataAttributeResolverInterface An interface for resolvers of attributes that implement {@see DataAttributeInterface}.
Yiisoft\Hydrator\Attribute\Parameter\Collection Converts the resolved value to array of instances of the class specified in {@see Collection::$className}.
Yiisoft\Hydrator\Attribute\Parameter\CollectionResolver
Yiisoft\Hydrator\Attribute\Parameter\Data Resolve value from the data array used for object hydration by key specified.
Yiisoft\Hydrator\Attribute\Parameter\Di Resolve value as instance obtained from container by the specified ID or auto-resolved ID by PHP type.
Yiisoft\Hydrator\Attribute\Parameter\DiNotFoundException Exception that is thrown by {@see DiResolver} when an object is not found or object ID auto-resolving fails.
Yiisoft\Hydrator\Attribute\Parameter\DiResolver Resolver for {@see Di} attribute. Obtains dependency from container by ID specified or auto-resolved ID by PHP type.
Yiisoft\Hydrator\Attribute\Parameter\LeftTrim Strip whitespace (or other characters) from the beginning of a resolved string value.
Yiisoft\Hydrator\Attribute\Parameter\LeftTrimResolver
Yiisoft\Hydrator\Attribute\Parameter\ParameterAttributeInterface An interface for parameters' attributes (allowed only in class properties and constructor parameters). Can be used for getting value (e. g, from request) or type casting value.
Yiisoft\Hydrator\Attribute\Parameter\ParameterAttributeResolverInterface An interface for resolvers of attributes that implement {@see ParameterAttributeInterface}.
Yiisoft\Hydrator\Attribute\Parameter\RightTrim Strip whitespace (or other characters) from the end of a resolved string value.
Yiisoft\Hydrator\Attribute\Parameter\RightTrimResolver
Yiisoft\Hydrator\Attribute\Parameter\ToArrayOfStrings Casts the resolved value to array of strings.
Yiisoft\Hydrator\Attribute\Parameter\ToArrayOfStringsResolver
Yiisoft\Hydrator\Attribute\Parameter\ToDateTime Converts the resolved value to DateTimeImmutable object. Non-resolved and invalid values are skipped.
Yiisoft\Hydrator\Attribute\Parameter\ToDateTimeResolver
Yiisoft\Hydrator\Attribute\Parameter\ToString Converts the resolved value to string. Non-resolved values are skipped.
Yiisoft\Hydrator\Attribute\Parameter\Trim Strip whitespace (or other characters) from the beginning and end of a resolved string value.
Yiisoft\Hydrator\Attribute\Parameter\TrimResolver
Yiisoft\Hydrator\Attribute\SkipHydration Attribute that marks a class property or constructor parameter for as ignored on hydration.
Yiisoft\Hydrator\DataInterface An interface for data objects.
Yiisoft\Hydrator\Exception\AbstractClassException Thrown when an abstract class is attempted to be instantiated.
Yiisoft\Hydrator\Exception\NonExistClassException Thrown when a class is attempted to be instantiated but does not exist.
Yiisoft\Hydrator\Exception\NonInstantiableException Thrown when a class is not instantiable.
Yiisoft\Hydrator\Exception\NonPublicConstructorException Thrown when a class is not instantiable because of non-public constructor.
Yiisoft\Hydrator\Exception\WrongConstructorArgumentsCountException Thrown when a class is not instantiable because of wrong constructor arguments count.
Yiisoft\Hydrator\Hydrator Creates or hydrate objects from a set of raw data.
Yiisoft\Hydrator\HydratorInterface Creates or hydrates objects from a set of raw data.
Yiisoft\Hydrator\Internal\ConstructorArgumentsExtractor
Yiisoft\Hydrator\Internal\ReflectionFilter
Yiisoft\Hydrator\ObjectFactory\ContainerObjectFactory A factory for objects that are instantiable by a container.
Yiisoft\Hydrator\ObjectFactory\ObjectFactoryInterface An interface for object factory.
Yiisoft\Hydrator\ObjectFactory\ReflectionObjectFactory A factory for objects that are instantiable by using reflection.
Yiisoft\Hydrator\ObjectMap Provides a mapping of object property names to keys in the data array.
Yiisoft\Hydrator\Result The result object that provides whether the value is resolved or not, and the value itself.
Yiisoft\Hydrator\TypeCaster\CompositeTypeCaster Allows using many type casters one by one before the value cast successfully.
Yiisoft\Hydrator\TypeCaster\EnumTypeCaster Casts values to enumerations.
Yiisoft\Hydrator\TypeCaster\HydratorTypeCaster Casts arrays to objects.
Yiisoft\Hydrator\TypeCaster\NoTypeCaster Doesn't cast value at all leaving it as is.
Yiisoft\Hydrator\TypeCaster\NullTypeCaster Configurable type caster for casting value to null.
Yiisoft\Hydrator\TypeCaster\PhpNativeTypeCaster Casts value to a type obtained from {@see ReflectionType} passed.
Yiisoft\Hydrator\TypeCaster\TypeCastContext Holds type casting context data.
Yiisoft\Hydrator\TypeCaster\TypeCasterInterface Casts value to a type obtained from {@see ReflectionType} passed.