Zec Data Parsingのダウンロード - Zec Data Parsingソースコードのダウンロード

Zec: PHP データ解析ライブラリ

Zec Data Parsingおよびスキーマ宣言ライブラリは、PHP アプリケーションにスキーマ定義および検証機能をもたらすように設計されています。

インストール

作曲家

composer require mohamed-amine-sayagh/zec

要件

PHP 8.0以降

使用例

Zec ライブラリを使用してユーザープロファイルスキーマを定義および検証する方法の例を次に示します。

ユーザーデータ検証用のスキーマを定義する

    use function Zec  Utils  z ;

    // Define the user profile schema
    $ userProfileParser = z ()-> options ([
        ' name ' => z ()-> string ()-> min ( 3 )-> max ( 50 ),  // Name must be a string between 3 and 50 characters
        ' age ' => z ()-> number ()-> min ( 18 ),           // Age must be a number and at least 18
        ' email ' => z ()-> email (),                   // Email must be a valid email address
        ' address ' => z ()-> options ([               
            ' street ' => z ()-> string (),             
            ' city ' => z ()-> string ()                
        ]),
        ' hobbies ' => z ()-> each ( z ()-> string ()),     // Hobbies must be an array of strings
        ' metadata ' => z ()-> optional ()-> each ( z ()-> options ([  // Metadata is optional and must be an array of objects
            ' key ' => z ()-> string (),                // Each object must have a key as a string
            ' value ' => z ()-> string ()               // Each object must have a value as a string
        ]))
    ]);

ユーザーデータを解析して検証する

    // Parse and validate user data
    $ userData = [
        ' name ' => ' Jane Doe ' ,
        ' age ' => 1 , // 1 is not a valid age
        ' email ' => ' jane.doe@examplecom ' , // missing dot
        ' address ' => [
            ' street ' => ' 123 Elm St ' ,
            ' city ' => 3 // city is not a string
        ],
        ' hobbies ' => [ ' photography ' , ' traveling ' , ' reading ' , 5 ], // 5 is not a string     
        ' metadata ' => [
            [ ' key ' => ' memberSince ' , ' value ' => ' 2019 ' ],
            [ ' key ' => ' newsletter ' , ' value ' => ' true ' ]
        ]
    ];

    try {
        $ userProfileParser -> parseOrThrow ( $ userData ); // Throws an error
        echo " User data is valid n" ;
    } catch (  Zec  ZecError $ e ) {
        echo " User data is invalid: " ;
        $ e -> log (); // Log the error
    }

予想されるエラー応答

    User data is invalid: [
        {
            "parser": "min",
            "value": 1,
            "min": 18,
            "message": "Invalid value",
            "path": [
                "age"
            ]
        },
        {
            "parser": "email",
            "value": "jane.doe@examplecom",
            "message": "Invalid email address",
            "path": [
                "email"
            ]
        },
        {
            "parser": "string",
            "value": 5,
            "message": "Invalid string value",
            "path": [
                "hobbies",
                "3"
            ]
        }
    ]

