feat: add ArrayHelper::dotKeyExists()#8131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kenjis merged 3 commits into from
Nov 6, 2023
Merged

feat: add ArrayHelper::dotKeyExists() #8131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3dedf9b
refactor: extract convertToArray()
kenjis Oct 31, 2023
3c4b238
feat: add ArrayHelper::dotKeyExists()
kenjis Oct 31, 2023
dce6576
docs: add PHPDoc
kenjis Oct 31, 2023
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
74 changes: 71 additions & 3 deletions system/Helpers/Array/ArrayHelper.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,8 @@

namespace CodeIgniter\Helpers\Array;

use InvalidArgumentException;

/**
* @interal This is internal implementation for the framework.
*
Expand All@@ -27,9 +29,21 @@ final class ArrayHelper
*
* @used-by dot_array_search()
*
* @param string $index The index as dot array syntax.
*
* @return array|bool|int|object|string|null
*/
public static function dotSearch(string $index, array $array)
{
return self::arraySearchDot(self::convertToArray($index), $array);
}

/**
* @param string $index The index as dot array syntax.
*
* @return list<string> The index as an array.
*/
private static function convertToArray(string $index): array
{
// See https://regex101.com/r/44Ipql/1
$segments = preg_split(
Expand All@@ -39,9 +53,10 @@ public static function dotSearch(string $index, array $array)
PREG_SPLIT_NO_EMPTY
);

$segments = array_map(static fn ($key) => str_replace('\.', '.', $key), $segments);

return self::arraySearchDot($segments, $array);
return array_map(
static fn ($key) => str_replace('\.', '.', $key),
$segments
);
}

/**
Expand DownExpand Up@@ -106,6 +121,59 @@ private static function arraySearchDot(array $indexes, array $array)
return null;
}

/**
* array_key_exists() with dot array syntax.
*
* If wildcard `*` is used, all items for the key after it must have the key.
*/
public static function dotKeyExists(string $index, array $array): bool
{
if (str_ends_with($index, '*') || str_contains($index, '*.*')) {
throw new InvalidArgumentException(
'You must set key right after "*". Invalid index: "' . $index . '"'
Comment thread
kenjis marked this conversation as resolved.
);
}

$indexes = self::convertToArray($index);

// If indexes is empty, returns false.
if ($indexes === []) {
return false;
}

$currentArray = $array;

// Grab the current index
while ($currentIndex = array_shift($indexes)) {
if ($currentIndex === '*') {
$currentIndex = array_shift($indexes);

foreach ($currentArray as $item) {
if (! array_key_exists($currentIndex, $item)) {
return false;
}
}

// If indexes is empty, all elements are checked.
if ($indexes === []) {
return true;
}

$currentArray = self::dotSearch('*.' . $currentIndex, $currentArray);

continue;
}

if (! array_key_exists($currentIndex, $currentArray)) {
return false;
}

$currentArray = $currentArray[$currentIndex];
}

return true;
}

/**
* Groups all rows by their index values. Result's depth equals number of indexes
*
Expand Down
72 changes: 72 additions & 0 deletions tests/system/Helpers/Array/ArrayHelperDotKeyExistsTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
<?php

/**
* This file is part of CodeIgniter 4 framework.
*
* (c) CodeIgniter Foundation <admin@codeigniter.com>
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/

namespace CodeIgniter\Helpers\Array;

use CodeIgniter\Test\CIUnitTestCase;
use InvalidArgumentException;

/**
* @group Others
*
* @internal
*/
final class ArrayHelperDotKeyExistsTest extends CIUnitTestCase
{
private array $array = [
'contacts' => [
'friends' => [
['name' => 'Fred Flinstone', 'age' => 20],
['age' => 21], // 'name' key does not exist
],
],
];

public function testDotKeyExists(): void
{
$this->assertFalse(ArrayHelper::dotKeyExists('', $this->array));
$this->assertTrue(ArrayHelper::dotKeyExists('contacts', $this->array));
$this->assertFalse(ArrayHelper::dotKeyExists('not', $this->array));
$this->assertTrue(ArrayHelper::dotKeyExists('contacts.friends', $this->array));
$this->assertFalse(ArrayHelper::dotKeyExists('not.friends', $this->array));
$this->assertTrue(ArrayHelper::dotKeyExists('contacts.friends.0.name', $this->array));
$this->assertFalse(ArrayHelper::dotKeyExists('contacts.friends.1.name', $this->array));
}

public function testDotKeyExistsWithEndingWildCard(): void
{
$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage('You must set key right after "*". Invalid index: "contacts.*"');

$this->assertTrue(ArrayHelper::dotKeyExists('contacts.*', $this->array));
}

public function testDotKeyExistsWithDoubleWildCard(): void
{
$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage('You must set key right after "*". Invalid index: "contacts.*.*.age"');

$this->assertTrue(ArrayHelper::dotKeyExists('contacts.*.*.age', $this->array));
}

public function testDotKeyExistsWithWildCard(): void
{
$this->assertTrue(ArrayHelper::dotKeyExists('*.friends', $this->array));
$this->assertTrue(ArrayHelper::dotKeyExists('contacts.friends.*.age', $this->array));
$this->assertFalse(ArrayHelper::dotKeyExists('contacts.friends.*.name', $this->array));
$this->assertTrue(ArrayHelper::dotKeyExists('*.friends.*.age', $this->array));
$this->assertFalse(ArrayHelper::dotKeyExists('*.friends.*.name', $this->array));
$this->assertTrue(ArrayHelper::dotKeyExists('contacts.*.0.age', $this->array));
$this->assertTrue(ArrayHelper::dotKeyExists('contacts.*.1.age', $this->array));
$this->assertTrue(ArrayHelper::dotKeyExists('contacts.*.0.name', $this->array));
$this->assertFalse(ArrayHelper::dotKeyExists('contacts.*.1.name', $this->array));
}
}
, '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" + '

