Skip to content

Commit

Permalink
Updated PHPDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
szczyglis-dev committed Apr 25, 2022
1 parent 60c1c36 commit 7ae2a35
Show file tree
Hide file tree
Showing 68 changed files with 945 additions and 66 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# Ultimate Chain Parser - advanced chain-flow based parser

PHP **7.2.5+**, current release: **1.2.6** build 2022-04-23
PHP **7.2.5+**, current release: **1.2.7** build 2022-04-25

**"Ultimate Chain Parser" is a modular package for chain processing text data and converting it into a structured output.
The concept of application is based on processing in subsequent iterations using configurable data processing modules in a configured manner. Each such element in the execution chain accesses the output of the previous element in the chain as input.**
Expand Down Expand Up @@ -1645,6 +1645,8 @@ ___

**- 1.2.6** - Full dataset sharing added, eraser and splitter plugins are removed (their role is taken over by limiter), added configuration of dataset looks by freely specifying each separator for each dimension (rowset, row, column). (2022-04-23)

**- 1.2.7** - phpdoc updated (2022-04-25)

# Credits

### Ultimate Chain Parser is free to use but if you liked then you can donate project via BTC:
Expand Down
17 changes: 17 additions & 0 deletions cmd.php
Original file line number Diff line number Diff line change
@@ -1,8 +1,25 @@
#!/usr/bin/env php
<?php

/**
* This file is part of szczyglis/ultimate-chain-parser.
*
* (c) Marcin Szczyglinski <[email protected]>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

require __DIR__.'/vendor/autoload.php';

/**
* @package szczyglis/ultimate-chain-parser
* @author Marcin Szczyglinski <[email protected]>
* @copyright 2022 Marcin Szczyglinski
* @license http://www.opensource.org/licenses/MIT The MIT License
* @link https://github.com/szczyglis-dev/ultimate-chain-parser
*/

use Symfony\Component\Console\Application;
use Szczyglis\ChainParser\Command\ParseCommand;

Expand Down
15 changes: 15 additions & 0 deletions example.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,21 @@

require __DIR__ . '/vendor/autoload.php';

/**
* This file is part of szczyglis/ultimate-chain-parser.
*
* (c) Marcin Szczyglinski <[email protected]>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code. *
*
* @package szczyglis/ultimate-chain-parser
* @author Marcin Szczyglinski <[email protected]>
* @copyright 2022 Marcin Szczyglinski
* @license http://www.opensource.org/licenses/MIT The MIT License
* @link https://github.com/szczyglis-dev/ultimate-chain-parser
*/

use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\JsonResponse;
use Szczyglis\ChainParser\ChainParser;
Expand Down
15 changes: 14 additions & 1 deletion src/ChainParser.php
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
<?php

