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/v2) 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/v2/introduction) - [ Support us ](https://spatie.be/docs/laravel-data/v2/support-us) - [ Requirements ](https://spatie.be/docs/laravel-data/v2/requirements) - [ Installation & setup ](https://spatie.be/docs/laravel-data/v2/installation-setup) - [ Questions and issues ](https://spatie.be/docs/laravel-data/v2/questions-issues) - [ Changelog ](https://spatie.be/docs/laravel-data/v2/changelog) - [ About us ](https://spatie.be/docs/laravel-data/v2/about-us) Getting started --------------- - [ Quickstart ](https://spatie.be/docs/laravel-data/v2/getting-started/quickstart) As a DTO -------- - [ Creating a data object ](https://spatie.be/docs/laravel-data/v2/as-a-data-transfer-object/creating-a-data-object) - [ Optional properties ](https://spatie.be/docs/laravel-data/v2/as-a-data-transfer-object/optional-properties) - [ Nesting ](https://spatie.be/docs/laravel-data/v2/as-a-data-transfer-object/nesting) - [ Collections ](https://spatie.be/docs/laravel-data/v2/as-a-data-transfer-object/collections) - [ Casts ](https://spatie.be/docs/laravel-data/v2/as-a-data-transfer-object/casts) - [ From a request ](https://spatie.be/docs/laravel-data/v2/as-a-data-transfer-object/request-to-data-object) As a resource ------------- - [ From data to resource ](https://spatie.be/docs/laravel-data/v2/as-a-resource/from-data-to-resource) - [ Including and excluding properties ](https://spatie.be/docs/laravel-data/v2/as-a-resource/lazy-properties) - [ Wrapping ](https://spatie.be/docs/laravel-data/v2/as-a-resource/wrapping) - [ Transforming data ](https://spatie.be/docs/laravel-data/v2/as-a-resource/transformers) Advanced usage -------------- - [ Eloquent casting ](https://spatie.be/docs/laravel-data/v2/advanced-usage/eloquent-casting) - [ Transforming to TypeScript ](https://spatie.be/docs/laravel-data/v2/advanced-usage/typescript) - [ Working with dates ](https://spatie.be/docs/laravel-data/v2/advanced-usage/working-with-dates) - [ Normalizers ](https://spatie.be/docs/laravel-data/v2/advanced-usage/normalizers) - [ Pipeline ](https://spatie.be/docs/laravel-data/v2/advanced-usage/pipeline) - [ Use with Inertia ](https://spatie.be/docs/laravel-data/v2/advanced-usage/use-with-inertia) - [ Use with Livewire ](https://spatie.be/docs/laravel-data/v2/advanced-usage/use-with-livewire) - [ Creating a cast ](https://spatie.be/docs/laravel-data/v2/advanced-usage/creating-a-cast) - [ Creating a transformer ](https://spatie.be/docs/laravel-data/v2/advanced-usage/creating-a-transformer) - [ Creating a rule inferrer ](https://spatie.be/docs/laravel-data/v2/advanced-usage/creating-a-rule-inferrer) - [ Internal structures ](https://spatie.be/docs/laravel-data/v2/advanced-usage/internal-structures) - [ Validation attributes ](https://spatie.be/docs/laravel-data/v2/advanced-usage/validation-attributes) You are viewing the documentation for **an older version** of this package. You can check the version you are using with the following command: ` composer show spatie/laravel-data ` 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) 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 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 `DataType` of the property (more on that later) - `validate` should the property be automatically validated - `isPromoted` is the property constructor promoted - `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 `ReflectionAttribute`s 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 of the class (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) DataParameter ----------------------------------------------------------------------------------------------- A data parameter represents a single parameter/property within a data method. - `name` the name of the parameter - `hasDefaultValue` has the parameter a default value - `defaultValue` the default value of the parameter - `isPromoted` is the property/parameter constructor promoted - `type` the `DataType` of the parameter (more on that later) DataType -------------------------------------------------------------------------------- - `isNullable` can the type be nullable - `isMixed` is the type a mixed type - `isLazy` can the type be lazy - `isOptional` can the type be optional - `isDataObject` is the type a data object - `isDataCollectable` is the type a data collection - `dataClass` the class of the data object/collection - `acceptedTypes` an array of types accepted by this type + their base types