Meter Laravel Package

Getting Started

Install the package via Composer: composer require vendor/package. If the package provides configuration, publish it with php artisan vendor:publish --provider="Vendor\Package\ServiceProvider" --tag="config". The primary entry point is usually a facade or helper function—check the package’s README for the exact class name (e.g., Matcher::match($pattern, $subject)). As of 1.3.0, you can now pass an array of strings to ignore from the matched results. Look for an ignore() method or an ignored_matches key in the config file. A first practical use case: filtering user-generated content for banned words while ignoring false positives (e.g., searching for “ass” but ignoring “class” and “grass”).

Implementation Patterns

• Chaining with ignore: Matcher::pattern('...')->ignore(['foo', 'bar'])->match($text) – the new option lets you exclude specific strings from the returned matches without post-processing.
• Config‑driven ignore list: add default ignored strings under 'ignored_matches' in config/matcher.php so they apply globally across your application.
• Eloquent integration: use the matcher inside accessors, query scopes, or observers to sanitize search results. For example, when building a “find similar” feature, ignore common stop words or already‑known matches.
• Batch processing: when matching many strings in a loop, set the ignore list once on a reusable matcher instance rather than reconstructing it each time.
• Workflow tip: combine the ignore option with logging to audit which matches were suppressed—useful for tuning your ignore list over time.

Gotchas and Tips

• Case sensitivity: the ignore comparison may be case‑sensitive by default. Check for a caseSensitive flag or normalise your ignore strings before passing them.
• Regex vs. literal: if the matcher supports regex patterns, ensure ignore strings are treated as literals unless you explicitly want pattern‑based ignoring. Test with strings containing ., *, etc.
• Performance: a large ignore list can slow down matching. Consider caching the list or using a hash set if the package exposes such an option.
• Debugging: use ->getMatches() or similar to inspect which strings were ignored versus actually matched. Enable debug logging if available.
• Config caching: after editing the ignore list in config, run php artisan config:clear (or config:cache in production) to pick up changes.
• Extension points: many matchers allow custom callbacks or macros. If you need dynamic ignore logic (e.g., based on user role), check whether you can bind a custom implementation or use a closure.