hi-folks / array Goto Github PK

Add at() method like the js one:
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/at

Checklist

• implement method
• write phpdoc for the function
• write test in tests/ArrTest.php
• execute composer format
• execute composer test-coverage
• check if your method has full test coverage
• add method in changelog
• update doc/arr.md adding a use case of the new method
• update cheatsheet (examples/cheatsheet.php)

Improving documentation examples for Table methods:

• groupBy(): grouping data
• transform(): transforms a specific field with the provided function
• orderBy(): sorting data (ascending or descending)

Where to improve:

• README.md file
• doc/table.md file
• examples/cheatsheet_table.php

What

Add new method to Table class, in src/Table.php file

Description

The toArray() method returns a bidimensional PHP array from Table class.

In Table class, you could have something like this:

    /**
     * @return array
     */
    public function toArray(): array
    {
        $result = [];
        foreach ($this->rows() as $key => $row ) {
            $result[$key] = $row->arr();
        }
        return $result;
    }

Checklist

• implement method
• write phpdoc for the function
• write test in tests/TableTest.php
• execute composer format
• execute composer test-coverage
• check if your method has full test coverage
• add method in changelog
• update doc/table.md adding a use case of the new method
• update cheatsheet (examples/cheatsheet-table.php)

In order to access to Arr object like an array:

• Add implements ArrayAccess
• implements new methods specific for ArrayAccess:

public offsetExists(mixed $offset): bool
public offsetGet(mixed $offset): mixed
public offsetSet(mixed $offset, mixed $value): void
public offsetUnset(mixed $offset): void

I received this error using wampserver 3.2.8 with php 7.2.1
Parse error: syntax error, unexpected '|', expecting ';' or '{' in C:\wamp\www\stats\statistics-main\src\Stat.php on line 34
just thought you should know.

composer require rector/rector --dev

For starting in a easy way, we can start using these directives:

        LevelSetList::UP_TO_PHP_80,
        SetList::DEAD_CODE,

What

Add new method to Arr class, in src/Arr.php file

Description

The includes() method determines whether an array includes a certain value among its entries, returning true or false as appropriate.

See: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/includes

Checklist

• implement method
• write phpdoc for the function
• write test in tests/ArrTest.php
• execute composer format
• execute composer test-coverage
• check if your method has full test coverage
• add method in changelog
• update doc/arr.md adding a use case of the new method
• update cheatsheet (examples/cheatsheet.php)

What

Add new method to Arr class, in src/Arr.php file

Description

The find() method returns the value of the first element in the provided array that satisfies the provided testing function. If no values satisfy the testing function, undefined is returned.
See: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/find

Checklist

• implement method
• write phpdoc for the function
• write test in tests/ArrTest.php
• execute composer format
• execute composer test-coverage
• check if your method has full test coverage
• add method in changelog
• update doc/arr.md adding a use case of the new method
• update cheatsheet (examples/cheatsheet.php)

What

Add new method to Arr class, in src/Arr.php file

Description

The values() method returns a new Arr iterator object that contains the values for each index in the array.
Arr already implements Iterator, so you can call next() method directly on Arr object. values() creates a new Arr object just with values, and the keys are not preserved

See: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/values

Checklist

• implement method
• write phpdoc for the function
• write test in tests/ArrTest.php
• execute composer format
• execute composer test-coverage
• check if your method has full test coverage
• add method in changelog
• update doc/arr.md adding a use case of the new method
• update cheatsheet (examples/cheatsheet.php)

What

Add new method to Arr class, in src/Arr.php file

Description

The Array.from() static method creates a new, shallow-copied Array instance from an array-like or iterable object.

See: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/from

Checklist

• implement method
• write phpdoc for the function
• write test in tests/ArrTest.php
• execute composer format
• execute composer test-coverage
• check if your method has full test coverage
• add method in changelog
• update doc/arr.md adding a use case of the new method
• update cheatsheet (examples/cheatsheet.php)

add keys() method like this JS one:
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/keys

• extract keys
• returns standard arrays (not Arr class)

Add Pint https://github.com/laravel/pint as code style fixer

In composer.json, replace the
"format": "vendor/bin/php-cs-fixer fix --allow-risky=yes"
with
"format": "vendor/bin/pint"

What

Add new method to Arr class, in src/Arr.php file

Description

The copyWithin() method shallow copies part of an array to another location in the same array and returns it without modifying its length

See: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/copyWithin

Checklist

• implement method
• write phpdoc for the function
• write test in tests/ArrTest.php
• execute composer format
• execute composer test-coverage
• check if your method has full test coverage
• add method in changelog
• update doc/arr.md adding a use case of the new method
• update cheatsheet (examples/cheatsheet.php)

What

Add new method to Arr class, in src/Arr.php file

Description

The findIndex() method returns the index of the first element in the array that satisfies the provided testing function. Otherwise, it returns -1, indicating that no element passed the test.
See: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/findIndex

Checklist

