Edit File - File Manager

Edit File: HydratePublicProperties.php

<?php

namespace Livewire\HydrationMiddleware;

use Livewire\Exceptions\PublicPropertyTypeNotAllowedException;
use Illuminate\Queue\SerializesAndRestoresModelIdentifiers;
use Illuminate\Contracts\Queue\QueueableCollection;
use Illuminate\Contracts\Database\ModelIdentifier;
use Illuminate\Support\Carbon as IlluminateCarbon;
use Illuminate\Contracts\Queue\QueueableEntity;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Collection;
use Illuminate\Support\Stringable;
use Illuminate\Support\Arr;
use Illuminate\Support\Str;
use Carbon\CarbonImmutable;
use ReflectionProperty;
use Livewire\Wireable;
use DateTimeImmutable;
use Carbon\Carbon;
use DateTime;
use DateTimeInterface;
use stdClass;
use Normalizer;

class HydratePublicProperties implements HydrationMiddleware
{
    use SerializesAndRestoresModelIdentifiers;

public static function hydrate($instance, $request)
    {
        $publicProperties = $request->memo['data'] ?? [];

$dates = data_get($request, 'memo.dataMeta.dates', []);
        $collections = data_get($request, 'memo.dataMeta.collections', []);
        $models = data_get($request, 'memo.dataMeta.models', []);
        $modelCollections = data_get($request, 'memo.dataMeta.modelCollections', []);
        $stringables = data_get($request, 'memo.dataMeta.stringables', []);
        $wireables = data_get($request, 'memo.dataMeta.wireables', []);
        $enums = data_get($request, 'memo.dataMeta.enums', []);

foreach ($publicProperties as $property => $value) {
            if ($type = data_get($dates, $property)) {
                $types = [
                    'native' => DateTime::class,
                    'nativeImmutable' => DateTimeImmutable::class,
                    'carbon' => Carbon::class,
                    'carbonImmutable' => CarbonImmutable::class,
                    'illuminate' => IlluminateCarbon::class,
                ];

data_set($instance, $property, new $types[$type]($value));
            } else if (in_array($property, $collections)) {
                data_set($instance, $property, collect($value));
            } else if ($class = data_get($enums, $property)) {
                data_set($instance, $property, $class::from($value));
            } else if ($serialized = data_get($models, $property)) {
                static::hydrateModel($serialized, $property, $request, $instance);
            } else if ($serialized = data_get($modelCollections, $property)) {
                static::hydrateModels($serialized, $property, $request, $instance);
            } else if (in_array($property, $stringables)) {
                data_set($instance, $property, new Stringable($value));
            } else if (in_array($property, $wireables) && version_compare(PHP_VERSION, '7.4', '>=')) {
                $type = (new \ReflectionClass($instance))
                    ->getProperty($property)
                    ->getType()
                    ->getName();

data_set($instance, $property, $type::fromLivewire($value));
            } else {
                // If the value is null and the property is typed, don't set it, because all values start off as null and this
                // will prevent Typed properties from wining about being set to null.
                if (version_compare(PHP_VERSION, '7.4', '<')) {
                    $instance->$property = $value;
                } else {
                    // Do not use reflection for virtual component properties.
                    if (property_exists($instance, $property) && (new ReflectionProperty($instance, $property))->getType()){
                        is_null($value) || $instance->$property = $value;
                    } else {
                        $instance->$property = $value;
                    }
                }

}
        }
    }

public static function dehydrate($instance, $response)
    {
        $publicData = $instance->getPublicPropertiesDefinedBySubClass();

data_set($response, 'memo.data', []);
        data_set($response, 'memo.dataMeta', []);

array_walk($publicData, function ($value, $key) use ($instance, $response) {
            if (
                // The value is a supported type, set it in the data, if not, throw an exception for the user.
                is_bool($value) || is_null($value) || is_numeric($value)
            ) {
                data_set($response, 'memo.data.'.$key, $value);
            } else if(is_array($value)) {
                // The data here needs to be normalised, so that Safari handles special charaters properly without throwing a checksum exception.
                data_set($response, 'memo.data.'.$key, static::normalizeArray($value));
            } else if(is_string($value)) {
                // The data here needs to be normalised, so that Safari handles special charaters properly without throwing a checksum exception.
                data_set($response, 'memo.data.'.$key, Normalizer::normalize($value));
            } else if ($value instanceof Wireable && version_compare(PHP_VERSION, '7.4', '>=')) {
                $response->memo['dataMeta']['wireables'][] = $key;

data_set($response, 'memo.data.'.$key, $value->toLivewire());
            } else if ($value instanceof QueueableEntity) {
                static::dehydrateModel($value, $key, $response, $instance);
            } else if ($value instanceof QueueableCollection) {
                static::dehydrateModels($value, $key, $response, $instance);
            } else if ($value instanceof Collection) {
                $response->memo['dataMeta']['collections'][] = $key;

// The data here needs to be normalised, so that Safari handles special charaters properly without throwing a checksum exception.
                data_set($response, 'memo.data.'.$key, static::normalizeCollection($value)->toArray());
            } else if ($value instanceof DateTimeInterface) {
                if ($value instanceof IlluminateCarbon) {
                    $response->memo['dataMeta']['dates'][$key] = 'illuminate';
                } elseif ($value instanceof Carbon) {
                    $response->memo['dataMeta']['dates'][$key] = 'carbon';
                } elseif ($value instanceof CarbonImmutable) {
                    $response->memo['dataMeta']['dates'][$key] = 'carbonImmutable';
                } elseif ($value instanceof DateTimeImmutable) {
                    $response->memo['dataMeta']['dates'][$key] = 'nativeImmutable';
                } else {
                    $response->memo['dataMeta']['dates'][$key] = 'native';
                }

data_set($response, 'memo.data.'.$key, $value->format(\DateTimeInterface::ISO8601));
            } else if ($value instanceof Stringable) {
                $response->memo['dataMeta']['stringables'][] = $key;

data_set($response, 'memo.data.'.$key, $value->__toString());
            } else if (is_subclass_of($value, 'BackedEnum')) {
                $response->memo['dataMeta']['enums'][$key] = get_class($value);

data_set($response, 'memo.data.'.$key, $value->value);
            } else {
                throw new PublicPropertyTypeNotAllowedException($instance::getName(), $key, $value);
            }
        });
    }

protected static function hydrateModel($serialized, $property, $request, $instance)
    {
        if (isset($serialized['id'])) {
            $model = (new static)->getRestoredPropertyValue(
                new ModelIdentifier($serialized['class'], $serialized['id'], $serialized['relations'], $serialized['connection'])
            );
        } else {
            $model = new $serialized['class'];
        }

$dirtyModelData = $request->memo['data'][$property];

static::setDirtyData($model, $dirtyModelData);

$instance->$property = $model;
    }

protected static function hydrateModels($serialized, $property, $request, $instance)
    {
        $idsWithNullsIntersparsed = $serialized['id'];

$models = (new static)->getRestoredPropertyValue(
            new ModelIdentifier($serialized['class'], $serialized['id'], $serialized['relations'], $serialized['connection'])
        );

// Use `loadMissing` here incase loading collection relations gets fixed in Laravel framework,
        // in which case we don't want to load relations again.
        $models->loadMissing($serialized['relations']);

$dirtyModelData = $request->memo['data'][$property];

foreach ($idsWithNullsIntersparsed as $index => $id) {
            if (is_null($id)) {
                $model = new $serialized['class'];
                $models->splice($index, 0, [$model]);
            }

static::setDirtyData(data_get($models, $index), data_get($dirtyModelData, $index, []));
        }

$instance->$property = $models;
    }

public static function setDirtyData($model, $data) {
        foreach ($data as $key => $value) {
            if (is_array($value) && !empty($value)) {
                $existingData = data_get($model, $key);

if (is_array($existingData)) {
                    $updatedData = static::setDirtyData([], data_get($data, $key));
                } else {
                    $updatedData = static::setDirtyData($existingData, data_get($data, $key));
                }
            } else {
                $updatedData = data_get($data, $key);
            }

if ($model instanceof Model && $model->relationLoaded($key)) {
                $model->setRelation($key, $updatedData);
            } else {
                data_set($model, $key, $updatedData);
            }
        }

return $model;
    }

protected static function dehydrateModel($value, $property, $response, $instance)
    {
        $serializedModel = $value instanceof QueueableEntity && ! $value->exists
            ? ['class' => get_class($value)]
            : (array) (new static)->getSerializedPropertyValue($value);

// Deserialize the models into the "meta" bag.
        data_set($response, 'memo.dataMeta.models.'.$property, $serializedModel);

$filteredModelData = static::filterData($instance, $property);

// Only include the allowed data (defined by rules) in the response payload
        data_set($response, 'memo.data.'.$property, $filteredModelData);
    }

protected static function dehydrateModels($value, $property, $response, $instance)
    {
        $serializedModel = (array) (new static)->getSerializedPropertyValue($value);

// Deserialize the models into the "meta" bag.
        data_set($response, 'memo.dataMeta.modelCollections.'.$property, $serializedModel);

$filteredModelData = static::filterData($instance, $property);

// Only include the allowed data (defined by rules) in the response payload
        data_set($response, 'memo.data.'.$property, $filteredModelData);
    }

public static function filterData($instance, $property) {
        $data = $instance->$property->toArray();

$rules = $instance->rulesForModel($property)->keys();

$rules = static::processRules($rules)->get($property, []);

return static::extractData($data, $rules, []);
    }

public static function processRules($rules) {
        $rules = Collection::wrap($rules);

$rules = $rules
            ->mapInto(Stringable::class);

[$groupedRules, $singleRules] = $rules->partition(function($rule) {
            return $rule->contains('.');
        });

$singleRules = $singleRules->map(function(Stringable $rule) {
            return $rule->__toString();
        });

$groupedRules = $groupedRules->mapToGroups(function(Stringable $rule) {
                return [$rule->before('.')->__toString() => $rule->after('.')];
            });

$groupedRules = $groupedRules->mapWithKeys(function($rules, $group) {
            // Split rules into collection and model rules.
            [$collectionRules, $modelRules] = $rules
                ->partition(function($rule) {
                    return $rule->contains('.');
                });

// If collection rules exist, and value of * in model rules, remove * from model rule.
            if ($collectionRules->count()) {
                $modelRules = $modelRules->reject(function($value) {
                    return ((string) $value) === '*';
                });
            }

// Recurse through collection rules.
            $collectionRules = static::processRules($collectionRules);

$modelRules = $modelRules->map->__toString();

$rules = $modelRules->union($collectionRules);

return [$group => $rules];
        });

$rules = $singleRules->union($groupedRules);

return $rules;
    }

public static function extractData($data, $rules, $filteredData)
    {
        foreach($rules as $key => $rule) {
            if ($key === '*') {
                if ($data) {
                    foreach($data as $item) {
                        $filteredData[] = static::extractData($item, $rule, []);
                    }
                }
            } else {
                if (is_array($rule) || $rule instanceof Collection) {
                    $newFilteredData = data_get($data, $key) instanceof stdClass ? new stdClass : [];
                    data_set($filteredData, $key, static::extractData(data_get($data, $key), $rule, $newFilteredData));
                } else {
                    if ($rule == "*") {
                        $filteredData = $data;
                    } elseif (Arr::accessible($data) || is_object($data)) {
                        data_set($filteredData, $rule, data_get($data, $rule));
                    }
                }
            }
        }

return $filteredData;
    }

protected static function normalizeArray($value)
    {
        return array_map(function ($item) {
            if (is_string($item)) {
                return Normalizer::normalize($item);
            }

if (is_array($item)) {
                return static::normalizeArray($item);
            }

if ($item instanceof Collection) {
                return static::normalizeCollection($item);
            }

return $item;
        }, $value);
    }

protected static function normalizeCollection($value)
    {
        return $value->map(function ($item) {
            if (is_string($item)) {
                return Normalizer::normalize($item);
            }

if (is_array($item)) {
                return static::normalizeArray($item);
            }

if ($item instanceof Collection) {
                return static::normalizeCollection($item);
            }

return $item;
        });
    }
}

Back to File Manager