現在のバージョン: v1.0.0、リリース日: 2024-10-01、作成者: Mohamed Amine SAYAGH、リリースノート: Zec PHP データ解析ライブラリの初期リリース。リリースリンク: [Zec 1.0.0](

注:このライブラリは現在開発中です。公式ドキュメントとその他のリソースは間もなく利用可能になります。

著者情報:

リンクトイン
GitHub
ポートフォリオ

堅牢なスキーマ検証: Zec ライブラリと同様の強力な型指定と検証を提供し、正確なデータ処理を保証します。
モジュール式で拡張可能: カスタムパーサーを使用して簡単に拡張でき、多様なデータ検証のニーズに対応します。
懸念の分離: データ解析をビジネスロジックから分離して、セキュリティと保守性を向上させます。
テストの容易さ: 厳密なデータ検証を強制することでテストを簡素化します。
柔軟な構成: コアライブラリを変更せずに、動的なパーサーの構成とカスタマイズをサポートします。
コミュニティ重視: 貢献を受け入れ、共同の改善とサポートを強化します。

コラボレーション

コラボレーションも大歓迎です！ PHP データ解析ライブラリへの貢献にご興味がございましたら、ぜひご連絡をお待ちしております。コードの貢献、ドキュメントの改善、機能の提案など、皆様からのご意見は大歓迎です。

貢献方法

リポジトリをフォークする: まず、リポジトリを自分の GitHub アカウントにフォークします。
フォークのクローンを作成する: フォークのクローンをローカルマシンに作成し、開発環境をセットアップします。
新しいブランチの作成: 新しい git ブランチに変更を加えます。
変更をコミット: 明確で説明的なコミットメッセージを使用して変更をコミットします。
変更をプッシュする: 変更を GitHub のフォークにプッシュします。
プルリクエストを送信する: リポジトリのメインブランチに対してプルリクエストを開きます。変更の明確な説明と、あなたの貢献を理解するのに役立つその他の情報を提供してください。

詳細については、貢献ガイドラインを確認してください (可能な場合は、詳細な貢献ガイドラインへのリンク)。

私たちは、活発な貢献者のコミュニティとともに強力なデータ解析ツールを構築できることを楽しみにしています。

使用法

基本的な解析

単純なスキーマ定義を使用してデータ型を定義および検証します。

    use function Zec  Utils  z ;
    $ my_schema = z ()-> string ();
    
    $ response_valid = $ my_schema -> parse ( " Hello, World! " ); // Returns Zec data object
    $ value = $ response_valid -> value ; // Returns "Hello, World!"

    $ response_invalid = $ my_schema -> parse ( 123 ); // Returns Zec data object
    $ errors = $ response_invalid -> errors ; // Returns an array of ZecError object an exception extends class

検証

解析後にデータを迅速に検証します。

    $ is_valid = $ my_schema -> parse ( " Hello, World! " )-> isValid (); // Returns true
    $ is_invalid = $ my_schema -> parse ( 123 )-> isValid (); // Returns false

解析による例外処理

重要なデータ検証のために parse_or_throw を使用して例外を処理します。

    try {
        $ response = $ my_schema -> parseOrThrow ( 123 ); // Throws ZecError
    } catch ( ZecError $ error ) {
        $ error_message = $ error -> message ; // Returns "Invalid type: expected string, received integer"
        $ error -> log (); // Logs the error
    }

オプションの配列の解析

追加の検証オプションを組み込むことで、スキーマ定義を拡張できます。これにより、特定の要件に基づいてデータの適合性をより詳細に制御できるようになります。

    use function Zec  z ;

    $ user_schema = z ()-> options ([
        ' name ' => z ()-> string ()-> min ( 3 )-> max ( 50 ),
        ' email ' => z ()-> email (),
        ' age ' => z ()-> number ()-> min ( 18 ),
        ' isActive ' => z ()-> boolean (),
        ' registrationDate ' => z ()-> date ()
    ]);

    // Parsing a valid user object
    $ valid_user = $ user_schema -> parse ([
        ' name ' => ' John Doe ' ,
        ' email ' => ' [email protected] ' ,
        ' age ' => 30 ,
        ' isActive ' => true ,
        ' registrationDate ' => ' 2021-01-01 '
    ]);

    // Parsing an invalid user object
    $ invalid_user = $ user_schema -> parse ([
        ' name ' => ' JD ' , // Too short
        ' email ' => ' john.doe@ ' , // Invalid email format
        ' age ' => 17 , // Below minimum age requirement
        ' isActive ' => ' yes ' , // Incorrect type (should be boolean)
        ' registrationDate ' => ' 01-01-2021 ' // Wrong date format
    ]);

    // Handling validation results
    if ( $ valid_user -> isValid ()) {
        echo ' User is valid. ' ;
    } else {
        echo ' User is invalid. Errors: ' ;
        var_dump ( $ valid_user -> errors ());
    }

    if ( $ invalid_user -> isValid ()) {
        echo ' User is valid. ' ;
    } else {
        echo ' User is invalid. Errors: ' ;
        var_dump ( $ invalid_user -> errors ());
    }

高度なパーサー構成

このライブラリはデータ検証のための広範な構成機能を提供し、ユーザーがカスタムメッセージと条件を使用して複雑な検証ルールを定義できるようにします。以下は、特定の検証ルールを使用して電子メールフィールドの詳細なスキーマを構成する方法の例です。

    use function Zec  z ;

    // Define a configurable email schema
    $ my_configurable_email_schema = z ()-> string ([
        ' message ' => ' Invalid string data '
    ])-> min ([
        ' min ' => 3 ,
        ' message ' => ' String data must be at least 3 characters long ' // Custom message
    ])-> max ([
        ' max ' => 10 ,
        ' message ' => ' String {{value}} must be at most ((max)) characters long ' // Custom message with value interpolation
    ]). email ([
        ' message ' => ' Invalid email ' ,
        ' domain ' => [ ' gmail.com ' , ' yahoo.com ' ] // Custom domain validation rules
    ]);

    // Define a user schema using the configurable email schema
    $ my_user = z ()-> options ([
        ' email ' => $ my_configurable_email_schema -> required ()
    ]);

複雑な例: ユーザーデータの検証

この例では、ネストされた配列、オプションのフィールド、および共用体型を含むユーザーデータ構造を検証する方法を示し、複雑で現実的なデータモデルを処理するライブラリの機能を示します。

    use function Zec  z ;

    // Define a user schema with various data validation rules
    $ user_parser = z ()-> options ([
        ' name ' => z ()-> required ()-> string ()-> min ( 3 )-> max ( 50 ),
        ' email ' => z ()-> url ([
            ' message ' => ' Invalid email address ' , 
            ' domain ' => [ ' gmail.com ' ]
        ]),
        ' age ' => z ()-> number (),
        ' friends ' => z ()-> each (
            function ( $ user ) {
                return $ user -> nullable ();
            } // Each friend is a user object (nullable)
        ),
        ' password ' => z ()-> optional ()-> options ([
            ' password ' => z ()-> string (),  // Path: 'password.password'
            ' confirm_password ' => z ()-> string (),
            ' created_at ' => z ()-> date (),
        ]),
        ' created_at ' => z ()-> date (),
        ' updated_at ' => z ()-> date (),
        ' document ' => z ()-> union ([
            z ()-> options ([
                ' type ' => z ()-> enum ([ ' student ' ]),
                ' content ' => z ()-> options ([
                    ' school ' => z ()-> string (),
                    ' grade ' => z ()-> number (),
                ]),
            ]),
            z ()-> options ([
                ' type ' => z ()-> enum ([ ' teacher ' ]),
                ' content ' => z ()-> options ([
                    ' school ' => z ()-> string (),
                    ' subject ' => z ()-> string (),
                ]),
            ]),
        ]) // Union type for document, can be student or teacher document
    ]);

    // Parse a valid user object
    $ user = $ user_parser -> parse ([
        ' name ' => ' John Doe ' ,
        ' email ' => ' [email protected] ' ,
        ' age ' => 25 ,
        ' friends ' => [
            [
                ' name ' => ' Jane Doe ' ,
                ' email ' => ' [email protected] ' ,
                ' age ' => 30 ,
            ],
        ],
        ' password ' => [
            ' password ' => ' password ' ,
            ' confirm_password ' => ' password ' ,
            ' created_at ' => ' 2021-10-10 '
        ],
        ' created_at ' => ' 2021-10-10 ' ,
        ' updated_at ' => ' 2021-10-10 ' ,
        ' document ' => [
            ' type ' => ' student ' ,
            ' content ' => [
                ' school ' => ' School ' ,
                ' grade ' => 10 ,
            ]
        ]
    ]); // Returns a Zec object

    // Validate the parsed data
    if ( $ user -> isValid ()) {
        echo ' User is valid. ' ;
        var_dump ( $ user -> getValue ()); // Outputs the validated data
    } else {
        echo ' User is invalid. ' ;
        var_dump ( $ user -> errors ()); // Outputs validation errors
    }

カスタムパーサーメソッドの作成

柔軟性を高め、特定の検証ニーズに応えるために、ライブラリではユーザーがカスタムパーサーメソッドを定義できるようにしています。このセクションでは、配列のサイズ、文字列の長さ、または数値の値が特定の要件を満たしていることを検証するsizeパーサーメソッドを作成する方法を説明します。

sizeメソッドは次のことを確認します。

配列の長さは指定されたサイズと等しくなります。
文字列の長さは、指定された文字数と同じになります。
数値は、指定された数値と正確に等しくなります。

このカスタムパーサーを実装する方法は次のとおりです。

    use function Zec  z ;
    use function Zec  bundler ;
    use Zec  FIELD as FK ;

    $ custom_size_parser = parser_build ()
        -> name ( ' size ' )
        -> prioritize ( ' string ' , ' number ' , ' array ' ) // Prioritize the parser for string, number, and array types
        -> argument ( ' message ' , ' Invalid size ' , function ( Zec  Zec $ z ) {
            return $ z -> required ()-> string ();
        }) // argument for custom message, default is 'Invalid size'
        -> argument ( ' size ' , 0 , function ( Zec  Zec $ z ) {
            return $ z -> required ()-> number ();
        }) // argument for size, default is 0
        -> function ( function ( array $ args ): string | bool {
            $ value = $ args [ ' value ' ];
            $ expected_size = $ args [ ' size ' ];
            $ message = $ args [ ' message ' ];

            if ( is_array ( $ value )) {
                $ actual_size = count ( $ value );
            } elseif ( is_string ( $ value )) {
                $ actual_size = strlen ( $ value );
            } elseif ( is_numeric ( $ value )) {
                $ actual_size = $ value ;
            } else {
                return $ message ?? ' Invalid data type ' ;
            }

            if ( $ actual_size === $ expected_size ) {
                return true ;
            }
            return $ message ?? ' Invalid size ' ;
        })-> priority ( 4 ); // priority of the parser, the default priority of parser is 10, parser with 5 as priority will override before parser with 10 as priority if they have the same parser name
        -> build (); // Build the parser

    bundler-> addParser ( $ custom_size_parser );

スキーマ定義でカスタムsizeパーサーメソッドを使用できるようになりました。

    $ my_schema = z ()-> options ([
        ' username ' => z ()-> string ()-> size ( 5 ), // Username must be a string of length 5
        ' favorite_numbers ' => z ()-> array ()-> size ( 5 ), // Favorite numbers must be an array of length 5
        ' lucky_number ' => z ()-> number ()-> size ( 5 ), // Lucky number must be 5
    ]);

    $ user_data = [
        ' username ' => ' admin ' ,
        ' favorite_numbers ' => [ 1 , 2 , 3 , 4 , 5 ],
        ' lucky_number ' => 5
    ]; // Valid data

    $ parsed_data = $ my_schema -> parse ( $ user_data ); // Returns a Zec object

    // Validate the parsed data
    if ( $ parsed_data -> isValid ()) { // Returns true if data is valid
        echo ' All data is valid. ' ;
    } else {
        echo ' Data validation failed. Errors: ' ;
        var_dump ( $ parsed_data -> errors ()); // Outputs validation errors
    }

ライセンス

このプロジェクトは MIT ライセンスに基づいてライセンスされています。詳細については、LICENSE.md ファイルを参照してください。

MITライセンス

本ソフトウェアおよび関連ドキュメントファイル (以下「ソフトウェア」) のコピーを入手した人には、使用、コピー、変更、マージする権利を含むがこれらに限定されない、制限なくソフトウェアを取り扱う許可が、ここに無償で与えられます。、以下の条件を条件として、本ソフトウェアのコピーを出版、配布、サブライセンス、および/または販売すること、および本ソフトウェアが提供される人物にそれを許可すること。

上記の著作権表示およびこの許可通知は、ソフトウェアのすべてのコピーまたは主要部分に含まれるものとします。

ソフトウェアは「現状のまま」提供され、明示的か黙示的かを問わず、商品性、特定目的への適合性、および非侵害の保証を含むがこれらに限定されない、いかなる種類の保証も行われません。いかなる場合においても、作者または著作権所有者は、契約行為、不法行為、またはその他の行為であるかどうかにかかわらず、ソフトウェアまたはソフトウェアの使用またはその他の取引に起因または関連して生じる、いかなる請求、損害、またはその他の責任に対しても責任を負わないものとします。ソフトウェア。

拡大する

Zec Data Parsing

Zec: PHP データ解析ライブラリ

インストール

作曲家

要件

使用例

ユーザーデータ検証用のスキーマを定義する

ユーザーデータを解析して検証する

予想されるエラー応答

目次

その他の優れた点

コラボレーション

貢献方法

使用法

基本的な解析

検証

解析による例外処理

オプションの配列の解析

高度なパーサー構成

複雑な例: ユーザーデータの検証

カスタムパーサーメソッドの作成

ライセンス

MITライセンス

MMEarth data

Contoso Data Generator V2

EMIT Data Resources

data pump log analyzer

生物学的データマイニング

スマートデータリカバリ

chat.petals.dev

GPT Prompt Templates

GPTyped

termwind

wp functions

slugify

waymo open dataset

termwind

wp functions