• implement method
• write phpdoc for the function
• write test in tests/ArrTest.php
• execute composer format
• execute composer test-coverage
• check if your method has full test coverage
• add method in changelog
• update doc/arr.md adding a use case of the new method
• update cheatsheet (examples/cheatsheet.php)

The Arr::of() method creates a new Arr instance from a variable number of arguments, regardless of number or type of the arguments.
Like this one: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/of

What

Add new method to Arr class, in src/Arr.php file

Description

The entries() method returns a new Arr object that contains the key/value pairs for each index in the array.
See: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/entries

Checklist

• implement method
• write phpdoc for the function
• write test in tests/ArrTest.php
• execute composer format
• execute composer test-coverage
• check if your method has full test coverage
• add method in changelog
• update doc/arr.md adding a use case of the new method
• update cheatsheet (examples/cheatsheet.php)

This is a task to increasing the PHPStan level to 9 on the CI test.
Currently the level is left blank, we can increase this to level 9 and then resolve some of the issues.

This will help us improve the quality of the package but also allow us to catch bugs before they are merged into the main branch.

The rules can be found here:
https://phpstan.org/user-guide/rule-levels

What

Add new method to Table class, in src/Table.php file

Description

The except method excludes fields from the table. It is the inverse select().

Checklist

• implement method
• write phpdoc for the function
• write test in tests/TableTest.php
• execute composer format
• execute composer test-coverage
• check if your method has full test coverage
• add method in changelog
• update doc/table.md adding a use case of the new method
• update cheatsheet (examples/cheatsheet-table.php)

Now we have phpstan executed with level 3.
The request is for raising the level to 4.
in the file phpstan.neon set level to 4, and then execute composer run phpstan:

 parameters:
     level: 4
     paths:
         - src

Executing phpstan with level 4 you will receive this warning:

  7      Property HiFolks\DataType\Table::$schema is never read, only written.
         💡 See:
         https://phpstan.org/developing-extensions/always-read-written-propert
         ies

If this warning is solved we could increase the level of phpstan to 4.

Remove src/Classes/Operation.php file.
Now the function for performing operations is managed as traits (src/Traits/Calculable.php)

Consider this suggestion: https://twitter.com/marekgibney/status/1519938757893439488

$table->group('product')->transform(Operation::aggregate(['total'=>['price', 'array_sum']]));

Table::group -> Groups rows by field
Table::transform -> Transforms rows by func
Operation::aggregate -> Aggregates fields by funcs

Checklist

• implement method
• write phpdoc for the function
• write test in tests/TableTest.php
• execute composer format
• execute composer test-coverage
• check if your method has full test coverage
• add method in changelog
• update doc/table.md adding a use case of the new method
• update cheatsheet (examples/cheatsheet-table.php)

Executing PHP stan you can see the error:

Error: Parameter #1 $value of function strval expects bool|float|int|resource|string|null, mixed given.
 ------ --------------------------------------------------- 
  Line   Table.php                                          
 ------ --------------------------------------------------- 
  181    Parameter #1 $value of function strval expects     
         bool|float|int|resource|string|null, mixed given.  
 ------ --------------------------------------------------- 

Change the type according to the PHPstan suggestion

What

Add new method to Table class, in src/Table.php file

Description

groupThenApply($field, $calcField, $function)
Where $field is the field to group data,
$function is the function to apply to each group (for each row) in $calcField

Example, for this data:

$dataTable = [
    ['product' => 'Desk', 'price' => 200, 'active' => true],
    ['product' => 'Chair', 'price' => 100, 'active' => true],
    ['product' => 'Door', 'price' => 300, 'active' => false],
    ['product' => 'Bookcase', 'price' => 150, 'active' => true],
    ['product' => 'Door', 'price' => 100, 'active' => true],
];

and the function sum on price, and $calcField is "total", the result will be

[
'Desk' => ['product' => 'Desk', 'total' => 200],
'Chair' => ['product' => 'Chair', 'total' => 100],
'Door' => ['product' => 'Door', 'total' => 400],
'Bookcase' => ['product' => 'Bookcase', 'total' => 150]
]

Checklist

• implement method
• write phpdoc for the function
• write test in tests/TableTest.php
• execute composer format
• execute composer test-coverage
• check if your method has full test coverage
• add method in changelog
• update doc/table.md adding a use case of the new method
• update cheatsheet (examples/cheatsheet-table.php)

What

Add new method to Arr class, in src/Arr.php file

Description

The toLocaleString() method returns a string representing the elements of the array. The elements are converted to Strings using their toLocaleString methods and these Strings are separated by a locale-specific String (such as a comma “,”).
In PHP as far as I know there is no toLocaleString. My suggestion is to try to convert into locale string detecting the type

• number_format() if number
• date_format if it is date

see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/toLocaleString

Checklist

• implement method
• write phpdoc for the function
• write test in tests/ArrTest.php
• execute composer format
• execute composer test-coverage
• check if your method has full test coverage
• add method in changelog
• update doc/arr.md adding a use case of the new method
• update cheatsheet (examples/cheatsheet.php)