cyrildewit/eloquent-viewable

See the upgrade guide for detailed migration instructions.

Added

• Added native type declarations across the public API

Changed

• Raised the minimum PHP version to ^8.5
• The Views contract now declares the existing useVisitor() method (breaking only for classes that implement Contracts\Views directly)
• Changed the cooldown() and remember() parameters on the Views contract to be typed DateTimeInterface|int|null
• Changed the scopeWithinPeriod() method on the View contract to declare a void return type
• Narrowed Period::getStartDateTime()/getEndDateTime() to return ?CarbonInterface
• Marked the InvalidPeriod and ViewRecordException exceptions as final (breaking only for code that extends them)
• The Viewable contract now uses @mixin \Illuminate\Database\Eloquent\Model instead of redeclaring the getKey() and getMorphClass() methods
• The View contract now uses @mixin \Illuminate\Database\Eloquent\Model and declares the existing scopeCollection() method (breaking only for classes that implement Contracts\View directly)
• Modernized the create_views_table migration stub (typed properties and return types)
• Changed the visitor column in the create_views_table migration stub from text to string (VARCHAR(255)) so it can be indexed directly (only affects newly published migrations)
• Changed the default config models.view.connection and cache.store to null, so they now defer to the application's default database connection and cache store instead of reading env('DB_CONNECTION') and the deprecated env('CACHE_DRIVER') (only affects newly published config)
• Migrated the test suite from PHPUnit to Pest (development only; no impact on consumers)
• Redesigned Period as a final, immutable (readonly) value object; relative periods are now built with the new Support\PeriodInterval and Support\PeriodAnchor enums, and date parsing defers to Carbon::make() (the factory methods, getStartDateTime()/getEndDateTime(), and the cache-key format are unchanged)

Removed