Skip to content
feat: add ArrayHelper::dotKeyExists()#8131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 3 commits into

from

Nov 6, 2023
 Merged


feat: add ArrayHelper::dotKeyExists()
#8131
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
3dedf9b

refactor: extract convertToArray()


kenjis Oct 31, 2023
3c4b238

feat: add ArrayHelper::dotKeyExists()


kenjis Oct 31, 2023
dce6576

docs: add PHPDoc


kenjis Oct 31, 2023

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


74 changes: 71 additions & 3 deletions
system/Helpers/Array/ArrayHelper.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,8 @@

namespace CodeIgniter\Helpers\Array;

use InvalidArgumentException;

/**
 * @interal This is internal implementation for the framework.
 *
Expand All@@ -27,9 +29,21 @@ final class ArrayHelper
 *
 * @used-by dot_array_search()
 *
 * @param string $index The index as dot array syntax.
 *
 * @return array|bool|int|object|string|null
 */
 public static function dotSearch(string $index, array $array)
 {
 return self::arraySearchDot(self::convertToArray($index), $array);
 }

 /**
 * @param string $index The index as dot array syntax.
 *
 * @return list<string> The index as an array.
 */
 private static function convertToArray(string $index): array
 {
 // See https://regex101.com/r/44Ipql/1
 $segments = preg_split(
Expand All@@ -39,9 +53,10 @@ public static function dotSearch(string $index, array $array)
 PREG_SPLIT_NO_EMPTY
 );

 $segments = array_map(static fn ($key) => str_replace('\.', '.', $key), $segments);

 return self::arraySearchDot($segments, $array);
 return array_map(
 static fn ($key) => str_replace('\.', '.', $key),
 $segments
 );
 }

 /**
Expand DownExpand Up@@ -106,6 +121,59 @@ private static function arraySearchDot(array $indexes, array $array)
 return null;
 }

 /**
 * array_key_exists() with dot array syntax.
 *
 * If wildcard `*` is used, all items for the key after it must have the key.
 */
 public static function dotKeyExists(string $index, array $array): bool
 {
 if (str_ends_with($index, '*') || str_contains($index, '*.*')) {
 throw new InvalidArgumentException(
 'You must set key right after "*". Invalid index: "' . $index . '"'
Comment thread
kenjis marked this conversation as resolved.

 );
 }

 $indexes = self::convertToArray($index);

 // If indexes is empty, returns false.
 if ($indexes === []) {
 return false;
 }

 $currentArray = $array;

 // Grab the current index
 while ($currentIndex = array_shift($indexes)) {
 if ($currentIndex === '*') {
 $currentIndex = array_shift($indexes);

 foreach ($currentArray as $item) {
 if (! array_key_exists($currentIndex, $item)) {
 return false;
 }
 }

 // If indexes is empty, all elements are checked.
 if ($indexes === []) {
 return true;
 }

 $currentArray = self::dotSearch('*.' . $currentIndex, $currentArray);

 continue;
 }

 if (! array_key_exists($currentIndex, $currentArray)) {
 return false;
 }

 $currentArray = $currentArray[$currentIndex];
 }

 return true;
 }

 /**
 * Groups all rows by their index values. Result's depth equals number of indexes
 *
Expand Down

72 changes: 72 additions & 0 deletions
tests/system/Helpers/Array/ArrayHelperDotKeyExistsTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Helpers\Array;

use CodeIgniter\Test\CIUnitTestCase;
use InvalidArgumentException;

/**
 * @group Others
 *
 * @internal
 */
final class ArrayHelperDotKeyExistsTest extends CIUnitTestCase
{
 private array $array = [
 'contacts' => [
 'friends' => [
 ['name' => 'Fred Flinstone', 'age' => 20],
 ['age' => 21], // 'name' key does not exist
 ],
 ],
 ];