/**
* This file is part of szczyglis/ultimate-chain-parser.
*
* (c) Marcin Szczyglinski <[email protected]>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Szczyglis\ChainParser;

use Szczyglis\ChainParser\Contract\InputInterface;
Expand All @@ -16,7 +25,11 @@

/**
* Class ChainParser
* @package Szczyglis\ChainParser
* @package szczyglis/ultimate-chain-parser
* @author Marcin Szczyglinski <[email protected]>
* @copyright 2022 Marcin Szczyglinski
* @license http://www.opensource.org/licenses/MIT The MIT License
* @link https://github.com/szczyglis-dev/ultimate-chain-parser
*/
class ChainParser
{
Expand Down
15 changes: 14 additions & 1 deletion src/Command/ParseCommand.php
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
<?php

/**
* This file is part of szczyglis/ultimate-chain-parser.
*
* (c) Marcin Szczyglinski <[email protected]>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Szczyglis\ChainParser\Command;

use Symfony\Component\Console\Command\Command;
Expand All @@ -15,7 +24,11 @@

/**
* Class ParseCommand
* @package Szczyglis\ChainParser\Command
* @package szczyglis/ultimate-chain-parser
* @author Marcin Szczyglinski <[email protected]>
* @copyright 2022 Marcin Szczyglinski
* @license http://www.opensource.org/licenses/MIT The MIT License
* @link https://github.com/szczyglis-dev/ultimate-chain-parser
*/
class ParseCommand extends Command
{
Expand Down
15 changes: 14 additions & 1 deletion src/Config/ArrayConfig.php
Original file line number Diff line number Diff line change
@@ -1,12 +1,25 @@
<?php

/**
* This file is part of szczyglis/ultimate-chain-parser.
*
* (c) Marcin Szczyglinski <[email protected]>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Szczyglis\ChainParser\Config;

use Szczyglis\ChainParser\Contract\ConfigInterface;

/**
* Class ArrayConfig
* @package Szczyglis\ChainParser\Config
* @package szczyglis/ultimate-chain-parser
* @author Marcin Szczyglinski <[email protected]>
* @copyright 2022 Marcin Szczyglinski
* @license http://www.opensource.org/licenses/MIT The MIT License
* @link https://github.com/szczyglis-dev/ultimate-chain-parser
*/
class ArrayConfig implements ConfigInterface
{
Expand Down
15 changes: 14 additions & 1 deletion src/Config/YamlConfig.php
Original file line number Diff line number Diff line change
@@ -1,13 +1,26 @@
<?php

/**
* This file is part of szczyglis/ultimate-chain-parser.
*
* (c) Marcin Szczyglinski <[email protected]>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Szczyglis\ChainParser\Config;

use Szczyglis\ChainParser\Contract\ConfigInterface;
use Symfony\Component\Yaml\Yaml;

/**
* Class YamlConfig
* @package Szczyglis\ChainParser\Config
* @package szczyglis/ultimate-chain-parser
* @author Marcin Szczyglinski <[email protected]>
* @copyright 2022 Marcin Szczyglinski
* @license http://www.opensource.org/licenses/MIT The MIT License
* @link https://github.com/szczyglis-dev/ultimate-chain-parser
*/
class YamlConfig implements ConfigInterface
{
Expand Down
15 changes: 14 additions & 1 deletion src/Contract/ConfigInterface.php
Original file line number Diff line number Diff line change
@@ -1,10 +1,23 @@
<?php

/**
* This file is part of szczyglis/ultimate-chain-parser.
*
* (c) Marcin Szczyglinski <[email protected]>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Szczyglis\ChainParser\Contract;

/**
* Interface ConfigInterface
* @package Szczyglis\ChainParser\Contract
* @package szczyglis/ultimate-chain-parser
* @author Marcin Szczyglinski <[email protected]>
* @copyright 2022 Marcin Szczyglinski
* @license http://www.opensource.org/licenses/MIT The MIT License
* @link https://github.com/szczyglis-dev/ultimate-chain-parser
*/
interface ConfigInterface
{
Expand Down
15 changes: 14 additions & 1 deletion src/Contract/InputInterface.php
Original file line number Diff line number Diff line change
@@ -1,10 +1,23 @@
<?php

/**
* This file is part of szczyglis/ultimate-chain-parser.
*
* (c) Marcin Szczyglinski <[email protected]>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Szczyglis\ChainParser\Contract;

/**
* Interface InputInterface
* @package Szczyglis\ChainParser\Contract
* @package szczyglis/ultimate-chain-parser
* @author Marcin Szczyglinski <[email protected]>
* @copyright 2022 Marcin Szczyglinski
* @license http://www.opensource.org/licenses/MIT The MIT License
* @link https://github.com/szczyglis-dev/ultimate-chain-parser
*/
interface InputInterface
{
Expand Down
15 changes: 14 additions & 1 deletion src/Contract/LoggableInterface.php
Original file line number Diff line number Diff line change
@@ -1,12 +1,25 @@
<?php

/**
* This file is part of szczyglis/ultimate-chain-parser.
*
* (c) Marcin Szczyglinski <[email protected]>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Szczyglis\ChainParser\Contract;

use Szczyglis\ChainParser\Contract\LoggerInterface;

/**
* Interface LoggableInterface
* @package Szczyglis\ChainParser\Contract
* @package szczyglis/ultimate-chain-parser
* @author Marcin Szczyglinski <[email protected]>
* @copyright 2022 Marcin Szczyglinski
* @license http://www.opensource.org/licenses/MIT The MIT License
* @link https://github.com/szczyglis-dev/ultimate-chain-parser
*/
interface LoggableInterface
{
Expand Down
15 changes: 14 additions & 1 deletion src/Contract/LoggableWorkerInterface.php
Original file line number Diff line number Diff line change
@@ -1,12 +1,25 @@
<?php

/**
* This file is part of szczyglis/ultimate-chain-parser.
*
* (c) Marcin Szczyglinski <[email protected]>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Szczyglis\ChainParser\Contract;

use Szczyglis\ChainParser\Contract\LoggerInterface;

/**
* Interface LoggableWorkerInterface
* @package Szczyglis\ChainParser\Contract
* @package szczyglis/ultimate-chain-parser
* @author Marcin Szczyglinski <[email protected]>
* @copyright 2022 Marcin Szczyglinski
* @license http://www.opensource.org/licenses/MIT The MIT License
* @link https://github.com/szczyglis-dev/ultimate-chain-parser
*/
interface LoggableWorkerInterface
{
Expand Down
15 changes: 14 additions & 1 deletion src/Contract/LoggerInterface.php
Original file line number Diff line number Diff line change
@@ -1,12 +1,25 @@
<?php

/**
* This file is part of szczyglis/ultimate-chain-parser.
*
* (c) Marcin Szczyglinski <[email protected]>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Szczyglis\ChainParser\Contract;

use Szczyglis\ChainParser\Core\DataBag;

/**
* Interface LoggerInterface
* @package Szczyglis\ChainParser\Contract
* @package szczyglis/ultimate-chain-parser
* @author Marcin Szczyglinski <[email protected]>
* @copyright 2022 Marcin Szczyglinski
* @license http://www.opensource.org/licenses/MIT The MIT License
* @link https://github.com/szczyglis-dev/ultimate-chain-parser
*/
interface LoggerInterface
{
Expand Down
15 changes: 14 additions & 1 deletion src/Contract/OptionResolverInterface.php
Original file line number Diff line number Diff line change
@@ -1,10 +1,23 @@
<?php

/**
* This file is part of szczyglis/ultimate-chain-parser.
*
* (c) Marcin Szczyglinski <[email protected]>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Szczyglis\ChainParser\Contract;

/**
* Interface OptionResolverInterface
* @package Szczyglis\ChainParser\Contract
* @package szczyglis/ultimate-chain-parser
* @author Marcin Szczyglinski <[email protected]>
* @copyright 2022 Marcin Szczyglinski
* @license http://www.opensource.org/licenses/MIT The MIT License
* @link https://github.com/szczyglis-dev/ultimate-chain-parser
*/
interface OptionResolverInterface
{
Expand Down
15 changes: 14 additions & 1 deletion src/Contract/OptionsInterface.php
Original file line number Diff line number Diff line change
@@ -1,10 +1,23 @@
<?php

/**
* This file is part of szczyglis/ultimate-chain-parser.
*
* (c) Marcin Szczyglinski <[email protected]>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Szczyglis\ChainParser\Contract;

/**
* Interface OptionsInterface
* @package Szczyglis\ChainParser\Contract
* @package szczyglis/ultimate-chain-parser
* @author Marcin Szczyglinski <[email protected]>
* @copyright 2022 Marcin Szczyglinski
* @license http://www.opensource.org/licenses/MIT The MIT License
* @link https://github.com/szczyglis-dev/ultimate-chain-parser
*/
interface OptionsInterface
{
Expand Down
15 changes: 14 additions & 1 deletion src/Contract/PluginInterface.php
Original file line number Diff line number Diff line change
@@ -1,13 +1,26 @@
<?php

/**
* This file is part of szczyglis/ultimate-chain-parser.
*
* (c) Marcin Szczyglinski <[email protected]>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Szczyglis\ChainParser\Contract;

use Szczyglis\ChainParser\Core\DataBag;
use Szczyglis\ChainParser\Contract\WorkerInterface;

/**
* Interface PluginInterface
* @package Szczyglis\ChainParser\Contract
* @package szczyglis/ultimate-chain-parser
* @author Marcin Szczyglinski <[email protected]>
* @copyright 2022 Marcin Szczyglinski
* @license http://www.opensource.org/licenses/MIT The MIT License
* @link https://github.com/szczyglis-dev/ultimate-chain-parser
*/
interface PluginInterface
{
Expand Down
Loading

0 comments on commit 7ae2a35

Please sign in to comment.