• Dropped support for Laravel 6 through 12 (illuminate/* now requires ^13.0)
• Dropped support for Carbon 2 (nesbot/carbon now requires ^3.0)
• Removed the getStartDateTimeString(), getEndDateTimeString(), getStartDateTimestamp() and getEndDateTimestamp() getters from Period
• Removed the Period::PAST_* and Period::SUB_* constants and the sub(), subToday() and subNow() static helpers
• Removed the Period::getSubType(), getSubValue(), hasFixedDateTimes(), setStartDateTime(), setEndDateTime(), setFixedDateTimes(), setSubType() and setSubValue() methods (Period is now immutable)

What's Changed

Fixed

• Fixed cooldown pruning when the session uses JSON serialization, where expires_at is restored as a string instead of a Carbon instance (#326)

New Contributors

• @dipesh79 made their first contribution in #326

Full Changelog: v7.1.0...v7.1.1

Changed

• Add support for Laravel 13

What's Changed

• Implicitly marking parameter $collection as nullable is deprecated, the explicit nullable type must be used instead. by @mstnorris in #314

New Contributors

• @mstnorris made their first contribution in #314

Full Changelog: v7.0.5...v7.0.6

What's Changed

• refactor: fix deprecation warning. by @mikebronner in #312
• chore(ci-deps): bump codecov/codecov-action from 1 to 5 by @dependabot in #310

New Contributors

• @mikebronner made their first contribution in #312

Full Changelog: v7.0.4...v7.0.5

Changed

• Support Laravel 12 by @bosunski in #302

New Contributors

• @bosunski made their first contribution in #302

Full Changelog: v7.0.3...v7.0.4

Fixed

• Allow Carbon v3 by @cyrildewit in #299

Full Changelog: v7.0.2...v7.0.3

What's Changed

• Laravel 11 support by @janyksteenbeek in #295
• Laravel 11 support - Allow phpunit ^10.0 as dev dependency by @cyrildewit in #297

New Contributors

• @janyksteenbeek made their first contribution in #295

Full Changelog: v7.0.1...v7.0.2

What's Changed

• Fix CONTRIBUTING.md fix a typo in the phpunit run example by @kudashevs in #269
• Update run-tests.yml by @kudashevs in #270
• fixed deprecated variable in string by @Mahmoud217TR in #280
• [upgrade] Add Laravel 10 support by @cstriuli in #282
• Fix/failing tests Laravel 10 by @blackjak231 in #287

New Contributors

• @kudashevs made their first contribution in #269
• @Mahmoud217TR made their first contribution in #280
• @cstriuli made their first contribution in #282
• @blackjak231 made their first contribution in #287

Full Changelog: v6.1.0...v7.0.1

Changed

• Add support for Laravel 9 (@atmonshi)

Changed

• Add support for Laravel 8

Fixed

• Update required dependencies in composer.json to adhere to new Laravel 6 version scheme

Changed

• Add support for Laravel 6

Added

• Added SortDirection enum class that contains a DESCENDING and ASCENDING constant
• Added OrderByViewsScope class that can order a query by views based on some options
• Added collection($collection) query scope to View model
• Added the ability to pass a collection to the orderByViews and orderByUniqueViews query scope
• Added a new CacheKey class with a new improved approach to making keys for the cache
• Added getStartDateTimestamp and getEndDateTimestamp methods to the Period class for internal use
• Added string $collection = null argument to push, createNamespaceKey and createViewableKey methods in ViewSessionHistory

Deprecated

• Deprecated the overrideIpAddress method of the Views class. Please use the new useIpAddress(string $address) method instead.
• Deprecated the overrideVisitor method of the Views class. Please use the new useVisitor(string $visitor) method instead.

Changed

• Replaced inner code of the orderByViews and orderByUniqueViews query scope with the new OrderByViewsScope class
• Removed the string type declaration from the getTable method in the View model class #165

Removed

• Removed the Support\Key class with its references

Added

• Add support for Laravel 5.8

Changed

• Use String and Array classes instead of the helper functions

Fixed

• Fixed the ability to pass an integer to the delayInSession method without getting an error
• Type cast the cached views count otherwise PHP's type hint will fail

Added

• Added the ability to override the visitor's unique ID that's used to distinguish unique views
• Added the ability to specify a cache store that should be used by this package

Fixed

• The method delayInSession isn't working properly

Fixed

• Publishing package migrations results in error (#133)

Added

• Added Views class with facade
• Added IpAddressResolver contract with implementation
• Added HeaderResolver contract with implementation
• Added VisitorCookieRepository class
• Added global helper views
• Added collection column to views table schema
• Added withinPeriod scope to View model
• Added uniqueVisitor scope to View model

Changed

• Bumped minimum required PHP version to ^7.1
• Require viewable models to implement the Viewable contract
• Added global views() helper
• Remove IP address as fallback for visitor cookie when it doesn't exists
• Changed the isBot method name to isCrawler in CrawlerDetector contract and updated the CrawlerDetectAdapter
• Changed the visibility of the $detector property from protected to private
• Add support for 5.7.* of illuminate/config to composer.json
• Moved config file from publishable/config to config/
• Replace create_views_table stub with real migration file and load it inside the service provider
• Allow strings to be passed to the constructor of the Period class
• Extracted key generation logic from Period class to the Key class

Removed

• Removed the ViewTracker class
• Removed the ViewableService class
• Removed the ProcessView job
• Removed the update_views_table migration file from resources/database/migrations
• Removed illuminate/bus as dependency
• Removed illuminate/queue as dependency
• Removed illuminate/routing as dependency

Fixed

• orderByViewsCount scope doesn't adhere to connection prefix

Fixed

• Data too long for column visitor

Fixed

• ProcessView job is always failing

Fixed

• View is saved before ProcessViews job is ran

Changed

• Add support for Laravel 5.7

Deprecated

• Deprecated the CyrildeWit\Support\IpAddress class
• Deprecated the CyrildeWit\Viewtracker class
• Deprecated the scopeOrderByViewsCount method in the Viewable trait
• Deprecated the scopeOrderByUniqueViewsCount method in the Viewable trait

Added

• Add orderByUniqueViewsCount scope to Viewable trait

Added

• Add the ability to add a delay between views from the same session (#73)

Changed

• Caching is now turned off as default

This release accidentally contains no updates.

This major version contains some serious breaking changes! See the upgrade guide for more information!

Added

• Added visitor column to the create_views_table migration stub

Changed

• Changed the package name from cyrildewit/laravel-page-view-counter to cyrildewit/eloquent-viewable
• Renamed the HasPageViewCounter trait to Viewable
• Renamed the PageViewCounterServiceProvider class to EloquentViewableServiceProvider
• Changed the namespace from CyrildeWit\PageViewCounter\xxx to 'CyrildeWit\EloquentViewable'
• Added new options to the config file and changed the structure
• Replaced the addPageView method with addView in the Viewable trait
• Replaced all getPageViews<suffix> methods with getViews in the Viewable trait

Removed

• Removed the addPageViewThatExpiresAt method from the Viewable trait
• The DateTransformer functionality has been removed