Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/Auth/AugmentedUser.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,7 @@ private function commonKeys()
];
}

public function get($handle): Value
public function get($handle, $fieldtype = null): Value
{
if ($handle === 'is_user') {
return new Value(true, 'is_user', null, $this->data);
Expand All@@ -57,7 +57,7 @@ public function get($handle): Value
return new Value(in_array(Str::after($handle, 'in_'), $this->groups()), $handle, null, $this->data);
}

return parent::get($handle);
return parent::get($handle, $fieldtype);
}

protected function roles()
Expand Down
61 changes: 49 additions & 12 deletions src/Data/AbstractAugmented.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ abstract class AbstractAugmented implements Augmented
protected $data;
protected $blueprintFields;
protected $relations = [];
protected $isSelecting = false;

public function __construct($data)
{
Expand All@@ -34,33 +35,52 @@ public function select($keys = null)
$arr = [];

$keys = $this->filterKeys(Arr::wrap($keys ?: $this->keys()));
$fields = $this->blueprintFields();

$this->isSelecting = true;

foreach ($keys as $key) {
$arr[$key] = $this->get($key);
$arr[$key] = $this->get($key, optional($fields->get($key))->fieldtype());
}

$this->isSelecting = false;

return (new AugmentedCollection($arr))->withRelations($this->relations);
}

abstract public function keys();

public function get($handle): Value
public function getAugmentedMethodValue($method)
{
if ($this->methodExistsOnThisClass($method)) {
return $this->$method();
}

return $this->data->$method();
}

protected function adjustFieldtype($handle, $fieldtype)
{
if ($this->isSelecting || $fieldtype !== null) {
return $fieldtype;
}

return $this->getFieldtype($handle);
}

public function get($handle, $fieldtype = null): Value
{
$method = Str::camel($handle);

if ($this->methodExistsOnThisClass($method)) {
$value = $this->$method();

return $value instanceof Value
? $value
: new Value($value, $method, null, $this->data);
return $this->wrapInvokable($method, true, $this, $handle, $fieldtype);
}

if (method_exists($this->data, $method) && collect($this->keys())->contains(Str::snake($handle))) {
return $this->wrapValue($this->data->$method(), $handle);
return $this->wrapInvokable($method, false, $this->data, $handle, $fieldtype);
}

return $this->wrapValue($this->getFromData($handle), $handle);
return $this->wrapValue($this->getFromData($handle), $handle, $fieldtype);
}

protected function filterKeys($keys)
Expand DownExpand Up@@ -93,18 +113,35 @@ protected function getFromData($handle)
return $value;
}

protected function wrapValue($value, $handle)
protected function wrapInvokable(string $method, bool $proxy, $methodTarget, string $handle, $fieldtype = null)
{
$fields = $this->blueprintFields();
$fieldtype = $this->adjustFieldtype($handle, $fieldtype);

return (new InvokableValue(
null,
$handle,
$fieldtype,
$this->data
))->setInvokableDetails($method, $proxy, $methodTarget);
}

protected function wrapValue($value, $handle, $fieldtype = null)
{
$fieldtype = $this->adjustFieldtype($handle, $fieldtype);

return new Value(
$value,
$handle,
optional($fields->get($handle))->fieldtype(),
$fieldtype,
$this->data
);
}

protected function getFieldtype($handle)
{
return optional($this->blueprintFields()->get($handle))->fieldtype();
}

