Skip to content

Commit

Permalink
Add include, rename omit to exclude
Browse files Browse the repository at this point in the history
  • Loading branch information
@nicksagona
nicksagona committed Feb 21, 2024
1 parent f7c4228 commit 3604b6b
Show file tree
Hide file tree
Showing 3 changed files with 70 additions and 30 deletions.
9 changes: 8 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Where serializing or unserializing CSV data, there are a set of options availabl

```php
$options = [
'omit' => ['id'] // An array of fields to omit from displaying
'exclude' => ['id'] // An array of fields to exclude from displaying
'delimiter' => ',' // Delimiter defaults to ',' - could be "\t" or something else
'enclosure' => '"' // Default string enclosure, i.e. "my data","other data"
'escape' => '"' // String character to escape in the data, i.e. "my ""data"" here"
Expand All @@ -91,6 +91,13 @@ $options = [
];
```

Conversely, `include` can be used to only include the fields in the `include` array:

```php
$options = [
'include' => ['username', 'first_name', 'last_name'] // An array of fields to include from displaying
```

Pass the options array to `serialize()` or `unserialize()` methods:

```php
Expand Down
64 changes: 38 additions & 26 deletions src/Csv.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -137,14 +137,17 @@ public static function writeDataToFile(array $data, string $to, array $options =
* @param array $data
* @param string $to
* @param string $delimiter
* @param array $omit
* @throws Exception
* @param array $exclude
* @param array $include
* @return void
*@throws Exception
*/
public static function writeTemplateToFile(array $data, string $to, string $delimiter = ',', array $omit = []): void
public static function writeTemplateToFile(
array $data, string $to, string $delimiter = ',', array $exclude = [], array $include = []
): void
{
$csv = new self($data);
$csv->writeBlankFile($to, $delimiter, $omit);
$csv->writeBlankFile($to, $delimiter, $exclude, $include);
}

/**
Expand Down Expand Up @@ -174,17 +177,17 @@ public static function outputDataToHttp(
* @param bool $forceDownload
* @param array $headers
* @param string $delimiter
* @param array $omit
* @param array $exclude
* @throws Exception
* @return void
*/
public static function outputTemplateToHttp(
array $data, string $filename = 'pop-data-template.csv', bool $forceDownload = true,
array $headers = [], string $delimiter = ',', array $omit = []
array $headers = [], string $delimiter = ',', array $exclude = []
)
{
$csv = new self($data);
$csv->outputBlankFileToHttp($filename, $forceDownload, $headers, $delimiter, $omit);
$csv->outputBlankFileToHttp($filename, $forceDownload, $headers, $delimiter, $exclude);
}

/**
Expand Down Expand Up @@ -320,17 +323,17 @@ public function outputToHttp(string $filename = 'pop-data.csv', bool $forceDownl
* @param bool $forceDownload
* @param array $headers
* @param string $delimiter
* @param array $omit
* @param array $exclude
* @throws Exception
* @return void
*/
public function outputBlankFileToHttp(
string $filename = 'pop-data.csv', bool $forceDownload = true, array $headers = [], string $delimiter = ',', array $omit = []
string $filename = 'pop-data.csv', bool $forceDownload = true, array $headers = [], string $delimiter = ',', array $exclude = []
): void
{
// Attempt to serialize data if it hasn't been done yet
if (($this->string === null) && ($this->data !== null) && isset($this->data[0])) {
$fieldHeaders = self::getFieldHeaders($this->data[0], $delimiter, $omit);
$fieldHeaders = self::getFieldHeaders($this->data[0], $delimiter, $exclude);
} else {
throw new Exception('Error: The data has not been set.');
}
Expand Down Expand Up @@ -386,15 +389,16 @@ public function writeToFile(string $to): void
*
* @param string $to
* @param string $delimiter
* @param array $omit
* @throws Exception
* @param array $exclude
* @param array $include
* @return void
*@throws Exception
*/
public function writeBlankFile(string $to, string $delimiter = ',', array $omit = []): void
public function writeBlankFile(string $to, string $delimiter = ',', array $exclude = [], array $include = []): void
{
// Attempt to get field headers and output file
if (($this->string === null) && ($this->data !== null) && isset($this->data[0])) {
file_put_contents($to, self::getFieldHeaders($this->data[0], $delimiter, $omit));
file_put_contents($to, self::getFieldHeaders($this->data[0], $delimiter, $exclude, $include));
} else {
throw new Exception('Error: The data has not been set.');
}
Expand Down Expand Up @@ -450,7 +454,7 @@ function($value) { return str_replace('"', '', $value); }, explode(',', trim(fge

$options = self::processOptions($options);
$csvRow = self::serializeRow(
(array)$row, [], $options['delimiter'], $options['enclosure'],
(array)$row, [], [], $options['delimiter'], $options['enclosure'],
$options['escape'], $options['newline'], $options['limit']
);

Expand Down Expand Up @@ -483,10 +487,16 @@ public static function serializeData(mixed $data, array $options = []): string
$data = $newData;
}

if (isset($options['omit'])) {
$omit = (!is_array($options['omit'])) ? [$options['omit']] : $options['omit'];
if (isset($options['exclude'])) {
$exclude = (!is_array($options['exclude'])) ? [$options['exclude']] : $options['exclude'];
} else {
$exclude = [];
}

if (isset($options['include'])) {
$include = (!is_array($options['include'])) ? [$options['include']] : $options['include'];
} else {
$omit = [];
$include = [];
}

$options = self::processOptions($options);
Expand All @@ -495,13 +505,13 @@ public static function serializeData(mixed $data, array $options = []): string

if (is_array($data) && isset($data[$firstKey]) &&
(is_array($data[$firstKey]) || ($data[$firstKey] instanceof \ArrayObject)) && ($options['fields'])) {
$csv .= self::getFieldHeaders((array)$data[$firstKey], $options['delimiter'], $omit);
$csv .= self::getFieldHeaders((array)$data[$firstKey], $options['delimiter'], $exclude, $include);
}

// Initialize and clean the field values.
foreach ($data as $value) {
$csv .= self::serializeRow(
(array)$value, $omit, $options['delimiter'], $options['enclosure'],
(array)$value, $exclude, $include, $options['delimiter'], $options['enclosure'],
$options['escape'], $options['newline'], $options['limit']
);
}
Expand Down Expand Up @@ -556,7 +566,8 @@ public static function unserializeString(string $string, array $options = []): a
* Serialize single row of data
*
* @param array $value
* @param array $omit
* @param array $exclude
* @param array $include
* @param string $delimiter
* @param string $enclosure
* @param string $escape
Expand All @@ -565,13 +576,13 @@ public static function unserializeString(string $string, array $options = []): a
* @return string
*/
public static function serializeRow(
array $value, array $omit = [], string $delimiter = ',', string $enclosure = '"',
array $value, array $exclude = [], array $include = [], string $delimiter = ',', string $enclosure = '"',
string $escape = '"', bool $newline = true, int $limit = 0
): string
{
$rowAry = [];
foreach ($value as $key => $val) {
if (!in_array($key, $omit)) {
if (!in_array($key, $exclude) && (empty($include) || in_array($key, $include))) {
if (!$newline) {
$val = str_replace(["\n", "\r"], [" ", " "], $val);
}
Expand All @@ -596,15 +607,16 @@ public static function serializeRow(
*
* @param mixed $data
* @param string $delimiter
* @param array $omit
* @param array $exclude
* @param array $include
* @return string
*/
public static function getFieldHeaders(mixed $data, string $delimiter = ',', array $omit = []): string
public static function getFieldHeaders(mixed $data, string $delimiter = ',', array $exclude = [], array $include = []): string
{
$headers = array_keys($data);
$headersAry = [];
foreach ($headers as $header) {
if (!in_array($header, $omit)) {
if (!in_array($header, $exclude) && (empty($include) || in_array($header, $include))) {
$headersAry[] = $header;
}
}
Expand Down
27 changes: 24 additions & 3 deletions tests/CsvTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ public function testSerializeWithAssociativeArray()
$this->assertStringContainsString('Bob,"Smith, III"', (string)$string);
}

public function testOmit()
public function testExclude()
{
$data = [
[
Expand All @@ -178,10 +178,31 @@ public function testOmit()
]
];
$string = new Csv($data);
$csvString = $string->serialize(['omit' => 'first_name']);
$csvString = $string->serialize(['exclude' => 'first_name']);
$this->assertStringNotContainsString('Bob', $csvString);
}

public function testInclude()
{
$data = [
[
'first_name' => 'Bob',
'last_name' => 'Smith, III'
],
[
'first_name' => 'Jane',
'last_name' => 'Smith "Janey"'
],
[
'first_name' => 'Jim',
'last_name' => 'Smith, Jr. "Junior"'
]
];
$string = new Csv($data);
$csvString = $string->serialize(['include' => 'first_name']);
$this->assertStringContainsString('Bob', $csvString);
}

public function testNewline()
{
$data = [
Expand Down Expand Up @@ -346,4 +367,4 @@ public function testOutputTemplateToHttp()
$this->assertStringContainsString('foo', $result);
}

}
}

0 comments on commit 3604b6b

Please sign in to comment.