Repository navigation
docs: architecture overview + installation & usage guide - #13
Merged
Merged
Conversation
…egration guide Replace the outdated README stub (which claimed Symfony 3.4/4.0 support) with a grounded architecture overview plus Installation and Usage sections, and rewrite src/Resources/doc/index.md as a complete integration guide: config/bundles.php registration, required-signature config, the mandatory confirm/return routes, the outbound payment flow (auto-submit form), and the inbound IPN handling flow. Documents the IPN handler and payment-input/config hardening now on main (PR #12).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documentation-only PR. Rewrites the two docs to reflect the current bundle (PHP 8.3+, the IPN handler, and the config/input hardening already merged via #12). Every claim was grounded by reading the actual
src/,composer.json,phpunit.xml.dist, and.github/workflows/ci.yml.README.md— replaces the outdated stub (which claimed "Symfony 3.4 / 4.0" support) with:netopia_mobilpay.configuration→…payment/…ipn_handler), outbound/inbound flows, security model, project layout, testing & CI.composer require,config/bundles.phpregistration,netopia_mobilpay.yaml(signature required; cert/key as path or inline PEM), and the two mandatory route names (netopia_mobilpay_confirm_url/netopia_mobilpay_return_url).createCreditCardPaymentObject(...)+ auto-submit Twig form, and inbounddecrypt()→ verify →confirmResponse()/errorResponse().src/Resources/doc/index.md— rewritten as the full integration guide:config/bundles.phpregistration (was legacyAppKernel::registerBundles()).app/config/parameters.ymlblock./card4) + SMS notes, input-validation note.IpnResultfield/predicate reference; PCI scope note.Test Plan
composer.json,Configuration.php(signature required),NetopiaMobilPayConfiguration(route consts, cert/key path-or-PEM,resolvePaymentUrl),NetopiaMobilPayService(validation,getEnvKey/getEncData/getCipher/getIvviagetMobilPayConfiguration()),Notification/*(IPN),services.yaml,phpunit.xml.dist,ci.yml.env_key/data/cipher/ivform field names match your Netopia account's expected POST fields.