Internal structures | laravel-data | Spatie SPATIE Laravel Data =============== spatie.be/open-source [Docs](https://spatie.be/docs) [Laravel-data](https://spatie.be/docs/laravel-data/v4) Advanced-usage Internal structures Version v4 v3 v2 v1 Other versions for crawler [v4](https://spatie.be/docs/laravel-data/v4) [v3](https://spatie.be/docs/laravel-data/v3) [v2](https://spatie.be/docs/laravel-data/v2) [v1](https://spatie.be/docs/laravel-data/v1) - [ Introduction ](https://spatie.be/docs/laravel-data/v4/introduction) - [ Support us ](https://spatie.be/docs/laravel-data/v4/support-us) - [ Requirements ](https://spatie.be/docs/laravel-data/v4/requirements) - [ Installation & setup ](https://spatie.be/docs/laravel-data/v4/installation-setup) - [ Third party packages ](https://spatie.be/docs/laravel-data/v4/third-party-packages) - [ Questions and issues ](https://spatie.be/docs/laravel-data/v4/questions-issues) - [ Changelog ](https://spatie.be/docs/laravel-data/v4/changelog) - [ About us ](https://spatie.be/docs/laravel-data/v4/about-us) Getting started --------------- - [ Quickstart ](https://spatie.be/docs/laravel-data/v4/getting-started/quickstart) As a DTO -------- - [ Creating a data object ](https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/creating-a-data-object) - [ Nesting ](https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/nesting) - [ Collections ](https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/collections) - [ Abstract Data ](https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/abstract-data) - [ Casts ](https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/casts) - [ Optional properties ](https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/optional-properties) - [ Mapping property names ](https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/mapping-property-names) - [ Default values ](https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/defaults) - [ Computed values ](https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/computed) - [ From a request ](https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/request-to-data-object) - [ From a model ](https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/model-to-data-object) - [ Injecting property values ](https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/injecting-property-values) - [ Factories ](https://spatie.be/docs/laravel-data/v4/as-a-data-transfer-object/factories) Validation ---------- - [ Introduction ](https://spatie.be/docs/laravel-data/v4/validation/introduction) - [ Auto rule inferring ](https://spatie.be/docs/laravel-data/v4/validation/auto-rule-inferring) - [ Using validation attributes ](https://spatie.be/docs/laravel-data/v4/validation/using-validation-attributes) - [ Manual rules ](https://spatie.be/docs/laravel-data/v4/validation/manual-rules) - [ Working with the validator ](https://spatie.be/docs/laravel-data/v4/validation/working-with-the-validator) - [ Nesting Data ](https://spatie.be/docs/laravel-data/v4/validation/nesting-data) - [ Skipping validation ](https://spatie.be/docs/laravel-data/v4/validation/skipping-validation) As a resource ------------- - [ From data to array ](https://spatie.be/docs/laravel-data/v4/as-a-resource/from-data-to-array) - [ From data to resource ](https://spatie.be/docs/laravel-data/v4/as-a-resource/from-data-to-resource) - [ Mapping property names ](https://spatie.be/docs/laravel-data/v4/as-a-resource/mapping-property-names) - [ Appending properties ](https://spatie.be/docs/laravel-data/v4/as-a-resource/appending-properties) - [ Wrapping ](https://spatie.be/docs/laravel-data/v4/as-a-resource/wrapping) - [ Including and excluding properties ](https://spatie.be/docs/laravel-data/v4/as-a-resource/lazy-properties) - [ Transforming data ](https://spatie.be/docs/laravel-data/v4/as-a-resource/transformers) Advanced usage -------------- - [ Eloquent casting ](https://spatie.be/docs/laravel-data/v4/advanced-usage/eloquent-casting) - [ Transforming to TypeScript ](https://spatie.be/docs/laravel-data/v4/advanced-usage/typescript) - [ Working with dates ](https://spatie.be/docs/laravel-data/v4/advanced-usage/working-with-dates) - [ Normalizers ](https://spatie.be/docs/laravel-data/v4/advanced-usage/normalizers) - [ Pipeline ](https://spatie.be/docs/laravel-data/v4/advanced-usage/pipeline) - [ Creating a cast ](https://spatie.be/docs/laravel-data/v4/advanced-usage/creating-a-cast) - [ Creating a transformer ](https://spatie.be/docs/laravel-data/v4/advanced-usage/creating-a-transformer) - [ Creating a rule inferrer ](https://spatie.be/docs/laravel-data/v4/advanced-usage/creating-a-rule-inferrer) - [ Use with Inertia ](https://spatie.be/docs/laravel-data/v4/advanced-usage/use-with-inertia) - [ Use with Livewire ](https://spatie.be/docs/laravel-data/v4/advanced-usage/use-with-livewire) - [ Internal structures ](https://spatie.be/docs/laravel-data/v4/advanced-usage/internal-structures) - [ Mapping rules ](https://spatie.be/docs/laravel-data/v4/advanced-usage/mapping-rules) - [ Validation attributes ](https://spatie.be/docs/laravel-data/v4/advanced-usage/validation-attributes) - [ Get data from a class quickly ](https://spatie.be/docs/laravel-data/v4/advanced-usage/get-data-from-a-class-quickly) - [ Performance ](https://spatie.be/docs/laravel-data/v4/advanced-usage/performance) - [ Commands ](https://spatie.be/docs/laravel-data/v4/advanced-usage/commands) - [ Traits and interfaces ](https://spatie.be/docs/laravel-data/v4/advanced-usage/traits-and-interfaces) - [ In Packages ](https://spatie.be/docs/laravel-data/v4/advanced-usage/in-packages) - [ Available property mappers ](https://spatie.be/docs/laravel-data/v4/advanced-usage/available-property-mappers) Internal structures =================== ### On this page 1. [ DataClass ](#content-dataclass) 2. [ DataProperty ](#content-dataproperty) 3. [ DataMethod ](#content-datamethod) 4. [ DataParameter ](#content-dataparameter) 5. [ DataType ](#content-datatype) 6. [ DataPropertyType ](#content-datapropertytype) 7. [ DataTypeKind ](#content-datatypekind) 8. [ NamedType ](#content-namedtype) 9. [ UnionType / IntersectionType ](#content-uniontype--intersectiontype) This package has some internal structures which are used to analyze data objects and their properties. They can be helpful when writing casts, transformers or rule inferrers. DataClass ----------------------------------------------------------------------------------- The DataClass represents the structure of a data object and has the following properties: - `name` the name of the data class - `properties` all the `DataProperty`'s of the class (more on that later) - `methods` all the magical creation `DataMethod`s of the class (more on that later) - `constructorMethod` the constructor `DataMethod` of the class - `isReadOnly` is the class read only - `isAbstract` is the class abstract - `appendable` is the class implementing `AppendableData` - `includeable` is the class implementing `IncludeableData` - `responsable` is the class implementing `ResponsableData` - `transformable` is the class implementing `TransformableData` - `validatable` is the class implementing `ValidatableData` - `wrappable` is the class implementing `WrappableData` - `emptyData` the the class implementing `EmptyData` - `attributes` a collection of resolved attributes assigned to the class - `dataCollectablePropertyAnnotations` the property annotations of the class used to infer the data collection type - `allowedRequestIncludes` the allowed request includes of the class - `allowedRequestExcludes` the allowed request excludes of the class - `allowedRequestOnly` the allowed request only of the class - `allowedRequestExcept` the allowed request except of the class - `outputMappedProperties` properties names which are mapped when transforming the data object - `transformationFields` structure of the transformation fields DataProperty -------------------------------------------------------------------------------------------- A data property represents a single property within a data object. - `name` the name of the property - `className` the name of the class of the property - `type` the `DataPropertyType` of the property (more on that later) - `validate` should the property be automatically validated - `computed` is the property computed - `hidden` will the property be hidden when transforming the data object - `isPromoted` is the property constructor promoted - `isReadOnly` is the property read only - `hasDefaultValue` has the property a default value - `defaultValue` the default value of the property - `cast` the cast assigned to the property - `transformer` the transformer assigned to the property - `inputMappedName` the name used to map a property name given - `outputMappedName` the name used to map a property name onto - `attributes` a collection of resolved attributes assigned to the property DataMethod -------------------------------------------------------------------------------------- A data method represents a method within a data object. - `name` the name of the method - `parameters` all the `DataParameter`'s and `DataProperty`s of the method (more on that later) - `isStatic` whether the method is static - `isPublic` whether the method is public - `isCustomCreationMethod` whether the method is a custom creation method (=magical creation method) - `returnType` the `DataType` of the return value (more on that later) DataParameter ----------------------------------------------------------------------------------------------- A data parameter represents a single parameter/property within a data method. - `name` the name of the parameter - `isPromoted` is the property/parameter constructor promoted - `hasDefaultValue` has the parameter a default value - `defaultValue` the default value of the parameter - `type` the `DataType` of the parameter (more on that later) DataType -------------------------------------------------------------------------------- A data type represents a type within a data object. - `Type` can be a `NamedType`, `UnionType` or `IntersectionType` (more on that later) - `isNullable` can the type be nullable - `isMixed` is the type a mixed type - `kind` the `DataTypeKind` of the type (more on that later) DataPropertyType -------------------------------------------------------------------------------------------------------- Extends from the `DataType` and has the following additional properties: - `isOptional` can the type be optional - `lazyType` the class of the lazy type for the property - `dataClass` the data object class of the property or the data object class of the collection it collects - `dataCollectableClass` the collectable type of the data objects - `kind` the `DataTypeKind` of the type (more on that later) DataTypeKind -------------------------------------------------------------------------------------------- An enum representing the kind of type of a property/parameter with respect to the package: - Default: a non package specific type - DataObject: a data object - DataCollection: a `DataCollection` of data objects - DataPaginatedCollection: a `DataPaginatedCollection` of data objects - DataCursorPaginatedCollection: a `DataCursorPaginatedCollection` of data objects - DataArray: an array of data objects - DataEnumerable: a `Enumerable` of data objects - DataPaginator: a `Paginator` of data objects - DataCursorPaginator: a `CursorPaginator` of data objects NamedType ----------------------------------------------------------------------------------- Represents a named PHP type with the following properties: - `name` the name of the type - `builtIn` is the type a built-in type - `acceptedTypes` an array of accepted types as string - `kind` the `DataTypeKind` of the type (more on that later) - `dataClass` the data object class of the property or the data object class of the collection it collects - `dataCollectableClass` the collectable type of the data objects - `isCastable` wetter the type is a `Castable` UnionType / IntersectionType ------------------------------------------------------------------------------------------------------------------------------------------ Represents a union or intersection of types with the following properties: - `types` an array of types (can be `NamedType`, `UnionType` or `IntersectionType`)