https://github.com/brookinsconsulting/bcurlaliaswithdash
BC Url Alias With Dash is a simple eZ Publish Platform (Legacy) kernel override extension which overrides the default ezchartransform class to provide a simple feature it allows all content urls to be separated by a dash character rather than the default underscor character.
https://github.com/brookinsconsulting/bcurlaliaswithdash
dash ezpublish ezpublishlegacy kernel-override php underscore urlalias
Last synced: 12 months ago
JSON representation
BC Url Alias With Dash is a simple eZ Publish Platform (Legacy) kernel override extension which overrides the default ezchartransform class to provide a simple feature it allows all content urls to be separated by a dash character rather than the default underscor character.
- Host: GitHub
- URL: https://github.com/brookinsconsulting/bcurlaliaswithdash
- Owner: brookinsconsulting
- License: gpl-2.0
- Created: 2023-03-24T10:01:32.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-03-27T06:33:50.000Z (almost 3 years ago)
- Last Synced: 2025-01-26T11:27:50.529Z (about 1 year ago)
- Topics: dash, ezpublish, ezpublishlegacy, kernel-override, php, underscore, urlalias
- Language: PHP
- Homepage:
- Size: 20.5 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
BC Url Alias With Dash
======================
This extension is a simple eZ Publish Platform (Legacy) kernel override extension which overrides the default ezchartransform class to provide a simple feature it allows all content urls to be separated by a dash character rather than the default underscor character. Great for advanced developers!
With this kernel class override installed and enabled you can finally use the dash character as a url separator character in all your content.
This is helpful and useful for distinguishing website from others with just the default urlalias_compat configuration using underscores in their urls.
Version
=======
* The current version of BC Url Alias With Dash is 0.1.1
* Last Major update: March 24, 2023
Copyright
=========
* BC Url Alias With Dash is copyright 1999 - 2023 Brookins Consulting and eZ Systems AS
* See: [COPYRIGHT.md](COPYRIGHT.md) for more information on the terms of the copyright and license
License
=======
BC Url Alias With Dash is licensed under the GNU General Public License.
The complete license agreement is included in the [LICENSE](LICENSE.md) file.
BC Url Alias With Dash is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License or at your
option a later version.
BC Url Alias With Dash is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
The GNU GPL gives you the right to use, modify and redistribute
BC Url Alias With Dash under certain conditions. The GNU GPL license
is distributed with the software, see the file LICENSE.
It is also available at [http://www.gnu.org/licenses/gpl.txt](http://www.gnu.org/licenses/gpl.txt)
You should have received a copy of the GNU General Public License
along with BC Url Alias With Dash in LICENSE.
If not, see [http://www.gnu.org/licenses/](http://www.gnu.org/licenses/).
Using BC Url Alias With Dash under the terms of the GNU GPL is free (as in freedom).
For more information or questions please contact: license@brookinsconsulting.com
Requirements
============
The following requirements exists for using BC Url Alias With Dash extension:
### eZ Publish version
* Make sure you use eZ Publish version 5.x (required) or higher.
* Designed and tested with eZ Publish Legacy 5.99alpha1
### PHP version
* Make sure you have PHP 5.x or higher.
Features
========
This solution provides the following features:
* Kernel Module Class Override Class: eZCharTransform
### Dependencies
* This solution depends on eZ Publish Legacy and kernel class overrides enabled in config.php
### Kernel class override
This solution overrides the following kernel class:
* PHP Class : `eZCharTransform` - Found by default at: `lib/ezutils/classes/ezchartransform.php`
This solution provides the following kernel class override:
* PHP Class : `eZCharTransform` - Found by at: `extension/bcurlaliaswithdash/classes/kerneloverride/v2023.03.24/lib/ezutils/classes/ezchartransform.php`
**Note**: This solution requires only one legacy kernel class override of a class that is very stable and not subject to much change (if at all) per release (which is important for maintainability). The class has not been modified or [needed a bugfix since early 2017](https://github.com/ezsystems/ezpublish-legacy/blob/master/lib/ezutils/classes/ezchartransform.php).
Installation
============
### Bundle Installation via Composer
Run the following command from your project root to install the bundle:
bash$ composer require brookinsconsulting/bcurlaliaswithdash dev-master;
### Extension Activation
Optional. Activate this extension by adding the following to your `settings/override/site.ini.append.php`:
[ExtensionSettings]
#
ActiveExtensions[]=bcurlaliaswithdash
Kernel class override extensions are **not** activated via ini settings. Normal site.ini extension activation settings are not required to use this extension and it's solution.
### Enable eZ Publish Kernel Overrides
Kernel class overrides are only able to be used if you add the following to your eZ Publish Legacy config.php configuration file.
cp -va config.php-RECOMMENDED config.php;
# Edit config.php to set 'EZP_AUTOLOAD_ALLOW_KERNEL_OVERRIDE' to true. It should look like this:
define( 'EZP_AUTOLOAD_ALLOW_KERNEL_OVERRIDE', true );
### Regenerate kernel class override autoloads
Regenerate kernel class override autoloads (Required).
php ./bin/php/ezpgenerateautoloads.php --kernel-override;
### Clear the caches
Optional. Clear eZ Publish Platform / eZ Publish Legacy caches (Required).
php ./bin/php/ezcache.php --clear-all;
Usage
=====
The solution is configured to work virtually by default once properly installed.
Note: Once installed. Clear caches and run the bin/php/updateniceurls.php script to convert to urls with dash separators.
Note: This solution depends on the setting, '[URLTranslator] TransformationGroup=urlalias_compat' in site.ini.append.php
Note: In some installations after runing the above script republishing of all nodes in content tree was required. This was done via the admin in less than 10min.
Troubleshooting
===============
### Read the FAQ
Some problems are more common than others. The most common ones are listed in the the [doc/FAQ.md](doc/FAQ.md)
### Support
If you have find any problems not handled by this document or the FAQ you can contact Brookins Consulting through the support system: [http://brookinsconsulting.com/contact](http://brookinsconsulting.com/contact)