protected function blueprintFields()
{
if (! isset($this->blueprintFields)) {
Expand Down
16 changes: 16 additions & 0 deletions src/Data/AugmentedCollection.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,22 @@ public function withoutEvaluation()
return $this;
}

public function all()
{
return collect($this->items)->map(function ($item) {
if ($item instanceof InvokableValue) {
return $item->materialize();
}

return $item;
})->all();
}

public function deferredAll()
{
return parent::all();
}

public function toArray()
{
return $this->map(function ($value) {
Expand Down
5 changes: 5 additions & 0 deletions src/Data/HasAugmentedInstance.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,11 @@ public function toAugmentedArray($keys = null)
return $this->toAugmentedCollection($keys)->all();
}

public function toDeferredAugmentedArray($keys = null)
{
return $this->toAugmentedCollection($keys)->deferredAll();
}

public function toShallowAugmentedCollection()
{
return $this->augmented()->select($this->shallowAugmentedArrayKeys())->withShallowNesting();
Expand Down
103 changes: 103 additions & 0 deletions src/Data/InvokableValue.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
<?php

namespace Statamic\Data;

use Statamic\Fields\Value;
use Statamic\View\Antlers\Language\Runtime\GlobalRuntimeState;

class InvokableValue extends Value
{
protected $methodTarget = null;
protected bool $hasResolved = false;
protected string $methodName;
protected bool $proxyThroughAugmented = false;
protected $resolvedValueInstance = null;

public function setInvokableDetails(string $method, bool $proxyCall, $target): self
{
$this->proxyThroughAugmented = $proxyCall;
$this->methodName = $method;
$this->methodTarget = $target;

return $this;
}

protected function resolve()
{
if ($this->hasResolved) {
return;
}

if ($this->methodTarget == null) {
$this->hasResolved = true;

return;
}

$curIsolationState = GlobalRuntimeState::$requiresRuntimeIsolation;

GlobalRuntimeState::$requiresRuntimeIsolation = true;
if ($this->proxyThroughAugmented && method_exists($this->methodTarget, 'getAugmentedMethodValue')) {
$this->raw = $this->methodTarget->getAugmentedMethodValue($this->methodName);

if (! $this->raw instanceof Value) {
// Replicate previous behavior of not having
// a field set if the method call did not
// return a Value instance.
$this->fieldtype = null;
} else {
// Store the original Value instance, if we have it.
$this->resolvedValueInstance = $this->raw;

// Shift some values around.
$this->fieldtype = $this->raw->fieldtype();
$this->raw = $this->raw->raw();
}
} elseif (! $this->proxyThroughAugmented) {
$this->raw = $this->methodTarget->{$this->methodName}();
}

$this->methodTarget = null;

$this->hasResolved = true;

GlobalRuntimeState::$requiresRuntimeIsolation = $curIsolationState;
}

public function materialize()
{
$this->resolve();

if ($this->resolvedValueInstance != null) {
return $this->resolvedValueInstance;
}

return $this->toValue();
}

protected function toValue()
{
return new Value($this->raw, $this->handle, $this->fieldtype, $this->augmentable, $this->shallow);
}

public function raw()
{
$this->resolve();

return parent::raw();
}

public function value()
{
$this->resolve();

return parent::value();
}

public function shallow()
{
$this->resolve();

return parent::shallow();
}
}
5 changes: 5 additions & 0 deletions src/Fields/Value.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,11 @@ public function raw()
return $this->raw;
}

public function materialize()
{
return $this;
}

public function value()
{
if (! $this->fieldtype) {
Expand Down
6 changes: 3 additions & 3 deletions src/Modifiers/CoreModifiers.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -767,7 +767,7 @@ public function get($value, $params)

// Convert the item to an array, since we'll want access to all the
// available data. Then grab the requested variable from there.
$array = $item instanceof Augmentable ? $item->toAugmentedArray() : $item->toArray();
$array = $item instanceof Augmentable ? $item->toDeferredAugmentedArray() : $item->toArray();

if ($arrayValue = Arr::get($array, $var)) {
return $arrayValue;
Expand DownExpand Up@@ -838,7 +838,7 @@ private function getGroupByValueFromObject($item, $groupBy)
{
// Make the array just from the params, so it only augments the values that might be needed.
$keys = explode(':', $groupBy);
$context = $item->toAugmentedArray($keys);
$context = $item->toDeferredAugmentedArray($keys);

return Antlers::parser()->getVariable($groupBy, $context);
}
Expand DownExpand Up@@ -2057,7 +2057,7 @@ public function scope($value, $params)
}

if ($value instanceof Collection) {
$value = $value->toAugmentedArray();
$value = $value->toDeferredAugmentedArray();
}

return Arr::addScope($value, $scope);
Expand Down
10 changes: 10 additions & 0 deletions src/Providers/CollectionsServiceProvider.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -163,6 +163,16 @@ protected function toAugmentedArray()
}, $this->items);
});

Collection::macro('toDeferredAugmentedArray', function ($keys = null) {
return array_map(function ($value) use ($keys) {
if ($value instanceof Augmentable) {
return $value->toDeferredAugmentedArray($keys);
}

return $value instanceof Arrayable ? $value->toArray() : $value;
}, $this->items);
});

Collection::macro('toAugmentedCollection', function ($keys = null) {
return array_map(function ($value) use ($keys) {
if ($value instanceof Augmentable) {
Expand Down
2 changes: 1 addition & 1 deletion src/Tags/Structure.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -123,7 +123,7 @@ public function toArray($tree, $parent = null, $depth = 1)
$pages = collect($tree)->map(function ($item, $index) use ($parent, $depth, $tree) {
$page = $item['page'];
$keys = $this->getQuerySelectKeys($page);
$data = $page->toAugmentedArray($keys);
$data = $page->toDeferredAugmentedArray($keys);
$children = empty($item['children']) ? [] : $this->toArray($item['children'], $data, $depth + 1);

$url = $page->urlWithoutRedirect();
Expand Down
4 changes: 2 additions & 2 deletions src/View/Antlers/Engine.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -161,11 +161,11 @@ public static function renderTag(Parser $parser, $name, $parameters = [], $conte
}

if ($output instanceof Collection) {
$output = $output->toAugmentedArray();
$output = $output->toDeferredAugmentedArray();
}

if ($output instanceof Augmentable) {
$output = $output->toAugmentedArray();
$output = $output->toDeferredAugmentedArray();
}

// Allow tags to return an array. We'll parse it for them.
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ public static function resolveWithRuntimeIsolation($augmentable)
{
GlobalRuntimeState::$requiresRuntimeIsolation = true;
try {
$value = $augmentable->toAugmentedArray();
$value = $augmentable->toDeferredAugmentedArray();
} catch (Exception $e) {
throw $e;
} finally {
Expand Down
4 changes: 2 additions & 2 deletions src/View/Cascade.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -148,7 +148,7 @@ protected function hydrateGlobals()
}

if ($mainGlobal = $this->get('global')) {
foreach ($mainGlobal->toAugmentedCollection() as $key => $value) {
foreach ($mainGlobal->toDeferredAugmentedArray() as $key => $value) {
$this->set($key, $value);
}
}
Expand All@@ -163,7 +163,7 @@ protected function hydrateContent()
}

$variables = $this->content instanceof Augmentable
? $this->content->toAugmentedArray()
? $this->content->toDeferredAugmentedArray()
: $this->content->toArray();

foreach ($variables as $key => $value) {
Expand Down
5 changes: 5 additions & 0 deletions tests/Antlers/Runtime/CoreModifiersTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -581,6 +581,11 @@ public function toAugmentedArray()
];
}

public function toDeferredAugmentedArray()
{
return $this->toAugmentedArray();
}

public function toArray()
{
return $this->toAugmentedArray();
Expand Down
2 changes: 1 addition & 1 deletion tests/Data/AugmentedTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -141,7 +141,7 @@ public function foo()
}
};

$this->assertSame($valueInstance, $augmented->get('foo'));
$this->assertSame($valueInstance, $augmented->get('foo')->materialize());
}

/** @test */
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
[5.x] Augmentation Adjustments by JohnathonKoster · Pull Request #9574 · statamic/cms · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/Auth/AugmentedUser.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,7 @@ private function commonKeys()
];
}

public function get($handle): Value
public function get($handle, $fieldtype = null): Value
{
if ($handle === 'is_user') {
return new Value(true, 'is_user', null, $this->data);
Expand All@@ -57,7 +57,7 @@ public function get($handle): Value
return new Value(in_array(Str::after($handle, 'in_'), $this->groups()), $handle, null, $this->data);
}

return parent::get($handle);
return parent::get($handle, $fieldtype);
}

protected function roles()
Expand Down
61 changes: 49 additions & 12 deletions src/Data/AbstractAugmented.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ abstract class AbstractAugmented implements Augmented
protected $data;
protected $blueprintFields;
protected $relations = [];
protected $isSelecting = false;

public function __construct($data)
{
Expand All@@ -34,33 +35,52 @@ public function select($keys = null)
$arr = [];

$keys = $this->filterKeys(Arr::wrap($keys ?: $this->keys()));
$fields = $this->blueprintFields();

$this->isSelecting = true;

foreach ($keys as $key) {
$arr[$key] = $this->get($key);
$arr[$key] = $this->get($key, optional($fields->get($key))->fieldtype());
}

$this->isSelecting = false;

return (new AugmentedCollection($arr))->withRelations($this->relations);
}

abstract public function keys();

public function get($handle): Value
public function getAugmentedMethodValue($method)
{
if ($this->methodExistsOnThisClass($method)) {
return $this->$method();
}

return $this->data->$method();
}

protected function adjustFieldtype($handle, $fieldtype)
{
if ($this->isSelecting || $fieldtype !== null) {
return $fieldtype;
}

return $this->getFieldtype($handle);
}

public function get($handle, $fieldtype = null): Value
{
$method = Str::camel($handle);

if ($this->methodExistsOnThisClass($method)) {
$value = $this->$method();

return $value instanceof Value
? $value
: new Value($value, $method, null, $this->data);
return $this->wrapInvokable($method, true, $this, $handle, $fieldtype);
}

if (method_exists($this->data, $method) && collect($this->keys())->contains(Str::snake($handle))) {
return $this->wrapValue($this->data->$method(), $handle);
return $this->wrapInvokable($method, false, $this->data, $handle, $fieldtype);
}

return $this->wrapValue($this->getFromData($handle), $handle);
return $this->wrapValue($this->getFromData($handle), $handle, $fieldtype);
}

protected function filterKeys($keys)
Expand DownExpand Up@@ -93,18 +113,35 @@ protected function getFromData($handle)
return $value;
}

protected function wrapValue($value, $handle)
protected function wrapInvokable(string $method, bool $proxy, $methodTarget, string $handle, $fieldtype = null)
{
$fields = $this->blueprintFields();
$fieldtype = $this->adjustFieldtype($handle, $fieldtype);

return (new InvokableValue(
null,
$handle,
$fieldtype,
$this->data
))->setInvokableDetails($method, $proxy, $methodTarget);
}

protected function wrapValue($value, $handle, $fieldtype = null)
{
$fieldtype = $this->adjustFieldtype($handle, $fieldtype);

return new Value(
$value,
$handle,
optional($fields->get($handle))->fieldtype(),
$fieldtype,
$this->data
);
}

protected function getFieldtype($handle)
{
return optional($this->blueprintFields()->get($handle))->fieldtype();
}

protected function blueprintFields()
{
if (! isset($this->blueprintFields)) {
Expand Down
16 changes: 16 additions & 0 deletions src/Data/AugmentedCollection.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,22 @@ public function withoutEvaluation()
return $this;
}

public function all()
{
return collect($this->items)->map(function ($item) {
if ($item instanceof InvokableValue) {
return $item->materialize();
}

return $item;
})->all();
}

public function deferredAll()
{
return parent::all();
}

public function toArray()
{
return $this->map(function ($value) {
Expand Down
5 changes: 5 additions & 0 deletions src/Data/HasAugmentedInstance.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,11 @@ public function toAugmentedArray($keys = null)
return $this->toAugmentedCollection($keys)->all();
}

public function toDeferredAugmentedArray($keys = null)
{
return $this->toAugmentedCollection($keys)->deferredAll();
}

public function toShallowAugmentedCollection()
{
return $this->augmented()->select($this->shallowAugmentedArrayKeys())->withShallowNesting();
Expand Down
103 changes: 103 additions & 0 deletions src/Data/InvokableValue.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
<?php

namespace Statamic\Data;

use Statamic\Fields\Value;
use Statamic\View\Antlers\Language\Runtime\GlobalRuntimeState;

class InvokableValue extends Value
{
protected $methodTarget = null;
protected bool $hasResolved = false;
protected string $methodName;
protected bool $proxyThroughAugmented = false;
protected $resolvedValueInstance = null;

public function setInvokableDetails(string $method, bool $proxyCall, $target): self
{
$this->proxyThroughAugmented = $proxyCall;
$this->methodName = $method;
$this->methodTarget = $target;

return $this;
}

protected function resolve()
{
if ($this->hasResolved) {
return;
}

if ($this->methodTarget == null) {
$this->hasResolved = true;

return;
}

$curIsolationState = GlobalRuntimeState::$requiresRuntimeIsolation;

GlobalRuntimeState::$requiresRuntimeIsolation = true;
if ($this->proxyThroughAugmented && method_exists($this->methodTarget, 'getAugmentedMethodValue')) {
$this->raw = $this->methodTarget->getAugmentedMethodValue($this->methodName);

if (! $this->raw instanceof Value) {
// Replicate previous behavior of not having
// a field set if the method call did not
// return a Value instance.
$this->fieldtype = null;
} else {
// Store the original Value instance, if we have it.
$this->resolvedValueInstance = $this->raw;

// Shift some values around.
$this->fieldtype = $this->raw->fieldtype();
$this->raw = $this->raw->raw();
}
} elseif (! $this->proxyThroughAugmented) {
$this->raw = $this->methodTarget->{$this->methodName}();
}

$this->methodTarget = null;

$this->hasResolved = true;

GlobalRuntimeState::$requiresRuntimeIsolation = $curIsolationState;
}

public function materialize()
{
$this->resolve();

if ($this->resolvedValueInstance != null) {
return $this->resolvedValueInstance;
}

return $this->toValue();
}

protected function toValue()
{
return new Value($this->raw, $this->handle, $this->fieldtype, $this->augmentable, $this->shallow);
}

public function raw()
{
$this->resolve();

return parent::raw();
}

public function value()
{
$this->resolve();

return parent::value();
}

public function shallow()
{
$this->resolve();

return parent::shallow();
}
}
5 changes: 5 additions & 0 deletions src/Fields/Value.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,11 @@ public function raw()
return $this->raw;
}

public function materialize()
{
return $this;
}

public function value()
{
if (! $this->fieldtype) {
Expand Down
6 changes: 3 additions & 3 deletions src/Modifiers/CoreModifiers.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -767,7 +767,7 @@ public function get($value, $params)

// Convert the item to an array, since we'll want access to all the
// available data. Then grab the requested variable from there.
$array = $item instanceof Augmentable ? $item->toAugmentedArray() : $item->toArray();
$array = $item instanceof Augmentable ? $item->toDeferredAugmentedArray() : $item->toArray();

if ($arrayValue = Arr::get($array, $var)) {
return $arrayValue;
Expand DownExpand Up@@ -838,7 +838,7 @@ private function getGroupByValueFromObject($item, $groupBy)
{
// Make the array just from the params, so it only augments the values that might be needed.
$keys = explode(':', $groupBy);
$context = $item->toAugmentedArray($keys);
$context = $item->toDeferredAugmentedArray($keys);

return Antlers::parser()->getVariable($groupBy, $context);
}
Expand DownExpand Up@@ -2057,7 +2057,7 @@ public function scope($value, $params)
}

if ($value instanceof Collection) {
$value = $value->toAugmentedArray();
$value = $value->toDeferredAugmentedArray();
}

return Arr::addScope($value, $scope);
Expand Down
10 changes: 10 additions & 0 deletions src/Providers/CollectionsServiceProvider.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -163,6 +163,16 @@ protected function toAugmentedArray()
}, $this->items);
});

Collection::macro('toDeferredAugmentedArray', function ($keys = null) {
return array_map(function ($value) use ($keys) {
if ($value instanceof Augmentable) {
return $value->toDeferredAugmentedArray($keys);
}

return $value instanceof Arrayable ? $value->toArray() : $value;
}, $this->items);
});

Collection::macro('toAugmentedCollection', function ($keys = null) {
return array_map(function ($value) use ($keys) {
if ($value instanceof Augmentable) {
Expand Down
2 changes: 1 addition & 1 deletion src/Tags/Structure.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -123,7 +123,7 @@ public function toArray($tree, $parent = null, $depth = 1)
$pages = collect($tree)->map(function ($item, $index) use ($parent, $depth, $tree) {
$page = $item['page'];
$keys = $this->getQuerySelectKeys($page);
$data = $page->toAugmentedArray($keys);
$data = $page->toDeferredAugmentedArray($keys);
$children = empty($item['children']) ? [] : $this->toArray($item['children'], $data, $depth + 1);

$url = $page->urlWithoutRedirect();
Expand Down
4 changes: 2 additions & 2 deletions src/View/Antlers/Engine.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -161,11 +161,11 @@ public static function renderTag(Parser $parser, $name, $parameters = [], $conte
}

if ($output instanceof Collection) {
$output = $output->toAugmentedArray();
$output = $output->toDeferredAugmentedArray();
}

if ($output instanceof Augmentable) {
$output = $output->toAugmentedArray();
$output = $output->toDeferredAugmentedArray();
}

// Allow tags to return an array. We'll parse it for them.
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ public static function resolveWithRuntimeIsolation($augmentable)
{
GlobalRuntimeState::$requiresRuntimeIsolation = true;
try {
$value = $augmentable->toAugmentedArray();
$value = $augmentable->toDeferredAugmentedArray();
} catch (Exception $e) {
throw $e;
} finally {
Expand Down
4 changes: 2 additions & 2 deletions src/View/Cascade.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -148,7 +148,7 @@ protected function hydrateGlobals()
}

if ($mainGlobal = $this->get('global')) {
foreach ($mainGlobal->toAugmentedCollection() as $key => $value) {
foreach ($mainGlobal->toDeferredAugmentedArray() as $key => $value) {
$this->set($key, $value);
}
}
Expand All@@ -163,7 +163,7 @@ protected function hydrateContent()
}

$variables = $this->content instanceof Augmentable
? $this->content->toAugmentedArray()
? $this->content->toDeferredAugmentedArray()
: $this->content->toArray();

foreach ($variables as $key => $value) {
Expand Down
5 changes: 5 additions & 0 deletions tests/Antlers/Runtime/CoreModifiersTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -581,6 +581,11 @@ public function toAugmentedArray()
];
}

public function toDeferredAugmentedArray()
{
return $this->toAugmentedArray();
}

public function toArray()
{
return $this->toAugmentedArray();
Expand Down
2 changes: 1 addition & 1 deletion tests/Data/AugmentedTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -141,7 +141,7 @@ public function foo()
}
};

$this->assertSame($valueInstance, $augmented->get('foo'));
$this->assertSame($valueInstance, $augmented->get('foo')->materialize());
}

/** @test */
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' [5.x] Augmentation Adjustments by JohnathonKoster · Pull Request #9574 · statamic/cms · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/Auth/AugmentedUser.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,7 @@ private function commonKeys()
];
}

public function get($handle): Value
public function get($handle, $fieldtype = null): Value
{
if ($handle === 'is_user') {
return new Value(true, 'is_user', null, $this->data);
Expand All@@ -57,7 +57,7 @@ public function get($handle): Value
return new Value(in_array(Str::after($handle, 'in_'), $this->groups()), $handle, null, $this->data);
}

return parent::get($handle);
return parent::get($handle, $fieldtype);
}

protected function roles()
Expand Down
61 changes: 49 additions & 12 deletions src/Data/AbstractAugmented.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ abstract class AbstractAugmented implements Augmented
protected $data;
protected $blueprintFields;
protected $relations = [];
protected $isSelecting = false;

public function __construct($data)
{
Expand All@@ -34,33 +35,52 @@ public function select($keys = null)
$arr = [];

$keys = $this->filterKeys(Arr::wrap($keys ?: $this->keys()));
$fields = $this->blueprintFields();

$this->isSelecting = true;

foreach ($keys as $key) {
$arr[$key] = $this->get($key);
$arr[$key] = $this->get($key, optional($fields->get($key))->fieldtype());
}

$this->isSelecting = false;

return (new AugmentedCollection($arr))->withRelations($this->relations);
}

abstract public function keys();

public function get($handle): Value
public function getAugmentedMethodValue($method)
{
if ($this->methodExistsOnThisClass($method)) {
return $this->$method();
}

return $this->data->$method();
}

protected function adjustFieldtype($handle, $fieldtype)
{
if ($this->isSelecting || $fieldtype !== null) {
return $fieldtype;
}

return $this->getFieldtype($handle);
}

public function get($handle, $fieldtype = null): Value
{
$method = Str::camel($handle);

if ($this->methodExistsOnThisClass($method)) {
$value = $this->$method();

return $value instanceof Value
? $value
: new Value($value, $method, null, $this->data);
return $this->wrapInvokable($method, true, $this, $handle, $fieldtype);
}

if (method_exists($this->data, $method) && collect($this->keys())->contains(Str::snake($handle))) {
return $this->wrapValue($this->data->$method(), $handle);
return $this->wrapInvokable($method, false, $this->data, $handle, $fieldtype);
}

return $this->wrapValue($this->getFromData($handle), $handle);
return $this->wrapValue($this->getFromData($handle), $handle, $fieldtype);
}

protected function filterKeys($keys)
Expand DownExpand Up@@ -93,18 +113,35 @@ protected function getFromData($handle)
return $value;
}

protected function wrapValue($value, $handle)
protected function wrapInvokable(string $method, bool $proxy, $methodTarget, string $handle, $fieldtype = null)
{
$fields = $this->blueprintFields();
$fieldtype = $this->adjustFieldtype($handle, $fieldtype);

return (new InvokableValue(
null,
$handle,
$fieldtype,
$this->data
))->setInvokableDetails($method, $proxy, $methodTarget);
}

protected function wrapValue($value, $handle, $fieldtype = null)
{
$fieldtype = $this->adjustFieldtype($handle, $fieldtype);

return new Value(
$value,
$handle,
optional($fields->get($handle))->fieldtype(),
$fieldtype,
$this->data
);
}

protected function getFieldtype($handle)
{
return optional($this->blueprintFields()->get($handle))->fieldtype();
}

protected function blueprintFields()
{
if (! isset($this->blueprintFields)) {
Expand Down
16 changes: 16 additions & 0 deletions src/Data/AugmentedCollection.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,22 @@ public function withoutEvaluation()
return $this;
}

public function all()
{
return collect($this->items)->map(function ($item) {
if ($item instanceof InvokableValue) {
return $item->materialize();
}

return $item;
})->all();
}

public function deferredAll()
{
return parent::all();
}

public function toArray()
{
return $this->map(function ($value) {
Expand Down
5 changes: 5 additions & 0 deletions src/Data/HasAugmentedInstance.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,11 @@ public function toAugmentedArray($keys = null)
return $this->toAugmentedCollection($keys)->all();
}

public function toDeferredAugmentedArray($keys = null)
{
return $this->toAugmentedCollection($keys)->deferredAll();
}

public function toShallowAugmentedCollection()
{
return $this->augmented()->select($this->shallowAugmentedArrayKeys())->withShallowNesting();
Expand Down
103 changes: 103 additions & 0 deletions src/Data/InvokableValue.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
<?php

namespace Statamic\Data;

use Statamic\Fields\Value;
use Statamic\View\Antlers\Language\Runtime\GlobalRuntimeState;

class InvokableValue extends Value
{
protected $methodTarget = null;
protected bool $hasResolved = false;
protected string $methodName;
protected bool $proxyThroughAugmented = false;
protected $resolvedValueInstance = null;

public function setInvokableDetails(string $method, bool $proxyCall, $target): self
{
$this->proxyThroughAugmented = $proxyCall;
$this->methodName = $method;
$this->methodTarget = $target;

return $this;
}

protected function resolve()
{
if ($this->hasResolved) {
return;
}

if ($this->methodTarget == null) {
$this->hasResolved = true;

return;
}

$curIsolationState = GlobalRuntimeState::$requiresRuntimeIsolation;

GlobalRuntimeState::$requiresRuntimeIsolation = true;
if ($this->proxyThroughAugmented && method_exists($this->methodTarget, 'getAugmentedMethodValue')) {
$this->raw = $this->methodTarget->getAugmentedMethodValue($this->methodName);

if (! $this->raw instanceof Value) {
// Replicate previous behavior of not having
// a field set if the method call did not
// return a Value instance.
$this->fieldtype = null;
} else {
// Store the original Value instance, if we have it.
$this->resolvedValueInstance = $this->raw;

// Shift some values around.
$this->fieldtype = $this->raw->fieldtype();
$this->raw = $this->raw->raw();
}
} elseif (! $this->proxyThroughAugmented) {
$this->raw = $this->methodTarget->{$this->methodName}();
}

$this->methodTarget = null;

$this->hasResolved = true;

GlobalRuntimeState::$requiresRuntimeIsolation = $curIsolationState;
}

public function materialize()
{
$this->resolve();

if ($this->resolvedValueInstance != null) {
return $this->resolvedValueInstance;
}

return $this->toValue();
}

protected function toValue()
{
return new Value($this->raw, $this->handle, $this->fieldtype, $this->augmentable, $this->shallow);
}

public function raw()
{
$this->resolve();

return parent::raw();
}

public function value()
{
$this->resolve();

return parent::value();
}

public function shallow()
{
$this->resolve();

return parent::shallow();
}
}
5 changes: 5 additions & 0 deletions src/Fields/Value.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,11 @@ public function raw()
return $this->raw;
}

public function materialize()
{
return $this;
}

public function value()
{
if (! $this->fieldtype) {
Expand Down
6 changes: 3 additions & 3 deletions src/Modifiers/CoreModifiers.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -767,7 +767,7 @@ public function get($value, $params)

// Convert the item to an array, since we'll want access to all the
// available data. Then grab the requested variable from there.
$array = $item instanceof Augmentable ? $item->toAugmentedArray() : $item->toArray();
$array = $item instanceof Augmentable ? $item->toDeferredAugmentedArray() : $item->toArray();

if ($arrayValue = Arr::get($array, $var)) {
return $arrayValue;
Expand DownExpand Up@@ -838,7 +838,7 @@ private function getGroupByValueFromObject($item, $groupBy)
{
// Make the array just from the params, so it only augments the values that might be needed.
$keys = explode(':', $groupBy);
$context = $item->toAugmentedArray($keys);
$context = $item->toDeferredAugmentedArray($keys);

return Antlers::parser()->getVariable($groupBy, $context);
}
Expand DownExpand Up@@ -2057,7 +2057,7 @@ public function scope($value, $params)
}

if ($value instanceof Collection) {
$value = $value->toAugmentedArray();
$value = $value->toDeferredAugmentedArray();
}

return Arr::addScope($value, $scope);
Expand Down
10 changes: 10 additions & 0 deletions src/Providers/CollectionsServiceProvider.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -163,6 +163,16 @@ protected function toAugmentedArray()
}, $this->items);
});

Collection::macro('toDeferredAugmentedArray', function ($keys = null) {
return array_map(function ($value) use ($keys) {
if ($value instanceof Augmentable) {
return $value->toDeferredAugmentedArray($keys);
}

return $value instanceof Arrayable ? $value->toArray() : $value;
}, $this->items);
});

Collection::macro('toAugmentedCollection', function ($keys = null) {
return array_map(function ($value) use ($keys) {
if ($value instanceof Augmentable) {
Expand Down
2 changes: 1 addition & 1 deletion src/Tags/Structure.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -123,7 +123,7 @@ public function toArray($tree, $parent = null, $depth = 1)
$pages = collect($tree)->map(function ($item, $index) use ($parent, $depth, $tree) {
$page = $item['page'];
$keys = $this->getQuerySelectKeys($page);
$data = $page->toAugmentedArray($keys);
$data = $page->toDeferredAugmentedArray($keys);
$children = empty($item['children']) ? [] : $this->toArray($item['children'], $data, $depth + 1);

$url = $page->urlWithoutRedirect();
Expand Down
4 changes: 2 additions & 2 deletions src/View/Antlers/Engine.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -161,11 +161,11 @@ public static function renderTag(Parser $parser, $name, $parameters = [], $conte
}

if ($output instanceof Collection) {
$output = $output->toAugmentedArray();
$output = $output->toDeferredAugmentedArray();
}

if ($output instanceof Augmentable) {
$output = $output->toAugmentedArray();
$output = $output->toDeferredAugmentedArray();
}

// Allow tags to return an array. We'll parse it for them.
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ public static function resolveWithRuntimeIsolation($augmentable)
{
GlobalRuntimeState::$requiresRuntimeIsolation = true;
try {
$value = $augmentable->toAugmentedArray();
$value = $augmentable->toDeferredAugmentedArray();
} catch (Exception $e) {
throw $e;
} finally {
Expand Down
4 changes: 2 additions & 2 deletions src/View/Cascade.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -148,7 +148,7 @@ protected function hydrateGlobals()
}

if ($mainGlobal = $this->get('global')) {
foreach ($mainGlobal->toAugmentedCollection() as $key => $value) {
foreach ($mainGlobal->toDeferredAugmentedArray() as $key => $value) {
$this->set($key, $value);
}
}
Expand All@@ -163,7 +163,7 @@ protected function hydrateContent()
}

$variables = $this->content instanceof Augmentable
? $this->content->toAugmentedArray()
? $this->content->toDeferredAugmentedArray()
: $this->content->toArray();

foreach ($variables as $key => $value) {
Expand Down
5 changes: 5 additions & 0 deletions tests/Antlers/Runtime/CoreModifiersTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -581,6 +581,11 @@ public function toAugmentedArray()
];
}

public function toDeferredAugmentedArray()
{
return $this->toAugmentedArray();
}

public function toArray()
{
return $this->toAugmentedArray();
Expand Down
2 changes: 1 addition & 1 deletion tests/Data/AugmentedTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -141,7 +141,7 @@ public function foo()
}
};

$this->assertSame($valueInstance, $augmented->get('foo'));
$this->assertSame($valueInstance, $augmented->get('foo')->materialize());
}

/** @test */
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' [5.x] Augmentation Adjustments by JohnathonKoster · Pull Request #9574 · statamic/cms · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/Auth/AugmentedUser.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,7 @@ private function commonKeys()
];
}

public function get($handle): Value
public function get($handle, $fieldtype = null): Value
{
if ($handle === 'is_user') {
return new Value(true, 'is_user', null, $this->data);
Expand All@@ -57,7 +57,7 @@ public function get($handle): Value
return new Value(in_array(Str::after($handle, 'in_'), $this->groups()), $handle, null, $this->data);
}

return parent::get($handle);
return parent::get($handle, $fieldtype);
}

protected function roles()
Expand Down
61 changes: 49 additions & 12 deletions src/Data/AbstractAugmented.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ abstract class AbstractAugmented implements Augmented
protected $data;
protected $blueprintFields;
protected $relations = [];
protected $isSelecting = false;

public function __construct($data)
{
Expand All@@ -34,33 +35,52 @@ public function select($keys = null)
$arr = [];

$keys = $this->filterKeys(Arr::wrap($keys ?: $this->keys()));
$fields = $this->blueprintFields();

$this->isSelecting = true;

foreach ($keys as $key) {
$arr[$key] = $this->get($key);
$arr[$key] = $this->get($key, optional($fields->get($key))->fieldtype());
}

$this->isSelecting = false;

return (new AugmentedCollection($arr))->withRelations($this->relations);
}

abstract public function keys();

public function get($handle): Value
public function getAugmentedMethodValue($method)
{
if ($this->methodExistsOnThisClass($method)) {
return $this->$method();
}

return $this->data->$method();
}

protected function adjustFieldtype($handle, $fieldtype)
{
if ($this->isSelecting || $fieldtype !== null) {
return $fieldtype;
}

return $this->getFieldtype($handle);
}

public function get($handle, $fieldtype = null): Value
{
$method = Str::camel($handle);

if ($this->methodExistsOnThisClass($method)) {
$value = $this->$method();

return $value instanceof Value
? $value
: new Value($value, $method, null, $this->data);
return $this->wrapInvokable($method, true, $this, $handle, $fieldtype);
}

if (method_exists($this->data, $method) && collect($this->keys())->contains(Str::snake($handle))) {
return $this->wrapValue($this->data->$method(), $handle);
return $this->wrapInvokable($method, false, $this->data, $handle, $fieldtype);
}

return $this->wrapValue($this->getFromData($handle), $handle);
return $this->wrapValue($this->getFromData($handle), $handle, $fieldtype);
}

protected function filterKeys($keys)
Expand DownExpand Up@@ -93,18 +113,35 @@ protected function getFromData($handle)
return $value;
}

protected function wrapValue($value, $handle)
protected function wrapInvokable(string $method, bool $proxy, $methodTarget, string $handle, $fieldtype = null)
{
$fields = $this->blueprintFields();
$fieldtype = $this->adjustFieldtype($handle, $fieldtype);

return (new InvokableValue(
null,
$handle,
$fieldtype,
$this->data
))->setInvokableDetails($method, $proxy, $methodTarget);
}

protected function wrapValue($value, $handle, $fieldtype = null)
{
$fieldtype = $this->adjustFieldtype($handle, $fieldtype);

return new Value(
$value,
$handle,
optional($fields->get($handle))->fieldtype(),
$fieldtype,
$this->data
);
}

protected function getFieldtype($handle)
{
return optional($this->blueprintFields()->get($handle))->fieldtype();
}

protected function blueprintFields()
{
if (! isset($this->blueprintFields)) {
Expand Down
16 changes: 16 additions & 0 deletions src/Data/AugmentedCollection.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,22 @@ public function withoutEvaluation()
return $this;
}

public function all()
{
return collect($this->items)->map(function ($item) {
if ($item instanceof InvokableValue) {
return $item->materialize();
}

return $item;
})->all();
}

public function deferredAll()
{
return parent::all();
}

public function toArray()
{
return $this->map(function ($value) {
Expand Down
5 changes: 5 additions & 0 deletions src/Data/HasAugmentedInstance.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,11 @@ public function toAugmentedArray($keys = null)
return $this->toAugmentedCollection($keys)->all();
}

public function toDeferredAugmentedArray($keys = null)
{
return $this->toAugmentedCollection($keys)->deferredAll();
}

public function toShallowAugmentedCollection()
{
return $this->augmented()->select($this->shallowAugmentedArrayKeys())->withShallowNesting();
Expand Down
103 changes: 103 additions & 0 deletions src/Data/InvokableValue.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
<?php

namespace Statamic\Data;

use Statamic\Fields\Value;
use Statamic\View\Antlers\Language\Runtime\GlobalRuntimeState;

class InvokableValue extends Value
{
protected $methodTarget = null;
protected bool $hasResolved = false;
protected string $methodName;
protected bool $proxyThroughAugmented = false;
protected $resolvedValueInstance = null;

public function setInvokableDetails(string $method, bool $proxyCall, $target): self
{
$this->proxyThroughAugmented = $proxyCall;
$this->methodName = $method;
$this->methodTarget = $target;

return $this;
}

protected function resolve()
{
if ($this->hasResolved) {
return;
}

if ($this->methodTarget == null) {
$this->hasResolved = true;

return;
}

$curIsolationState = GlobalRuntimeState::$requiresRuntimeIsolation;

GlobalRuntimeState::$requiresRuntimeIsolation = true;
if ($this->proxyThroughAugmented && method_exists($this->methodTarget, 'getAugmentedMethodValue')) {
$this->raw = $this->methodTarget->getAugmentedMethodValue($this->methodName);

if (! $this->raw instanceof Value) {
// Replicate previous behavior of not having
// a field set if the method call did not
// return a Value instance.
$this->fieldtype = null;
} else {
// Store the original Value instance, if we have it.
$this->resolvedValueInstance = $this->raw;

// Shift some values around.
$this->fieldtype = $this->raw->fieldtype();
$this->raw = $this->raw->raw();
}
} elseif (! $this->proxyThroughAugmented) {
$this->raw = $this->methodTarget->{$this->methodName}();
}

$this->methodTarget = null;

$this->hasResolved = true;

GlobalRuntimeState::$requiresRuntimeIsolation = $curIsolationState;
}

public function materialize()
{
$this->resolve();

if ($this->resolvedValueInstance != null) {
return $this->resolvedValueInstance;
}

return $this->toValue();
}

protected function toValue()
{
return new Value($this->raw, $this->handle, $this->fieldtype, $this->augmentable, $this->shallow);
}

public function raw()
{
$this->resolve();

return parent::raw();
}

public function value()
{
$this->resolve();

return parent::value();
}

public function shallow()
{
$this->resolve();

return parent::shallow();
}
}
5 changes: 5 additions & 0 deletions src/Fields/Value.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,11 @@ public function raw()
return $this->raw;
}

public function materialize()
{
return $this;
}

public function value()
{
if (! $this->fieldtype) {
Expand Down
6 changes: 3 additions & 3 deletions src/Modifiers/CoreModifiers.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -767,7 +767,7 @@ public function get($value, $params)

// Convert the item to an array, since we'll want access to all the
// available data. Then grab the requested variable from there.
$array = $item instanceof Augmentable ? $item->toAugmentedArray() : $item->toArray();
$array = $item instanceof Augmentable ? $item->toDeferredAugmentedArray() : $item->toArray();

if ($arrayValue = Arr::get($array, $var)) {
return $arrayValue;
Expand DownExpand Up@@ -838,7 +838,7 @@ private function getGroupByValueFromObject($item, $groupBy)
{
// Make the array just from the params, so it only augments the values that might be needed.
$keys = explode(':', $groupBy);
$context = $item->toAugmentedArray($keys);
$context = $item->toDeferredAugmentedArray($keys);

return Antlers::parser()->getVariable($groupBy, $context);
}
Expand DownExpand Up@@ -2057,7 +2057,7 @@ public function scope($value, $params)
}

if ($value instanceof Collection) {
$value = $value->toAugmentedArray();
$value = $value->toDeferredAugmentedArray();
}

return Arr::addScope($value, $scope);
Expand Down
10 changes: 10 additions & 0 deletions src/Providers/CollectionsServiceProvider.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -163,6 +163,16 @@ protected function toAugmentedArray()
}, $this->items);
});

Collection::macro('toDeferredAugmentedArray', function ($keys = null) {
return array_map(function ($value) use ($keys) {
if ($value instanceof Augmentable) {
return $value->toDeferredAugmentedArray($keys);
}

return $value instanceof Arrayable ? $value->toArray() : $value;
}, $this->items);
});

Collection::macro('toAugmentedCollection', function ($keys = null) {
return array_map(function ($value) use ($keys) {
if ($value instanceof Augmentable) {
Expand Down
2 changes: 1 addition & 1 deletion src/Tags/Structure.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -123,7 +123,7 @@ public function toArray($tree, $parent = null, $depth = 1)
$pages = collect($tree)->map(function ($item, $index) use ($parent, $depth, $tree) {
$page = $item['page'];
$keys = $this->getQuerySelectKeys($page);
$data = $page->toAugmentedArray($keys);
$data = $page->toDeferredAugmentedArray($keys);
$children = empty($item['children']) ? [] : $this->toArray($item['children'], $data, $depth + 1);

$url = $page->urlWithoutRedirect();
Expand Down
4 changes: 2 additions & 2 deletions src/View/Antlers/Engine.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -161,11 +161,11 @@ public static function renderTag(Parser $parser, $name, $parameters = [], $conte
}

if ($output instanceof Collection) {
$output = $output->toAugmentedArray();
$output = $output->toDeferredAugmentedArray();
}

if ($output instanceof Augmentable) {
$output = $output->toAugmentedArray();
$output = $output->toDeferredAugmentedArray();
}

// Allow tags to return an array. We'll parse it for them.
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ public static function resolveWithRuntimeIsolation($augmentable)
{
GlobalRuntimeState::$requiresRuntimeIsolation = true;
try {
$value = $augmentable->toAugmentedArray();
$value = $augmentable->toDeferredAugmentedArray();
} catch (Exception $e) {
throw $e;
} finally {
Expand Down
4 changes: 2 additions & 2 deletions src/View/Cascade.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -148,7 +148,7 @@ protected function hydrateGlobals()
}

if ($mainGlobal = $this->get('global')) {
foreach ($mainGlobal->toAugmentedCollection() as $key => $value) {
foreach ($mainGlobal->toDeferredAugmentedArray() as $key => $value) {
$this->set($key, $value);
}
}
Expand All@@ -163,7 +163,7 @@ protected function hydrateContent()
}

$variables = $this->content instanceof Augmentable
? $this->content->toAugmentedArray()
? $this->content->toDeferredAugmentedArray()
: $this->content->toArray();

foreach ($variables as $key => $value) {
Expand Down
5 changes: 5 additions & 0 deletions tests/Antlers/Runtime/CoreModifiersTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -581,6 +581,11 @@ public function toAugmentedArray()
];
}

public function toDeferredAugmentedArray()
{
return $this->toAugmentedArray();
}

public function toArray()
{
return $this->toAugmentedArray();
Expand Down
2 changes: 1 addition & 1 deletion tests/Data/AugmentedTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -141,7 +141,7 @@ public function foo()
}
};

$this->assertSame($valueInstance, $augmented->get('foo'));
$this->assertSame($valueInstance, $augmented->get('foo')->materialize());
}

/** @test */
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' [5.x] Augmentation Adjustments by JohnathonKoster · Pull Request #9574 · statamic/cms · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/Auth/AugmentedUser.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,7 @@ private function commonKeys()
];
}

public function get($handle): Value
public function get($handle, $fieldtype = null): Value
{
if ($handle === 'is_user') {
return new Value(true, 'is_user', null, $this->data);
Expand All@@ -57,7 +57,7 @@ public function get($handle): Value
return new Value(in_array(Str::after($handle, 'in_'), $this->groups()), $handle, null, $this->data);
}

return parent::get($handle);
return parent::get($handle, $fieldtype);
}

protected function roles()
Expand Down
61 changes: 49 additions & 12 deletions src/Data/AbstractAugmented.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ abstract class AbstractAugmented implements Augmented
protected $data;
protected $blueprintFields;
protected $relations = [];
protected $isSelecting = false;

public function __construct($data)
{
Expand All@@ -34,33 +35,52 @@ public function select($keys = null)
$arr = [];

$keys = $this->filterKeys(Arr::wrap($keys ?: $this->keys()));
$fields = $this->blueprintFields();

$this->isSelecting = true;

foreach ($keys as $key) {
$arr[$key] = $this->get($key);
$arr[$key] = $this->get($key, optional($fields->get($key))->fieldtype());
}

$this->isSelecting = false;

return (new AugmentedCollection($arr))->withRelations($this->relations);
}

abstract public function keys();

public function get($handle): Value
public function getAugmentedMethodValue($method)
{
if ($this->methodExistsOnThisClass($method)) {
return $this->$method();
}

return $this->data->$method();
}

protected function adjustFieldtype($handle, $fieldtype)
{
if ($this->isSelecting || $fieldtype !== null) {
return $fieldtype;
}

return $this->getFieldtype($handle);
}

public function get($handle, $fieldtype = null): Value
{
$method = Str::camel($handle);

if ($this->methodExistsOnThisClass($method)) {
$value = $this->$method();

return $value instanceof Value
? $value
: new Value($value, $method, null, $this->data);
return $this->wrapInvokable($method, true, $this, $handle, $fieldtype);
}

if (method_exists($this->data, $method) && collect($this->keys())->contains(Str::snake($handle))) {
return $this->wrapValue($this->data->$method(), $handle);
return $this->wrapInvokable($method, false, $this->data, $handle, $fieldtype);
}

return $this->wrapValue($this->getFromData($handle), $handle);
return $this->wrapValue($this->getFromData($handle), $handle, $fieldtype);
}

protected function filterKeys($keys)
Expand DownExpand Up@@ -93,18 +113,35 @@ protected function getFromData($handle)
return $value;
}

protected function wrapValue($value, $handle)
protected function wrapInvokable(string $method, bool $proxy, $methodTarget, string $handle, $fieldtype = null)
{
$fields = $this->blueprintFields();
$fieldtype = $this->adjustFieldtype($handle, $fieldtype);

return (new InvokableValue(
null,
$handle,
$fieldtype,
$this->data
))->setInvokableDetails($method, $proxy, $methodTarget);
}

protected function wrapValue($value, $handle, $fieldtype = null)
{
$fieldtype = $this->adjustFieldtype($handle, $fieldtype);

return new Value(
$value,
$handle,
optional($fields->get($handle))->fieldtype(),
$fieldtype,
$this->data
);
}

protected function getFieldtype($handle)
{
return optional($this->blueprintFields()->get($handle))->fieldtype();
}

protected function blueprintFields()
{
if (! isset($this->blueprintFields)) {
Expand Down
16 changes: 16 additions & 0 deletions src/Data/AugmentedCollection.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,22 @@ public function withoutEvaluation()
return $this;
}

public function all()
{
return collect($this->items)->map(function ($item) {
if ($item instanceof InvokableValue) {
return $item->materialize();
}

return $item;
})->all();
}

public function deferredAll()
{
return parent::all();
}

public function toArray()
{
return $this->map(function ($value) {
Expand Down
5 changes: 5 additions & 0 deletions src/Data/HasAugmentedInstance.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,11 @@ public function toAugmentedArray($keys = null)
return $this->toAugmentedCollection($keys)->all();
}

public function toDeferredAugmentedArray($keys = null)
{
return $this->toAugmentedCollection($keys)->deferredAll();
}

public function toShallowAugmentedCollection()
{
return $this->augmented()->select($this->shallowAugmentedArrayKeys())->withShallowNesting();
Expand Down
103 changes: 103 additions & 0 deletions src/Data/InvokableValue.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
<?php

namespace Statamic\Data;

use Statamic\Fields\Value;
use Statamic\View\Antlers\Language\Runtime\GlobalRuntimeState;

class InvokableValue extends Value
{
protected $methodTarget = null;
protected bool $hasResolved = false;
protected string $methodName;
protected bool $proxyThroughAugmented = false;
protected $resolvedValueInstance = null;

public function setInvokableDetails(string $method, bool $proxyCall, $target): self
{
$this->proxyThroughAugmented = $proxyCall;
$this->methodName = $method;
$this->methodTarget = $target;

return $this;
}

protected function resolve()
{
if ($this->hasResolved) {
return;
}

if ($this->methodTarget == null) {
$this->hasResolved = true;

return;
}

$curIsolationState = GlobalRuntimeState::$requiresRuntimeIsolation;

GlobalRuntimeState::$requiresRuntimeIsolation = true;
if ($this->proxyThroughAugmented && method_exists($this->methodTarget, 'getAugmentedMethodValue')) {
$this->raw = $this->methodTarget->getAugmentedMethodValue($this->methodName);

if (! $this->raw instanceof Value) {
// Replicate previous behavior of not having
// a field set if the method call did not
// return a Value instance.
$this->fieldtype = null;
} else {
// Store the original Value instance, if we have it.
$this->resolvedValueInstance = $this->raw;

// Shift some values around.
$this->fieldtype = $this->raw->fieldtype();
$this->raw = $this->raw->raw();
}
} elseif (! $this->proxyThroughAugmented) {
$this->raw = $this->methodTarget->{$this->methodName}();
}

$this->methodTarget = null;

$this->hasResolved = true;

GlobalRuntimeState::$requiresRuntimeIsolation = $curIsolationState;
}

public function materialize()
{
$this->resolve();

if ($this->resolvedValueInstance != null) {
return $this->resolvedValueInstance;
}

return $this->toValue();
}

protected function toValue()
{
return new Value($this->raw, $this->handle, $this->fieldtype, $this->augmentable, $this->shallow);
}

public function raw()
{
$this->resolve();

return parent::raw();
}

public function value()
{
$this->resolve();

return parent::value();
}

public function shallow()
{
$this->resolve();

return parent::shallow();
}
}
5 changes: 5 additions & 0 deletions src/Fields/Value.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,11 @@ public function raw()
return $this->raw;
}

public function materialize()
{
return $this;
}

public function value()
{
if (! $this->fieldtype) {
Expand Down
6 changes: 3 additions & 3 deletions src/Modifiers/CoreModifiers.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -767,7 +767,7 @@ public function get($value, $params)

// Convert the item to an array, since we'll want access to all the
// available data. Then grab the requested variable from there.
$array = $item instanceof Augmentable ? $item->toAugmentedArray() : $item->toArray();
$array = $item instanceof Augmentable ? $item->toDeferredAugmentedArray() : $item->toArray();

if ($arrayValue = Arr::get($array, $var)) {
return $arrayValue;
Expand DownExpand Up@@ -838,7 +838,7 @@ private function getGroupByValueFromObject($item, $groupBy)
{
// Make the array just from the params, so it only augments the values that might be needed.
$keys = explode(':', $groupBy);
$context = $item->toAugmentedArray($keys);
$context = $item->toDeferredAugmentedArray($keys);

return Antlers::parser()->getVariable($groupBy, $context);
}
Expand DownExpand Up@@ -2057,7 +2057,7 @@ public function scope($value, $params)
}

if ($value instanceof Collection) {
$value = $value->toAugmentedArray();
$value = $value->toDeferredAugmentedArray();
}

return Arr::addScope($value, $scope);
Expand Down
10 changes: 10 additions & 0 deletions src/Providers/CollectionsServiceProvider.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -163,6 +163,16 @@ protected function toAugmentedArray()
}, $this->items);
});

Collection::macro('toDeferredAugmentedArray', function ($keys = null) {
return array_map(function ($value) use ($keys) {
if ($value instanceof Augmentable) {
return $value->toDeferredAugmentedArray($keys);
}

return $value instanceof Arrayable ? $value->toArray() : $value;
}, $this->items);
});

Collection::macro('toAugmentedCollection', function ($keys = null) {
return array_map(function ($value) use ($keys) {
if ($value instanceof Augmentable) {
Expand Down
2 changes: 1 addition & 1 deletion src/Tags/Structure.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -123,7 +123,7 @@ public function toArray($tree, $parent = null, $depth = 1)
$pages = collect($tree)->map(function ($item, $index) use ($parent, $depth, $tree) {
$page = $item['page'];
$keys = $this->getQuerySelectKeys($page);
$data = $page->toAugmentedArray($keys);
$data = $page->toDeferredAugmentedArray($keys);
$children = empty($item['children']) ? [] : $this->toArray($item['children'], $data, $depth + 1);

$url = $page->urlWithoutRedirect();
Expand Down
4 changes: 2 additions & 2 deletions src/View/Antlers/Engine.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -161,11 +161,11 @@ public static function renderTag(Parser $parser, $name, $parameters = [], $conte
}

if ($output instanceof Collection) {
$output = $output->toAugmentedArray();
$output = $output->toDeferredAugmentedArray();
}

if ($output instanceof Augmentable) {
$output = $output->toAugmentedArray();
$output = $output->toDeferredAugmentedArray();
}

// Allow tags to return an array. We'll parse it for them.
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ public static function resolveWithRuntimeIsolation($augmentable)
{
GlobalRuntimeState::$requiresRuntimeIsolation = true;
try {
$value = $augmentable->toAugmentedArray();
$value = $augmentable->toDeferredAugmentedArray();
} catch (Exception $e) {
throw $e;
} finally {
Expand Down
4 changes: 2 additions & 2 deletions src/View/Cascade.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -148,7 +148,7 @@ protected function hydrateGlobals()
}

if ($mainGlobal = $this->get('global')) {
foreach ($mainGlobal->toAugmentedCollection() as $key => $value) {
foreach ($mainGlobal->toDeferredAugmentedArray() as $key => $value) {
$this->set($key, $value);
}
}
Expand All@@ -163,7 +163,7 @@ protected function hydrateContent()
}

$variables = $this->content instanceof Augmentable
? $this->content->toAugmentedArray()
? $this->content->toDeferredAugmentedArray()
: $this->content->toArray();

foreach ($variables as $key => $value) {
Expand Down
5 changes: 5 additions & 0 deletions tests/Antlers/Runtime/CoreModifiersTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -581,6 +581,11 @@ public function toAugmentedArray()
];
}

public function toDeferredAugmentedArray()
{
return $this->toAugmentedArray();
}

public function toArray()
{
return $this->toAugmentedArray();
Expand Down
2 changes: 1 addition & 1 deletion tests/Data/AugmentedTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -141,7 +141,7 @@ public function foo()
}
};

$this->assertSame($valueInstance, $augmented->get('foo'));
$this->assertSame($valueInstance, $augmented->get('foo')->materialize());
}

/** @test */
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' [5.x] Augmentation Adjustments by JohnathonKoster · Pull Request #9574 · statamic/cms · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/Auth/AugmentedUser.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,7 @@ private function commonKeys()
];
}

public function get($handle): Value
public function get($handle, $fieldtype = null): Value
{
if ($handle === 'is_user') {
return new Value(true, 'is_user', null, $this->data);
Expand All@@ -57,7 +57,7 @@ public function get($handle): Value
return new Value(in_array(Str::after($handle, 'in_'), $this->groups()), $handle, null, $this->data);
}

return parent::get($handle);
return parent::get($handle, $fieldtype);
}

protected function roles()
Expand Down
61 changes: 49 additions & 12 deletions src/Data/AbstractAugmented.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ abstract class AbstractAugmented implements Augmented
protected $data;
protected $blueprintFields;
protected $relations = [];
protected $isSelecting = false;

public function __construct($data)
{
Expand All@@ -34,33 +35,52 @@ public function select($keys = null)
$arr = [];

$keys = $this->filterKeys(Arr::wrap($keys ?: $this->keys()));
$fields = $this->blueprintFields();

$this->isSelecting = true;

foreach ($keys as $key) {
$arr[$key] = $this->get($key);
$arr[$key] = $this->get($key, optional($fields->get($key))->fieldtype());
}

$this->isSelecting = false;

return (new AugmentedCollection($arr))->withRelations($this->relations);
}

abstract public function keys();

public function get($handle): Value
public function getAugmentedMethodValue($method)
{
if ($this->methodExistsOnThisClass($method)) {
return $this->$method();
}

return $this->data->$method();
}

protected function adjustFieldtype($handle, $fieldtype)
{
if ($this->isSelecting || $fieldtype !== null) {
return $fieldtype;
}

return $this->getFieldtype($handle);
}

public function get($handle, $fieldtype = null): Value
{
$method = Str::camel($handle);

if ($this->methodExistsOnThisClass($method)) {
$value = $this->$method();

return $value instanceof Value
? $value
: new Value($value, $method, null, $this->data);
return $this->wrapInvokable($method, true, $this, $handle, $fieldtype);
}

if (method_exists($this->data, $method) && collect($this->keys())->contains(Str::snake($handle))) {
return $this->wrapValue($this->data->$method(), $handle);
return $this->wrapInvokable($method, false, $this->data, $handle, $fieldtype);
}

return $this->wrapValue($this->getFromData($handle), $handle);
return $this->wrapValue($this->getFromData($handle), $handle, $fieldtype);
}

protected function filterKeys($keys)
Expand DownExpand Up@@ -93,18 +113,35 @@ protected function getFromData($handle)
return $value;
}

protected function wrapValue($value, $handle)
protected function wrapInvokable(string $method, bool $proxy, $methodTarget, string $handle, $fieldtype = null)
{
$fields = $this->blueprintFields();
$fieldtype = $this->adjustFieldtype($handle, $fieldtype);

return (new InvokableValue(
null,
$handle,
$fieldtype,
$this->data
))->setInvokableDetails($method, $proxy, $methodTarget);
}

protected function wrapValue($value, $handle, $fieldtype = null)
{
$fieldtype = $this->adjustFieldtype($handle, $fieldtype);

return new Value(
$value,
$handle,
optional($fields->get($handle))->fieldtype(),
$fieldtype,
$this->data
);
}

protected function getFieldtype($handle)
{
return optional($this->blueprintFields()->get($handle))->fieldtype();
}

protected function blueprintFields()
{
if (! isset($this->blueprintFields)) {
Expand Down
16 changes: 16 additions & 0 deletions src/Data/AugmentedCollection.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,22 @@ public function withoutEvaluation()
return $this;
}

public function all()
{
return collect($this->items)->map(function ($item) {
if ($item instanceof InvokableValue) {
return $item->materialize();
}

return $item;
})->all();
}

public function deferredAll()
{
return parent::all();
}

public function toArray()
{
return $this->map(function ($value) {
Expand Down
5 changes: 5 additions & 0 deletions src/Data/HasAugmentedInstance.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,11 @@ public function toAugmentedArray($keys = null)
return $this->toAugmentedCollection($keys)->all();
}

public function toDeferredAugmentedArray($keys = null)
{
return $this->toAugmentedCollection($keys)->deferredAll();
}

public function toShallowAugmentedCollection()
{
return $this->augmented()->select($this->shallowAugmentedArrayKeys())->withShallowNesting();
Expand Down
103 changes: 103 additions & 0 deletions src/Data/InvokableValue.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
<?php

namespace Statamic\Data;

use Statamic\Fields\Value;
use Statamic\View\Antlers\Language\Runtime\GlobalRuntimeState;

class InvokableValue extends Value
{
protected $methodTarget = null;
protected bool $hasResolved = false;
protected string $methodName;
protected bool $proxyThroughAugmented = false;
protected $resolvedValueInstance = null;

public function setInvokableDetails(string $method, bool $proxyCall, $target): self
{
$this->proxyThroughAugmented = $proxyCall;
$this->methodName = $method;
$this->methodTarget = $target;

return $this;
}

protected function resolve()
{
if ($this->hasResolved) {
return;
}

if ($this->methodTarget == null) {
$this->hasResolved = true;

return;
}

$curIsolationState = GlobalRuntimeState::$requiresRuntimeIsolation;

GlobalRuntimeState::$requiresRuntimeIsolation = true;
if ($this->proxyThroughAugmented && method_exists($this->methodTarget, 'getAugmentedMethodValue')) {
$this->raw = $this->methodTarget->getAugmentedMethodValue($this->methodName);

if (! $this->raw instanceof Value) {
// Replicate previous behavior of not having
// a field set if the method call did not
// return a Value instance.
$this->fieldtype = null;
} else {
// Store the original Value instance, if we have it.
$this->resolvedValueInstance = $this->raw;

// Shift some values around.
$this->fieldtype = $this->raw->fieldtype();
$this->raw = $this->raw->raw();
}
} elseif (! $this->proxyThroughAugmented) {
$this->raw = $this->methodTarget->{$this->methodName}();
}

$this->methodTarget = null;

$this->hasResolved = true;

GlobalRuntimeState::$requiresRuntimeIsolation = $curIsolationState;
}

public function materialize()
{
$this->resolve();

if ($this->resolvedValueInstance != null) {
return $this->resolvedValueInstance;
}

return $this->toValue();
}

protected function toValue()
{
return new Value($this->raw, $this->handle, $this->fieldtype, $this->augmentable, $this->shallow);
}

public function raw()
{
$this->resolve();

return parent::raw();
}

public function value()
{
$this->resolve();

return parent::value();
}

public function shallow()
{
$this->resolve();

return parent::shallow();
}
}
5 changes: 5 additions & 0 deletions src/Fields/Value.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,11 @@ public function raw()
return $this->raw;
}

public function materialize()
{
return $this;
}

public function value()
{
if (! $this->fieldtype) {
Expand Down
6 changes: 3 additions & 3 deletions src/Modifiers/CoreModifiers.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -767,7 +767,7 @@ public function get($value, $params)

// Convert the item to an array, since we'll want access to all the
// available data. Then grab the requested variable from there.
$array = $item instanceof Augmentable ? $item->toAugmentedArray() : $item->toArray();
$array = $item instanceof Augmentable ? $item->toDeferredAugmentedArray() : $item->toArray();

if ($arrayValue = Arr::get($array, $var)) {
return $arrayValue;
Expand DownExpand Up@@ -838,7 +838,7 @@ private function getGroupByValueFromObject($item, $groupBy)
{
// Make the array just from the params, so it only augments the values that might be needed.
$keys = explode(':', $groupBy);
$context = $item->toAugmentedArray($keys);
$context = $item->toDeferredAugmentedArray($keys);

return Antlers::parser()->getVariable($groupBy, $context);
}
Expand DownExpand Up@@ -2057,7 +2057,7 @@ public function scope($value, $params)
}

if ($value instanceof Collection) {
$value = $value->toAugmentedArray();
$value = $value->toDeferredAugmentedArray();
}

return Arr::addScope($value, $scope);
Expand Down
10 changes: 10 additions & 0 deletions src/Providers/CollectionsServiceProvider.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -163,6 +163,16 @@ protected function toAugmentedArray()
}, $this->items);
});

Collection::macro('toDeferredAugmentedArray', function ($keys = null) {
return array_map(function ($value) use ($keys) {
if ($value instanceof Augmentable) {
return $value->toDeferredAugmentedArray($keys);
}

return $value instanceof Arrayable ? $value->toArray() : $value;
}, $this->items);
});

Collection::macro('toAugmentedCollection', function ($keys = null) {
return array_map(function ($value) use ($keys) {
if ($value instanceof Augmentable) {
Expand Down
2 changes: 1 addition & 1 deletion src/Tags/Structure.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -123,7 +123,7 @@ public function toArray($tree, $parent = null, $depth = 1)
$pages = collect($tree)->map(function ($item, $index) use ($parent, $depth, $tree) {
$page = $item['page'];
$keys = $this->getQuerySelectKeys($page);
$data = $page->toAugmentedArray($keys);
$data = $page->toDeferredAugmentedArray($keys);
$children = empty($item['children']) ? [] : $this->toArray($item['children'], $data, $depth + 1);

$url = $page->urlWithoutRedirect();
Expand Down
4 changes: 2 additions & 2 deletions src/View/Antlers/Engine.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -161,11 +161,11 @@ public static function renderTag(Parser $parser, $name, $parameters = [], $conte
}

if ($output instanceof Collection) {
$output = $output->toAugmentedArray();
$output = $output->toDeferredAugmentedArray();
}

if ($output instanceof Augmentable) {
$output = $output->toAugmentedArray();
$output = $output->toDeferredAugmentedArray();
}

// Allow tags to return an array. We'll parse it for them.
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ public static function resolveWithRuntimeIsolation($augmentable)
{
GlobalRuntimeState::$requiresRuntimeIsolation = true;
try {
$value = $augmentable->toAugmentedArray();
$value = $augmentable->toDeferredAugmentedArray();
} catch (Exception $e) {
throw $e;
} finally {
Expand Down
4 changes: 2 additions & 2 deletions src/View/Cascade.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -148,7 +148,7 @@ protected function hydrateGlobals()
}

if ($mainGlobal = $this->get('global')) {
foreach ($mainGlobal->toAugmentedCollection() as $key => $value) {
foreach ($mainGlobal->toDeferredAugmentedArray() as $key => $value) {
$this->set($key, $value);
}
}
Expand All@@ -163,7 +163,7 @@ protected function hydrateContent()
}

$variables = $this->content instanceof Augmentable
? $this->content->toAugmentedArray()
? $this->content->toDeferredAugmentedArray()
: $this->content->toArray();

foreach ($variables as $key => $value) {
Expand Down
5 changes: 5 additions & 0 deletions tests/Antlers/Runtime/CoreModifiersTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -581,6 +581,11 @@ public function toAugmentedArray()
];
}

public function toDeferredAugmentedArray()
{
return $this->toAugmentedArray();
}

public function toArray()
{
return $this->toAugmentedArray();
Expand Down
2 changes: 1 addition & 1 deletion tests/Data/AugmentedTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -141,7 +141,7 @@ public function foo()
}
};

$this->assertSame($valueInstance, $augmented->get('foo'));
$this->assertSame($valueInstance, $augmented->get('foo')->materialize());
}

/** @test */
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' [5.x] Augmentation Adjustments by JohnathonKoster · Pull Request #9574 · statamic/cms · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/Auth/AugmentedUser.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,7 @@ private function commonKeys()
];
}

public function get($handle): Value
public function get($handle, $fieldtype = null): Value
{
if ($handle === 'is_user') {
return new Value(true, 'is_user', null, $this->data);
Expand All@@ -57,7 +57,7 @@ public function get($handle): Value
return new Value(in_array(Str::after($handle, 'in_'), $this->groups()), $handle, null, $this->data);
}

return parent::get($handle);
return parent::get($handle, $fieldtype);
}

protected function roles()
Expand Down
61 changes: 49 additions & 12 deletions src/Data/AbstractAugmented.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ abstract class AbstractAugmented implements Augmented
protected $data;
protected $blueprintFields;
protected $relations = [];
protected $isSelecting = false;

public function __construct($data)
{
Expand All@@ -34,33 +35,52 @@ public function select($keys = null)
$arr = [];

$keys = $this->filterKeys(Arr::wrap($keys ?: $this->keys()));
$fields = $this->blueprintFields();

$this->isSelecting = true;

foreach ($keys as $key) {
$arr[$key] = $this->get($key);
$arr[$key] = $this->get($key, optional($fields->get($key))->fieldtype());
}

$this->isSelecting = false;

return (new AugmentedCollection($arr))->withRelations($this->relations);
}

abstract public function keys();

public function get($handle): Value
public function getAugmentedMethodValue($method)
{
if ($this->methodExistsOnThisClass($method)) {
return $this->$method();
}

return $this->data->$method();
}

protected function adjustFieldtype($handle, $fieldtype)
{
if ($this->isSelecting || $fieldtype !== null) {
return $fieldtype;
}

return $this->getFieldtype($handle);
}

public function get($handle, $fieldtype = null): Value
{
$method = Str::camel($handle);

if ($this->methodExistsOnThisClass($method)) {
$value = $this->$method();

return $value instanceof Value
? $value
: new Value($value, $method, null, $this->data);
return $this->wrapInvokable($method, true, $this, $handle, $fieldtype);
}

if (method_exists($this->data, $method) && collect($this->keys())->contains(Str::snake($handle))) {
return $this->wrapValue($this->data->$method(), $handle);
return $this->wrapInvokable($method, false, $this->data, $handle, $fieldtype);
}

return $this->wrapValue($this->getFromData($handle), $handle);
return $this->wrapValue($this->getFromData($handle), $handle, $fieldtype);
}

protected function filterKeys($keys)
Expand DownExpand Up@@ -93,18 +113,35 @@ protected function getFromData($handle)
return $value;
}

protected function wrapValue($value, $handle)
protected function wrapInvokable(string $method, bool $proxy, $methodTarget, string $handle, $fieldtype = null)
{
$fields = $this->blueprintFields();
$fieldtype = $this->adjustFieldtype($handle, $fieldtype);

return (new InvokableValue(
null,
$handle,
$fieldtype,
$this->data
))->setInvokableDetails($method, $proxy, $methodTarget);
}

protected function wrapValue($value, $handle, $fieldtype = null)
{
$fieldtype = $this->adjustFieldtype($handle, $fieldtype);

return new Value(
$value,
$handle,
optional($fields->get($handle))->fieldtype(),
$fieldtype,
$this->data
);
}

protected function getFieldtype($handle)
{
return optional($this->blueprintFields()->get($handle))->fieldtype();
}

protected function blueprintFields()
{
if (! isset($this->blueprintFields)) {
Expand Down
16 changes: 16 additions & 0 deletions src/Data/AugmentedCollection.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,22 @@ public function withoutEvaluation()
return $this;
}

public function all()
{
return collect($this->items)->map(function ($item) {
if ($item instanceof InvokableValue) {
return $item->materialize();
}

return $item;
})->all();
}

public function deferredAll()
{
return parent::all();
}

public function toArray()
{
return $this->map(function ($value) {
Expand Down
5 changes: 5 additions & 0 deletions src/Data/HasAugmentedInstance.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,11 @@ public function toAugmentedArray($keys = null)
return $this->toAugmentedCollection($keys)->all();
}

public function toDeferredAugmentedArray($keys = null)
{
return $this->toAugmentedCollection($keys)->deferredAll();
}

public function toShallowAugmentedCollection()
{
return $this->augmented()->select($this->shallowAugmentedArrayKeys())->withShallowNesting();
Expand Down
103 changes: 103 additions & 0 deletions src/Data/InvokableValue.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
<?php

namespace Statamic\Data;

use Statamic\Fields\Value;
use Statamic\View\Antlers\Language\Runtime\GlobalRuntimeState;

class InvokableValue extends Value
{
protected $methodTarget = null;
protected bool $hasResolved = false;
protected string $methodName;
protected bool $proxyThroughAugmented = false;
protected $resolvedValueInstance = null;

public function setInvokableDetails(string $method, bool $proxyCall, $target): self
{
$this->proxyThroughAugmented = $proxyCall;
$this->methodName = $method;
$this->methodTarget = $target;

return $this;
}

protected function resolve()
{
if ($this->hasResolved) {
return;
}

if ($this->methodTarget == null) {
$this->hasResolved = true;

return;
}

$curIsolationState = GlobalRuntimeState::$requiresRuntimeIsolation;

GlobalRuntimeState::$requiresRuntimeIsolation = true;
if ($this->proxyThroughAugmented && method_exists($this->methodTarget, 'getAugmentedMethodValue')) {
$this->raw = $this->methodTarget->getAugmentedMethodValue($this->methodName);

if (! $this->raw instanceof Value) {
// Replicate previous behavior of not having
// a field set if the method call did not
// return a Value instance.
$this->fieldtype = null;
} else {
// Store the original Value instance, if we have it.
$this->resolvedValueInstance = $this->raw;

// Shift some values around.
$this->fieldtype = $this->raw->fieldtype();
$this->raw = $this->raw->raw();
}
} elseif (! $this->proxyThroughAugmented) {
$this->raw = $this->methodTarget->{$this->methodName}();
}

$this->methodTarget = null;

$this->hasResolved = true;

GlobalRuntimeState::$requiresRuntimeIsolation = $curIsolationState;
}

public function materialize()
{
$this->resolve();

if ($this->resolvedValueInstance != null) {
return $this->resolvedValueInstance;
}

return $this->toValue();
}

protected function toValue()
{
return new Value($this->raw, $this->handle, $this->fieldtype, $this->augmentable, $this->shallow);
}

public function raw()
{
$this->resolve();

return parent::raw();
}

public function value()
{
$this->resolve();

return parent::value();
}

public function shallow()
{
$this->resolve();

return parent::shallow();
}
}
5 changes: 5 additions & 0 deletions src/Fields/Value.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,11 @@ public function raw()
return $this->raw;
}

public function materialize()
{
return $this;
}

public function value()
{
if (! $this->fieldtype) {
Expand Down
6 changes: 3 additions & 3 deletions src/Modifiers/CoreModifiers.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -767,7 +767,7 @@ public function get($value, $params)

// Convert the item to an array, since we'll want access to all the
// available data. Then grab the requested variable from there.
$array = $item instanceof Augmentable ? $item->toAugmentedArray() : $item->toArray();
$array = $item instanceof Augmentable ? $item->toDeferredAugmentedArray() : $item->toArray();

if ($arrayValue = Arr::get($array, $var)) {
return $arrayValue;
Expand DownExpand Up@@ -838,7 +838,7 @@ private function getGroupByValueFromObject($item, $groupBy)
{
// Make the array just from the params, so it only augments the values that might be needed.
$keys = explode(':', $groupBy);
$context = $item->toAugmentedArray($keys);
$context = $item->toDeferredAugmentedArray($keys);

return Antlers::parser()->getVariable($groupBy, $context);
}
Expand DownExpand Up@@ -2057,7 +2057,7 @@ public function scope($value, $params)
}

if ($value instanceof Collection) {
$value = $value->toAugmentedArray();
$value = $value->toDeferredAugmentedArray();
}

return Arr::addScope($value, $scope);
Expand Down
10 changes: 10 additions & 0 deletions src/Providers/CollectionsServiceProvider.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -163,6 +163,16 @@ protected function toAugmentedArray()
}, $this->items);
});

Collection::macro('toDeferredAugmentedArray', function ($keys = null) {
return array_map(function ($value) use ($keys) {
if ($value instanceof Augmentable) {
return $value->toDeferredAugmentedArray($keys);
}

return $value instanceof Arrayable ? $value->toArray() : $value;
}, $this->items);
});

Collection::macro('toAugmentedCollection', function ($keys = null) {
return array_map(function ($value) use ($keys) {
if ($value instanceof Augmentable) {
Expand Down
2 changes: 1 addition & 1 deletion src/Tags/Structure.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -123,7 +123,7 @@ public function toArray($tree, $parent = null, $depth = 1)
$pages = collect($tree)->map(function ($item, $index) use ($parent, $depth, $tree) {
$page = $item['page'];
$keys = $this->getQuerySelectKeys($page);
$data = $page->toAugmentedArray($keys);
$data = $page->toDeferredAugmentedArray($keys);
$children = empty($item['children']) ? [] : $this->toArray($item['children'], $data, $depth + 1);

$url = $page->urlWithoutRedirect();
Expand Down
4 changes: 2 additions & 2 deletions src/View/Antlers/Engine.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -161,11 +161,11 @@ public static function renderTag(Parser $parser, $name, $parameters = [], $conte
}

if ($output instanceof Collection) {
$output = $output->toAugmentedArray();
$output = $output->toDeferredAugmentedArray();
}

if ($output instanceof Augmentable) {
$output = $output->toAugmentedArray();
$output = $output->toDeferredAugmentedArray();
}

// Allow tags to return an array. We'll parse it for them.
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ public static function resolveWithRuntimeIsolation($augmentable)
{
GlobalRuntimeState::$requiresRuntimeIsolation = true;
try {
$value = $augmentable->toAugmentedArray();
$value = $augmentable->toDeferredAugmentedArray();
} catch (Exception $e) {
throw $e;
} finally {
Expand Down
4 changes: 2 additions & 2 deletions src/View/Cascade.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -148,7 +148,7 @@ protected function hydrateGlobals()
}

if ($mainGlobal = $this->get('global')) {
foreach ($mainGlobal->toAugmentedCollection() as $key => $value) {
foreach ($mainGlobal->toDeferredAugmentedArray() as $key => $value) {
$this->set($key, $value);
}
}
Expand All@@ -163,7 +163,7 @@ protected function hydrateContent()
}

$variables = $this->content instanceof Augmentable
? $this->content->toAugmentedArray()
? $this->content->toDeferredAugmentedArray()
: $this->content->toArray();

foreach ($variables as $key => $value) {
Expand Down
5 changes: 5 additions & 0 deletions tests/Antlers/Runtime/CoreModifiersTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -581,6 +581,11 @@ public function toAugmentedArray()
];
}

public function toDeferredAugmentedArray()
{
return $this->toAugmentedArray();
}

public function toArray()
{
return $this->toAugmentedArray();
Expand Down
2 changes: 1 addition & 1 deletion tests/Data/AugmentedTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -141,7 +141,7 @@ public function foo()
}
};

$this->assertSame($valueInstance, $augmented->get('foo'));
$this->assertSame($valueInstance, $augmented->get('foo')->materialize());
}

/** @test */
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); [5.x] Augmentation Adjustments by JohnathonKoster · Pull Request #9574 · statamic/cms · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/Auth/AugmentedUser.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,7 @@ private function commonKeys()
];
}

public function get($handle): Value
public function get($handle, $fieldtype = null): Value
{
if ($handle === 'is_user') {
return new Value(true, 'is_user', null, $this->data);
Expand All@@ -57,7 +57,7 @@ public function get($handle): Value
return new Value(in_array(Str::after($handle, 'in_'), $this->groups()), $handle, null, $this->data);
}

return parent::get($handle);
return parent::get($handle, $fieldtype);
}

protected function roles()
Expand Down
61 changes: 49 additions & 12 deletions src/Data/AbstractAugmented.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ abstract class AbstractAugmented implements Augmented
protected $data;
protected $blueprintFields;
protected $relations = [];
protected $isSelecting = false;

public function __construct($data)
{
Expand All@@ -34,33 +35,52 @@ public function select($keys = null)
$arr = [];

$keys = $this->filterKeys(Arr::wrap($keys ?: $this->keys()));
$fields = $this->blueprintFields();

$this->isSelecting = true;

foreach ($keys as $key) {
$arr[$key] = $this->get($key);
$arr[$key] = $this->get($key, optional($fields->get($key))->fieldtype());
}

$this->isSelecting = false;

return (new AugmentedCollection($arr))->withRelations($this->relations);
}

abstract public function keys();

public function get($handle): Value
public function getAugmentedMethodValue($method)
{
if ($this->methodExistsOnThisClass($method)) {
return $this->$method();
}

return $this->data->$method();
}

protected function adjustFieldtype($handle, $fieldtype)
{
if ($this->isSelecting || $fieldtype !== null) {
return $fieldtype;
}

return $this->getFieldtype($handle);
}

public function get($handle, $fieldtype = null): Value
{
$method = Str::camel($handle);

if ($this->methodExistsOnThisClass($method)) {
$value = $this->$method();

return $value instanceof Value
? $value
: new Value($value, $method, null, $this->data);
return $this->wrapInvokable($method, true, $this, $handle, $fieldtype);
}

if (method_exists($this->data, $method) && collect($this->keys())->contains(Str::snake($handle))) {
return $this->wrapValue($this->data->$method(), $handle);
return $this->wrapInvokable($method, false, $this->data, $handle, $fieldtype);
}

return $this->wrapValue($this->getFromData($handle), $handle);
return $this->wrapValue($this->getFromData($handle), $handle, $fieldtype);
}

protected function filterKeys($keys)
Expand DownExpand Up@@ -93,18 +113,35 @@ protected function getFromData($handle)
return $value;
}

protected function wrapValue($value, $handle)
protected function wrapInvokable(string $method, bool $proxy, $methodTarget, string $handle, $fieldtype = null)
{
$fields = $this->blueprintFields();
$fieldtype = $this->adjustFieldtype($handle, $fieldtype);

return (new InvokableValue(
null,
$handle,
$fieldtype,
$this->data
))->setInvokableDetails($method, $proxy, $methodTarget);
}

protected function wrapValue($value, $handle, $fieldtype = null)
{
$fieldtype = $this->adjustFieldtype($handle, $fieldtype);

return new Value(
$value,
$handle,
optional($fields->get($handle))->fieldtype(),
$fieldtype,
$this->data
);
}

protected function getFieldtype($handle)
{
return optional($this->blueprintFields()->get($handle))->fieldtype();
}

protected function blueprintFields()
{
if (! isset($this->blueprintFields)) {
Expand Down
16 changes: 16 additions & 0 deletions src/Data/AugmentedCollection.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,6 +47,22 @@ public function withoutEvaluation()
return $this;
}

public function all()
{
return collect($this->items)->map(function ($item) {
if ($item instanceof InvokableValue) {
return $item->materialize();
}

return $item;
})->all();
}

public function deferredAll()
{
return parent::all();
}

public function toArray()
{
return $this->map(function ($value) {
Expand Down
5 changes: 5 additions & 0 deletions src/Data/HasAugmentedInstance.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,11 @@ public function toAugmentedArray($keys = null)
return $this->toAugmentedCollection($keys)->all();
}

public function toDeferredAugmentedArray($keys = null)
{
return $this->toAugmentedCollection($keys)->deferredAll();
}

public function toShallowAugmentedCollection()
{
return $this->augmented()->select($this->shallowAugmentedArrayKeys())->withShallowNesting();
Expand Down
103 changes: 103 additions & 0 deletions src/Data/InvokableValue.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
<?php

namespace Statamic\Data;

use Statamic\Fields\Value;
use Statamic\View\Antlers\Language\Runtime\GlobalRuntimeState;

class InvokableValue extends Value
{
protected $methodTarget = null;
protected bool $hasResolved = false;
protected string $methodName;
protected bool $proxyThroughAugmented = false;
protected $resolvedValueInstance = null;

public function setInvokableDetails(string $method, bool $proxyCall, $target): self
{
$this->proxyThroughAugmented = $proxyCall;
$this->methodName = $method;
$this->methodTarget = $target;

return $this;
}

protected function resolve()
{
if ($this->hasResolved) {
return;
}

if ($this->methodTarget == null) {
$this->hasResolved = true;

return;
}

$curIsolationState = GlobalRuntimeState::$requiresRuntimeIsolation;

GlobalRuntimeState::$requiresRuntimeIsolation = true;
if ($this->proxyThroughAugmented && method_exists($this->methodTarget, 'getAugmentedMethodValue')) {
$this->raw = $this->methodTarget->getAugmentedMethodValue($this->methodName);

if (! $this->raw instanceof Value) {
// Replicate previous behavior of not having
// a field set if the method call did not
// return a Value instance.
$this->fieldtype = null;
} else {
// Store the original Value instance, if we have it.
$this->resolvedValueInstance = $this->raw;

// Shift some values around.
$this->fieldtype = $this->raw->fieldtype();
$this->raw = $this->raw->raw();
}
} elseif (! $this->proxyThroughAugmented) {
$this->raw = $this->methodTarget->{$this->methodName}();
}

$this->methodTarget = null;

$this->hasResolved = true;

GlobalRuntimeState::$requiresRuntimeIsolation = $curIsolationState;
}

public function materialize()
{
$this->resolve();

if ($this->resolvedValueInstance != null) {
return $this->resolvedValueInstance;
}

return $this->toValue();
}

protected function toValue()
{
return new Value($this->raw, $this->handle, $this->fieldtype, $this->augmentable, $this->shallow);
}

public function raw()
{
$this->resolve();

return parent::raw();
}

public function value()
{
$this->resolve();

return parent::value();
}

public function shallow()
{
$this->resolve();

return parent::shallow();
}
}
5 changes: 5 additions & 0 deletions src/Fields/Value.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,11 @@ public function raw()
return $this->raw;
}

public function materialize()
{
return $this;
}

public function value()
{
if (! $this->fieldtype) {
Expand Down
6 changes: 3 additions & 3 deletions src/Modifiers/CoreModifiers.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -767,7 +767,7 @@ public function get($value, $params)

// Convert the item to an array, since we'll want access to all the
// available data. Then grab the requested variable from there.
$array = $item instanceof Augmentable ? $item->toAugmentedArray() : $item->toArray();
$array = $item instanceof Augmentable ? $item->toDeferredAugmentedArray() : $item->toArray();

if ($arrayValue = Arr::get($array, $var)) {
return $arrayValue;
Expand DownExpand Up@@ -838,7 +838,7 @@ private function getGroupByValueFromObject($item, $groupBy)
{
// Make the array just from the params, so it only augments the values that might be needed.
$keys = explode(':', $groupBy);
$context = $item->toAugmentedArray($keys);
$context = $item->toDeferredAugmentedArray($keys);

return Antlers::parser()->getVariable($groupBy, $context);
}
Expand DownExpand Up@@ -2057,7 +2057,7 @@ public function scope($value, $params)
}

if ($value instanceof Collection) {
$value = $value->toAugmentedArray();
$value = $value->toDeferredAugmentedArray();
}

return Arr::addScope($value, $scope);
Expand Down
10 changes: 10 additions & 0 deletions src/Providers/CollectionsServiceProvider.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -163,6 +163,16 @@ protected function toAugmentedArray()
}, $this->items);
});

Collection::macro('toDeferredAugmentedArray', function ($keys = null) {
return array_map(function ($value) use ($keys) {
if ($value instanceof Augmentable) {
return $value->toDeferredAugmentedArray($keys);
}

return $value instanceof Arrayable ? $value->toArray() : $value;
}, $this->items);
});

Collection::macro('toAugmentedCollection', function ($keys = null) {
return array_map(function ($value) use ($keys) {
if ($value instanceof Augmentable) {
Expand Down
2 changes: 1 addition & 1 deletion src/Tags/Structure.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -123,7 +123,7 @@ public function toArray($tree, $parent = null, $depth = 1)
$pages = collect($tree)->map(function ($item, $index) use ($parent, $depth, $tree) {
$page = $item['page'];
$keys = $this->getQuerySelectKeys($page);
$data = $page->toAugmentedArray($keys);
$data = $page->toDeferredAugmentedArray($keys);
$children = empty($item['children']) ? [] : $this->toArray($item['children'], $data, $depth + 1);

$url = $page->urlWithoutRedirect();
Expand Down
4 changes: 2 additions & 2 deletions src/View/Antlers/Engine.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -161,11 +161,11 @@ public static function renderTag(Parser $parser, $name, $parameters = [], $conte
}

if ($output instanceof Collection) {
$output = $output->toAugmentedArray();
$output = $output->toDeferredAugmentedArray();
}

if ($output instanceof Augmentable) {
$output = $output->toAugmentedArray();
$output = $output->toDeferredAugmentedArray();
}

// Allow tags to return an array. We'll parse it for them.
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,7 @@ public static function resolveWithRuntimeIsolation($augmentable)
{
GlobalRuntimeState::$requiresRuntimeIsolation = true;
try {
$value = $augmentable->toAugmentedArray();
$value = $augmentable->toDeferredAugmentedArray();
} catch (Exception $e) {
throw $e;
} finally {
Expand Down
4 changes: 2 additions & 2 deletions src/View/Cascade.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -148,7 +148,7 @@ protected function hydrateGlobals()
}

if ($mainGlobal = $this->get('global')) {
foreach ($mainGlobal->toAugmentedCollection() as $key => $value) {
foreach ($mainGlobal->toDeferredAugmentedArray() as $key => $value) {
$this->set($key, $value);
}
}
Expand All@@ -163,7 +163,7 @@ protected function hydrateContent()
}

$variables = $this->content instanceof Augmentable
? $this->content->toAugmentedArray()
? $this->content->toDeferredAugmentedArray()
: $this->content->toArray();

foreach ($variables as $key => $value) {
Expand Down
5 changes: 5 additions & 0 deletions tests/Antlers/Runtime/CoreModifiersTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -581,6 +581,11 @@ public function toAugmentedArray()
];
}

public function toDeferredAugmentedArray()
{
return $this->toAugmentedArray();
}

public function toArray()
{
return $this->toAugmentedArray();
Expand Down
2 changes: 1 addition & 1 deletion tests/Data/AugmentedTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -141,7 +141,7 @@ public function foo()
}
};

$this->assertSame($valueInstance, $augmented->get('foo'));
$this->assertSame($valueInstance, $augmented->get('foo')->materialize());
}

/** @test */
Expand Down
Loading