fresh-advance/sitemap

OXID 7 Sitemap Module

v1.0.1 2024-05-14 18:29 UTC

Requires

• php: ^8.0
• codeception/codeception: ^5.0
• codeception/module-asserts: ^3.0
• codeception/module-db: ^3.0
• codeception/module-filesystem: ^3.0
• codeception/module-webdriver: ^3.1
• mikey179/vfsstream: ~1.6.8
• oxid-esales/codeception-modules: dev-b-7.0.x
• oxid-esales/codeception-page-objects: dev-b-7.0.x
• oxid-esales/oxideshop-ce: *

Requires (Dev)

• phpmd/phpmd: ^2.11
• phpstan/phpstan: ^1.8.10
• phpunit/phpunit: ^9.5
• squizlabs/php_codesniffer: 3.*

Conflicts

• oxid-esales/oxideshop-ce: <7.0.0-rc.2

proprietary

• Sitemap
• modules
• OXID

README

In development

The idea

There is a table (fa_sitemap) which will contain the list of all sitemap urls. Urls are updated and added during the "fa:sitemap:update" commands. The sitemap files are generated by "fa:sitemap:generate" command.

Features

• Selectors implemented for:
  • Active categories
  • Active products and its variants
  • Active content pages from 'User information' folder
  • Main page of the shop
• Removal of the urls by removal or deactivation of the related objects

Compatibility

• Branch b-7.0.x is compatible with OXID Shop compilation 7.0.0-rc.2 and up

Installation

Module is available on packagist. Install it via composer and activate the module

composer require fresh-advance/sitemap:^v1.0.0
vendor/bin/oe-console oe:module:activate fa_sitemap

Also consider adding the line to .htaccess file:

RewriteRule ^sitemap.xml$    sitemap/sitemap.xml   [NC,L]

Module usage

Note: directory for sitemap should exist and have enough rights for php to modify its content.

./vendor/bin/oe-console fa:sitemap:updateAll
./vendor/bin/oe-console fa:sitemap:generate

After the "generate" command, the sitemap index and sitemap pages will be generated in "source/sitemap" directory.

Note: Also its possible to update some concrete type of objects IF needed by some reason:

./vendor/bin/oe-console fa:sitemap:update general
./vendor/bin/oe-console fa:sitemap:update content
./vendor/bin/oe-console fa:sitemap:update category
./vendor/bin/oe-console fa:sitemap:update product

What to expect in next versions

• Sitemap access without modifying the .htaccess maybe
• Configurable sitemap directory
• Multilanguage support
• Multishop support
• Configurable step size for update run

License

The module is not free to use. Please make sure you checked the License before using the module.