 public function testDotKeyExists(): void
 {
 $this->assertFalse(ArrayHelper::dotKeyExists('', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('not', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.friends', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('not.friends', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.friends.0.name', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('contacts.friends.1.name', $this->array));
 }

 public function testDotKeyExistsWithEndingWildCard(): void
 {
 $this->expectException(InvalidArgumentException::class);
 $this->expectExceptionMessage('You must set key right after "*". Invalid index: "contacts.*"');

 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.*', $this->array));
 }

 public function testDotKeyExistsWithDoubleWildCard(): void
 {
 $this->expectException(InvalidArgumentException::class);
 $this->expectExceptionMessage('You must set key right after "*". Invalid index: "contacts.*.*.age"');

 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.*.*.age', $this->array));
 }

 public function testDotKeyExistsWithWildCard(): void
 {
 $this->assertTrue(ArrayHelper::dotKeyExists('*.friends', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.friends.*.age', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('contacts.friends.*.name', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('*.friends.*.age', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('*.friends.*.name', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.*.0.age', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.*.1.age', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.*.0.name', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('contacts.*.1.name', $this->array));
 }
}

, '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('^' + ".*" + '

Skip to content
feat: add ArrayHelper::dotKeyExists()#8131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 3 commits into

from

Nov 6, 2023
 Merged


feat: add ArrayHelper::dotKeyExists()
#8131
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
3dedf9b

refactor: extract convertToArray()


kenjis Oct 31, 2023
3c4b238

feat: add ArrayHelper::dotKeyExists()


kenjis Oct 31, 2023
dce6576

docs: add PHPDoc


kenjis Oct 31, 2023

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


74 changes: 71 additions & 3 deletions
system/Helpers/Array/ArrayHelper.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,8 @@

namespace CodeIgniter\Helpers\Array;

use InvalidArgumentException;

/**
 * @interal This is internal implementation for the framework.
 *
Expand All@@ -27,9 +29,21 @@ final class ArrayHelper
 *
 * @used-by dot_array_search()
 *
 * @param string $index The index as dot array syntax.
 *
 * @return array|bool|int|object|string|null
 */
 public static function dotSearch(string $index, array $array)
 {
 return self::arraySearchDot(self::convertToArray($index), $array);
 }

 /**
 * @param string $index The index as dot array syntax.
 *
 * @return list<string> The index as an array.
 */
 private static function convertToArray(string $index): array
 {
 // See https://regex101.com/r/44Ipql/1
 $segments = preg_split(
Expand All@@ -39,9 +53,10 @@ public static function dotSearch(string $index, array $array)
 PREG_SPLIT_NO_EMPTY
 );

 $segments = array_map(static fn ($key) => str_replace('\.', '.', $key), $segments);

 return self::arraySearchDot($segments, $array);
 return array_map(
 static fn ($key) => str_replace('\.', '.', $key),
 $segments
 );
 }

 /**
Expand DownExpand Up@@ -106,6 +121,59 @@ private static function arraySearchDot(array $indexes, array $array)
 return null;
 }

 /**
 * array_key_exists() with dot array syntax.
 *
 * If wildcard `*` is used, all items for the key after it must have the key.
 */
 public static function dotKeyExists(string $index, array $array): bool
 {
 if (str_ends_with($index, '*') || str_contains($index, '*.*')) {
 throw new InvalidArgumentException(
 'You must set key right after "*". Invalid index: "' . $index . '"'
Comment thread
kenjis marked this conversation as resolved.

 );
 }

 $indexes = self::convertToArray($index);

 // If indexes is empty, returns false.
 if ($indexes === []) {
 return false;
 }

 $currentArray = $array;

 // Grab the current index
 while ($currentIndex = array_shift($indexes)) {
 if ($currentIndex === '*') {
 $currentIndex = array_shift($indexes);

 foreach ($currentArray as $item) {
 if (! array_key_exists($currentIndex, $item)) {
 return false;
 }
 }

 // If indexes is empty, all elements are checked.
 if ($indexes === []) {
 return true;
 }

 $currentArray = self::dotSearch('*.' . $currentIndex, $currentArray);

 continue;
 }

 if (! array_key_exists($currentIndex, $currentArray)) {
 return false;
 }

 $currentArray = $currentArray[$currentIndex];
 }

 return true;
 }

 /**
 * Groups all rows by their index values. Result's depth equals number of indexes
 *
Expand Down

72 changes: 72 additions & 0 deletions
tests/system/Helpers/Array/ArrayHelperDotKeyExistsTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Helpers\Array;

use CodeIgniter\Test\CIUnitTestCase;
use InvalidArgumentException;

/**
 * @group Others
 *
 * @internal
 */
final class ArrayHelperDotKeyExistsTest extends CIUnitTestCase
{
 private array $array = [
 'contacts' => [
 'friends' => [
 ['name' => 'Fred Flinstone', 'age' => 20],
 ['age' => 21], // 'name' key does not exist
 ],
 ],
 ];

 public function testDotKeyExists(): void
 {
 $this->assertFalse(ArrayHelper::dotKeyExists('', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('not', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.friends', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('not.friends', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.friends.0.name', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('contacts.friends.1.name', $this->array));
 }

 public function testDotKeyExistsWithEndingWildCard(): void
 {
 $this->expectException(InvalidArgumentException::class);
 $this->expectExceptionMessage('You must set key right after "*". Invalid index: "contacts.*"');

 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.*', $this->array));
 }

 public function testDotKeyExistsWithDoubleWildCard(): void
 {
 $this->expectException(InvalidArgumentException::class);
 $this->expectExceptionMessage('You must set key right after "*". Invalid index: "contacts.*.*.age"');

 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.*.*.age', $this->array));
 }

 public function testDotKeyExistsWithWildCard(): void
 {
 $this->assertTrue(ArrayHelper::dotKeyExists('*.friends', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.friends.*.age', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('contacts.friends.*.name', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('*.friends.*.age', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('*.friends.*.name', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.*.0.age', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.*.1.age', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.*.0.name', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('contacts.*.1.name', $this->array));
 }
}

, '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('^' + ".*" + '

Skip to content
feat: add ArrayHelper::dotKeyExists()#8131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 3 commits into

from

Nov 6, 2023
 Merged


feat: add ArrayHelper::dotKeyExists()
#8131
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
3dedf9b

refactor: extract convertToArray()


kenjis Oct 31, 2023
3c4b238

feat: add ArrayHelper::dotKeyExists()


kenjis Oct 31, 2023
dce6576

docs: add PHPDoc


kenjis Oct 31, 2023

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


74 changes: 71 additions & 3 deletions
system/Helpers/Array/ArrayHelper.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,8 @@

namespace CodeIgniter\Helpers\Array;

use InvalidArgumentException;

/**
 * @interal This is internal implementation for the framework.
 *
Expand All@@ -27,9 +29,21 @@ final class ArrayHelper
 *
 * @used-by dot_array_search()
 *
 * @param string $index The index as dot array syntax.
 *
 * @return array|bool|int|object|string|null
 */
 public static function dotSearch(string $index, array $array)
 {
 return self::arraySearchDot(self::convertToArray($index), $array);
 }

 /**
 * @param string $index The index as dot array syntax.
 *
 * @return list<string> The index as an array.
 */
 private static function convertToArray(string $index): array
 {
 // See https://regex101.com/r/44Ipql/1
 $segments = preg_split(
Expand All@@ -39,9 +53,10 @@ public static function dotSearch(string $index, array $array)
 PREG_SPLIT_NO_EMPTY
 );

 $segments = array_map(static fn ($key) => str_replace('\.', '.', $key), $segments);

 return self::arraySearchDot($segments, $array);
 return array_map(
 static fn ($key) => str_replace('\.', '.', $key),
 $segments
 );
 }

 /**
Expand DownExpand Up@@ -106,6 +121,59 @@ private static function arraySearchDot(array $indexes, array $array)
 return null;
 }

 /**
 * array_key_exists() with dot array syntax.
 *
 * If wildcard `*` is used, all items for the key after it must have the key.
 */
 public static function dotKeyExists(string $index, array $array): bool
 {
 if (str_ends_with($index, '*') || str_contains($index, '*.*')) {
 throw new InvalidArgumentException(
 'You must set key right after "*". Invalid index: "' . $index . '"'
Comment thread
kenjis marked this conversation as resolved.

 );
 }

 $indexes = self::convertToArray($index);

 // If indexes is empty, returns false.
 if ($indexes === []) {
 return false;
 }

 $currentArray = $array;

 // Grab the current index
 while ($currentIndex = array_shift($indexes)) {
 if ($currentIndex === '*') {
 $currentIndex = array_shift($indexes);

 foreach ($currentArray as $item) {
 if (! array_key_exists($currentIndex, $item)) {
 return false;
 }
 }

 // If indexes is empty, all elements are checked.
 if ($indexes === []) {
 return true;
 }

 $currentArray = self::dotSearch('*.' . $currentIndex, $currentArray);

 continue;
 }

 if (! array_key_exists($currentIndex, $currentArray)) {
 return false;
 }

 $currentArray = $currentArray[$currentIndex];
 }

 return true;
 }

 /**
 * Groups all rows by their index values. Result's depth equals number of indexes
 *
Expand Down

72 changes: 72 additions & 0 deletions
tests/system/Helpers/Array/ArrayHelperDotKeyExistsTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Helpers\Array;

use CodeIgniter\Test\CIUnitTestCase;
use InvalidArgumentException;

/**
 * @group Others
 *
 * @internal
 */
final class ArrayHelperDotKeyExistsTest extends CIUnitTestCase
{
 private array $array = [
 'contacts' => [
 'friends' => [
 ['name' => 'Fred Flinstone', 'age' => 20],
 ['age' => 21], // 'name' key does not exist
 ],
 ],
 ];

 public function testDotKeyExists(): void
 {
 $this->assertFalse(ArrayHelper::dotKeyExists('', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('not', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.friends', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('not.friends', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.friends.0.name', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('contacts.friends.1.name', $this->array));
 }

 public function testDotKeyExistsWithEndingWildCard(): void
 {
 $this->expectException(InvalidArgumentException::class);
 $this->expectExceptionMessage('You must set key right after "*". Invalid index: "contacts.*"');

 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.*', $this->array));
 }

 public function testDotKeyExistsWithDoubleWildCard(): void
 {
 $this->expectException(InvalidArgumentException::class);
 $this->expectExceptionMessage('You must set key right after "*". Invalid index: "contacts.*.*.age"');

 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.*.*.age', $this->array));
 }

 public function testDotKeyExistsWithWildCard(): void
 {
 $this->assertTrue(ArrayHelper::dotKeyExists('*.friends', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.friends.*.age', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('contacts.friends.*.name', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('*.friends.*.age', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('*.friends.*.name', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.*.0.age', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.*.1.age', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.*.0.name', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('contacts.*.1.name', $this->array));
 }
}

, '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" + '

Skip to content
feat: add ArrayHelper::dotKeyExists()#8131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 3 commits into

from

Nov 6, 2023
 Merged


feat: add ArrayHelper::dotKeyExists()
#8131
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
3dedf9b

refactor: extract convertToArray()


kenjis Oct 31, 2023
3c4b238

feat: add ArrayHelper::dotKeyExists()


kenjis Oct 31, 2023
dce6576

docs: add PHPDoc


kenjis Oct 31, 2023

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


74 changes: 71 additions & 3 deletions
system/Helpers/Array/ArrayHelper.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,8 @@

namespace CodeIgniter\Helpers\Array;

use InvalidArgumentException;

/**
 * @interal This is internal implementation for the framework.
 *
Expand All@@ -27,9 +29,21 @@ final class ArrayHelper
 *
 * @used-by dot_array_search()
 *
 * @param string $index The index as dot array syntax.
 *
 * @return array|bool|int|object|string|null
 */
 public static function dotSearch(string $index, array $array)
 {
 return self::arraySearchDot(self::convertToArray($index), $array);
 }

 /**
 * @param string $index The index as dot array syntax.
 *
 * @return list<string> The index as an array.
 */
 private static function convertToArray(string $index): array
 {
 // See https://regex101.com/r/44Ipql/1
 $segments = preg_split(
Expand All@@ -39,9 +53,10 @@ public static function dotSearch(string $index, array $array)
 PREG_SPLIT_NO_EMPTY
 );

 $segments = array_map(static fn ($key) => str_replace('\.', '.', $key), $segments);

 return self::arraySearchDot($segments, $array);
 return array_map(
 static fn ($key) => str_replace('\.', '.', $key),
 $segments
 );
 }

 /**
Expand DownExpand Up@@ -106,6 +121,59 @@ private static function arraySearchDot(array $indexes, array $array)
 return null;
 }

 /**
 * array_key_exists() with dot array syntax.
 *
 * If wildcard `*` is used, all items for the key after it must have the key.
 */
 public static function dotKeyExists(string $index, array $array): bool
 {
 if (str_ends_with($index, '*') || str_contains($index, '*.*')) {
 throw new InvalidArgumentException(
 'You must set key right after "*". Invalid index: "' . $index . '"'
Comment thread
kenjis marked this conversation as resolved.

 );
 }

 $indexes = self::convertToArray($index);

 // If indexes is empty, returns false.
 if ($indexes === []) {
 return false;
 }

 $currentArray = $array;

 // Grab the current index
 while ($currentIndex = array_shift($indexes)) {
 if ($currentIndex === '*') {
 $currentIndex = array_shift($indexes);

 foreach ($currentArray as $item) {
 if (! array_key_exists($currentIndex, $item)) {
 return false;
 }
 }

 // If indexes is empty, all elements are checked.
 if ($indexes === []) {
 return true;
 }

 $currentArray = self::dotSearch('*.' . $currentIndex, $currentArray);

 continue;
 }

 if (! array_key_exists($currentIndex, $currentArray)) {
 return false;
 }

 $currentArray = $currentArray[$currentIndex];
 }

 return true;
 }

 /**
 * Groups all rows by their index values. Result's depth equals number of indexes
 *
Expand Down

72 changes: 72 additions & 0 deletions
tests/system/Helpers/Array/ArrayHelperDotKeyExistsTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Helpers\Array;

use CodeIgniter\Test\CIUnitTestCase;
use InvalidArgumentException;

/**
 * @group Others
 *
 * @internal
 */
final class ArrayHelperDotKeyExistsTest extends CIUnitTestCase
{
 private array $array = [
 'contacts' => [
 'friends' => [
 ['name' => 'Fred Flinstone', 'age' => 20],
 ['age' => 21], // 'name' key does not exist
 ],
 ],
 ];

 public function testDotKeyExists(): void
 {
 $this->assertFalse(ArrayHelper::dotKeyExists('', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('not', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.friends', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('not.friends', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.friends.0.name', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('contacts.friends.1.name', $this->array));
 }

 public function testDotKeyExistsWithEndingWildCard(): void
 {
 $this->expectException(InvalidArgumentException::class);
 $this->expectExceptionMessage('You must set key right after "*". Invalid index: "contacts.*"');

 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.*', $this->array));
 }

 public function testDotKeyExistsWithDoubleWildCard(): void
 {
 $this->expectException(InvalidArgumentException::class);
 $this->expectExceptionMessage('You must set key right after "*". Invalid index: "contacts.*.*.age"');

 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.*.*.age', $this->array));
 }

 public function testDotKeyExistsWithWildCard(): void
 {
 $this->assertTrue(ArrayHelper::dotKeyExists('*.friends', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.friends.*.age', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('contacts.friends.*.name', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('*.friends.*.age', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('*.friends.*.name', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.*.0.age', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.*.1.age', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.*.0.name', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('contacts.*.1.name', $this->array));
 }
}

, '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('^' + ".*" + '

Skip to content
feat: add ArrayHelper::dotKeyExists()#8131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 3 commits into

from

Nov 6, 2023
 Merged


feat: add ArrayHelper::dotKeyExists()
#8131
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
3dedf9b

refactor: extract convertToArray()


kenjis Oct 31, 2023
3c4b238

feat: add ArrayHelper::dotKeyExists()


kenjis Oct 31, 2023
dce6576

docs: add PHPDoc


kenjis Oct 31, 2023

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


74 changes: 71 additions & 3 deletions
system/Helpers/Array/ArrayHelper.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,8 @@

namespace CodeIgniter\Helpers\Array;

use InvalidArgumentException;

/**
 * @interal This is internal implementation for the framework.
 *
Expand All@@ -27,9 +29,21 @@ final class ArrayHelper
 *
 * @used-by dot_array_search()
 *
 * @param string $index The index as dot array syntax.
 *
 * @return array|bool|int|object|string|null
 */
 public static function dotSearch(string $index, array $array)
 {
 return self::arraySearchDot(self::convertToArray($index), $array);
 }

 /**
 * @param string $index The index as dot array syntax.
 *
 * @return list<string> The index as an array.
 */
 private static function convertToArray(string $index): array
 {
 // See https://regex101.com/r/44Ipql/1
 $segments = preg_split(
Expand All@@ -39,9 +53,10 @@ public static function dotSearch(string $index, array $array)
 PREG_SPLIT_NO_EMPTY
 );

 $segments = array_map(static fn ($key) => str_replace('\.', '.', $key), $segments);

 return self::arraySearchDot($segments, $array);
 return array_map(
 static fn ($key) => str_replace('\.', '.', $key),
 $segments
 );
 }

 /**
Expand DownExpand Up@@ -106,6 +121,59 @@ private static function arraySearchDot(array $indexes, array $array)
 return null;
 }

 /**
 * array_key_exists() with dot array syntax.
 *
 * If wildcard `*` is used, all items for the key after it must have the key.
 */
 public static function dotKeyExists(string $index, array $array): bool
 {
 if (str_ends_with($index, '*') || str_contains($index, '*.*')) {
 throw new InvalidArgumentException(
 'You must set key right after "*". Invalid index: "' . $index . '"'
Comment thread
kenjis marked this conversation as resolved.

 );
 }

 $indexes = self::convertToArray($index);

 // If indexes is empty, returns false.
 if ($indexes === []) {
 return false;
 }

 $currentArray = $array;

 // Grab the current index
 while ($currentIndex = array_shift($indexes)) {
 if ($currentIndex === '*') {
 $currentIndex = array_shift($indexes);

 foreach ($currentArray as $item) {
 if (! array_key_exists($currentIndex, $item)) {
 return false;
 }
 }

 // If indexes is empty, all elements are checked.
 if ($indexes === []) {
 return true;
 }

 $currentArray = self::dotSearch('*.' . $currentIndex, $currentArray);

 continue;
 }

 if (! array_key_exists($currentIndex, $currentArray)) {
 return false;
 }

 $currentArray = $currentArray[$currentIndex];
 }

 return true;
 }

 /**
 * Groups all rows by their index values. Result's depth equals number of indexes
 *
Expand Down

72 changes: 72 additions & 0 deletions
tests/system/Helpers/Array/ArrayHelperDotKeyExistsTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Helpers\Array;

use CodeIgniter\Test\CIUnitTestCase;
use InvalidArgumentException;

/**
 * @group Others
 *
 * @internal
 */
final class ArrayHelperDotKeyExistsTest extends CIUnitTestCase
{
 private array $array = [
 'contacts' => [
 'friends' => [
 ['name' => 'Fred Flinstone', 'age' => 20],
 ['age' => 21], // 'name' key does not exist
 ],
 ],
 ];

 public function testDotKeyExists(): void
 {
 $this->assertFalse(ArrayHelper::dotKeyExists('', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('not', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.friends', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('not.friends', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.friends.0.name', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('contacts.friends.1.name', $this->array));
 }

 public function testDotKeyExistsWithEndingWildCard(): void
 {
 $this->expectException(InvalidArgumentException::class);
 $this->expectExceptionMessage('You must set key right after "*". Invalid index: "contacts.*"');

 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.*', $this->array));
 }

 public function testDotKeyExistsWithDoubleWildCard(): void
 {
 $this->expectException(InvalidArgumentException::class);
 $this->expectExceptionMessage('You must set key right after "*". Invalid index: "contacts.*.*.age"');

 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.*.*.age', $this->array));
 }

 public function testDotKeyExistsWithWildCard(): void
 {
 $this->assertTrue(ArrayHelper::dotKeyExists('*.friends', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.friends.*.age', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('contacts.friends.*.name', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('*.friends.*.age', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('*.friends.*.name', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.*.0.age', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.*.1.age', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.*.0.name', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('contacts.*.1.name', $this->array));
 }
}

, '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('^' + ".*" + '

Skip to content
feat: add ArrayHelper::dotKeyExists()#8131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 3 commits into

from

Nov 6, 2023
 Merged


feat: add ArrayHelper::dotKeyExists()
#8131
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
3dedf9b

refactor: extract convertToArray()


kenjis Oct 31, 2023
3c4b238

feat: add ArrayHelper::dotKeyExists()


kenjis Oct 31, 2023
dce6576

docs: add PHPDoc


kenjis Oct 31, 2023

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


74 changes: 71 additions & 3 deletions
system/Helpers/Array/ArrayHelper.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,8 @@

namespace CodeIgniter\Helpers\Array;

use InvalidArgumentException;

/**
 * @interal This is internal implementation for the framework.
 *
Expand All@@ -27,9 +29,21 @@ final class ArrayHelper
 *
 * @used-by dot_array_search()
 *
 * @param string $index The index as dot array syntax.
 *
 * @return array|bool|int|object|string|null
 */
 public static function dotSearch(string $index, array $array)
 {
 return self::arraySearchDot(self::convertToArray($index), $array);
 }

 /**
 * @param string $index The index as dot array syntax.
 *
 * @return list<string> The index as an array.
 */
 private static function convertToArray(string $index): array
 {
 // See https://regex101.com/r/44Ipql/1
 $segments = preg_split(
Expand All@@ -39,9 +53,10 @@ public static function dotSearch(string $index, array $array)
 PREG_SPLIT_NO_EMPTY
 );

 $segments = array_map(static fn ($key) => str_replace('\.', '.', $key), $segments);

 return self::arraySearchDot($segments, $array);
 return array_map(
 static fn ($key) => str_replace('\.', '.', $key),
 $segments
 );
 }

 /**
Expand DownExpand Up@@ -106,6 +121,59 @@ private static function arraySearchDot(array $indexes, array $array)
 return null;
 }

 /**
 * array_key_exists() with dot array syntax.
 *
 * If wildcard `*` is used, all items for the key after it must have the key.
 */
 public static function dotKeyExists(string $index, array $array): bool
 {
 if (str_ends_with($index, '*') || str_contains($index, '*.*')) {
 throw new InvalidArgumentException(
 'You must set key right after "*". Invalid index: "' . $index . '"'
Comment thread
kenjis marked this conversation as resolved.

 );
 }

 $indexes = self::convertToArray($index);

 // If indexes is empty, returns false.
 if ($indexes === []) {
 return false;
 }

 $currentArray = $array;

 // Grab the current index
 while ($currentIndex = array_shift($indexes)) {
 if ($currentIndex === '*') {
 $currentIndex = array_shift($indexes);

 foreach ($currentArray as $item) {
 if (! array_key_exists($currentIndex, $item)) {
 return false;
 }
 }

 // If indexes is empty, all elements are checked.
 if ($indexes === []) {
 return true;
 }

 $currentArray = self::dotSearch('*.' . $currentIndex, $currentArray);

 continue;
 }

 if (! array_key_exists($currentIndex, $currentArray)) {
 return false;
 }

 $currentArray = $currentArray[$currentIndex];
 }

 return true;
 }

 /**
 * Groups all rows by their index values. Result's depth equals number of indexes
 *
Expand Down

72 changes: 72 additions & 0 deletions
tests/system/Helpers/Array/ArrayHelperDotKeyExistsTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Helpers\Array;

use CodeIgniter\Test\CIUnitTestCase;
use InvalidArgumentException;

/**
 * @group Others
 *
 * @internal
 */
final class ArrayHelperDotKeyExistsTest extends CIUnitTestCase
{
 private array $array = [
 'contacts' => [
 'friends' => [
 ['name' => 'Fred Flinstone', 'age' => 20],
 ['age' => 21], // 'name' key does not exist
 ],
 ],
 ];

 public function testDotKeyExists(): void
 {
 $this->assertFalse(ArrayHelper::dotKeyExists('', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('not', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.friends', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('not.friends', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.friends.0.name', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('contacts.friends.1.name', $this->array));
 }

 public function testDotKeyExistsWithEndingWildCard(): void
 {
 $this->expectException(InvalidArgumentException::class);
 $this->expectExceptionMessage('You must set key right after "*". Invalid index: "contacts.*"');

 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.*', $this->array));
 }

 public function testDotKeyExistsWithDoubleWildCard(): void
 {
 $this->expectException(InvalidArgumentException::class);
 $this->expectExceptionMessage('You must set key right after "*". Invalid index: "contacts.*.*.age"');

 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.*.*.age', $this->array));
 }

 public function testDotKeyExistsWithWildCard(): void
 {
 $this->assertTrue(ArrayHelper::dotKeyExists('*.friends', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.friends.*.age', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('contacts.friends.*.name', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('*.friends.*.age', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('*.friends.*.name', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.*.0.age', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.*.1.age', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.*.0.name', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('contacts.*.1.name', $this->array));
 }
}

, '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); }
})();
})();

Skip to content
feat: add ArrayHelper::dotKeyExists()#8131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

kenjis
merged 3 commits into

from

Nov 6, 2023
 Merged


feat: add ArrayHelper::dotKeyExists()
#8131
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
3dedf9b

refactor: extract convertToArray()


kenjis Oct 31, 2023
3c4b238

feat: add ArrayHelper::dotKeyExists()


kenjis Oct 31, 2023
dce6576

docs: add PHPDoc


kenjis Oct 31, 2023

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


74 changes: 71 additions & 3 deletions
system/Helpers/Array/ArrayHelper.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,8 @@

namespace CodeIgniter\Helpers\Array;

use InvalidArgumentException;

/**
 * @interal This is internal implementation for the framework.
 *
Expand All@@ -27,9 +29,21 @@ final class ArrayHelper
 *
 * @used-by dot_array_search()
 *
 * @param string $index The index as dot array syntax.
 *
 * @return array|bool|int|object|string|null
 */
 public static function dotSearch(string $index, array $array)
 {
 return self::arraySearchDot(self::convertToArray($index), $array);
 }

 /**
 * @param string $index The index as dot array syntax.
 *
 * @return list<string> The index as an array.
 */
 private static function convertToArray(string $index): array
 {
 // See https://regex101.com/r/44Ipql/1
 $segments = preg_split(
Expand All@@ -39,9 +53,10 @@ public static function dotSearch(string $index, array $array)
 PREG_SPLIT_NO_EMPTY
 );

 $segments = array_map(static fn ($key) => str_replace('\.', '.', $key), $segments);

 return self::arraySearchDot($segments, $array);
 return array_map(
 static fn ($key) => str_replace('\.', '.', $key),
 $segments
 );
 }

 /**
Expand DownExpand Up@@ -106,6 +121,59 @@ private static function arraySearchDot(array $indexes, array $array)
 return null;
 }

 /**
 * array_key_exists() with dot array syntax.
 *
 * If wildcard `*` is used, all items for the key after it must have the key.
 */
 public static function dotKeyExists(string $index, array $array): bool
 {
 if (str_ends_with($index, '*') || str_contains($index, '*.*')) {
 throw new InvalidArgumentException(
 'You must set key right after "*". Invalid index: "' . $index . '"'
Comment thread
kenjis marked this conversation as resolved.

 );
 }

 $indexes = self::convertToArray($index);

 // If indexes is empty, returns false.
 if ($indexes === []) {
 return false;
 }

 $currentArray = $array;

 // Grab the current index
 while ($currentIndex = array_shift($indexes)) {
 if ($currentIndex === '*') {
 $currentIndex = array_shift($indexes);

 foreach ($currentArray as $item) {
 if (! array_key_exists($currentIndex, $item)) {
 return false;
 }
 }

 // If indexes is empty, all elements are checked.
 if ($indexes === []) {
 return true;
 }

 $currentArray = self::dotSearch('*.' . $currentIndex, $currentArray);

 continue;
 }

 if (! array_key_exists($currentIndex, $currentArray)) {
 return false;
 }

 $currentArray = $currentArray[$currentIndex];
 }

 return true;
 }

 /**
 * Groups all rows by their index values. Result's depth equals number of indexes
 *
Expand Down

72 changes: 72 additions & 0 deletions
tests/system/Helpers/Array/ArrayHelperDotKeyExistsTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
<?php

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Helpers\Array;

use CodeIgniter\Test\CIUnitTestCase;
use InvalidArgumentException;

/**
 * @group Others
 *
 * @internal
 */
final class ArrayHelperDotKeyExistsTest extends CIUnitTestCase
{
 private array $array = [
 'contacts' => [
 'friends' => [
 ['name' => 'Fred Flinstone', 'age' => 20],
 ['age' => 21], // 'name' key does not exist
 ],
 ],
 ];

 public function testDotKeyExists(): void
 {
 $this->assertFalse(ArrayHelper::dotKeyExists('', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('not', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.friends', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('not.friends', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.friends.0.name', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('contacts.friends.1.name', $this->array));
 }

 public function testDotKeyExistsWithEndingWildCard(): void
 {
 $this->expectException(InvalidArgumentException::class);
 $this->expectExceptionMessage('You must set key right after "*". Invalid index: "contacts.*"');

 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.*', $this->array));
 }

 public function testDotKeyExistsWithDoubleWildCard(): void
 {
 $this->expectException(InvalidArgumentException::class);
 $this->expectExceptionMessage('You must set key right after "*". Invalid index: "contacts.*.*.age"');

 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.*.*.age', $this->array));
 }

 public function testDotKeyExistsWithWildCard(): void
 {
 $this->assertTrue(ArrayHelper::dotKeyExists('*.friends', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.friends.*.age', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('contacts.friends.*.name', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('*.friends.*.age', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('*.friends.*.name', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.*.0.age', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.*.1.age', $this->array));
 $this->assertTrue(ArrayHelper::dotKeyExists('contacts.*.0.name', $this->array));
 $this->assertFalse(ArrayHelper::dotKeyExists('contacts.*.1.name', $this->array));
 }
}