[GitHub/WoltLab/WCF.git] / CHANGELOG.md

# Changelog

## 2.2 (Vortex)

### 2.2.0 Alpha 1 (XXXX-YY-ZZ)

* Clipboard support for tags in ACP ("delete" and "set as synonyms").
* `wcf\data\user\UserProfileCache` for caching user profiles during runtime.
* `wcf\system\cache\builder\EventListenerCacheBuilder` returns `wcf\data\event\listener\EventListener` objects instead of data arrays.
* `wcf\system\cache\source\RedisCacheSource` added.
* Background queue (`wcf\system\background\*`) added.
* Rewritten email system (`wcf\system\email\*`) added.
* CryptoUtil (`wcf\util\CryptoUtil`) added.
* Old email system (`wcf\system\mail\*`) deprecated.
* Abstract bulk processing system added.
* Replaced old user bulk processing with new implementation using the abstract bulk processing system.
* `conditionContainers` template event in template `noticeAdd.tpl` added.
* Use condition system for user search.
* Image proxy for images included with the image BBCode.
* Overhauled Redactor integration
	* Linebreaks mode instead of using paragraphs, works better with the PHP-side parser which works with linebreaks
	* Ported the PHP-BBCode parser, massively improves accuracy and ensures validity
* Show error message if poll options are given but not question instead of discarding poll options.
* `parentObjectID` column added to `modification_log` and `wcf\system\log\modification\AbstractModificationLogHandler` introduced as a replacement for `wcf\system\log\modification\ModificationLogHandler`.
* Add sort support for `useroptions` option type.
* Make user options shown in sidebar sortable.
* `wcf\system\event\listener\AbstractUserActionRenameListener` added.
* `wcf\system\event\listener\AbstractUserMergeListener` added.
* Notice texts support `{$username}` and `{$email}` placeholders.
* Notifications for comments in moderation.
* Continuous numeration of edit history version in template.
* `\wcf\data\user\UserProfile::getGuestUserProfile()` added.
* Make labels sortable in ACP.
* Core object `wcf\system\search\SearchEngine` added.
* Added 'most online users' to statistics box.
* Added icon size 64
* Enhanced user ignore feature
* Removed delayed redirect from login/logout
* `appendSession` in LinkHandler is now deprecated
* Added cover photo in user profiles
* Using cookies for ACP sessions
* WCF is now a standalone app
* Overhauled redactor integration
* Overhauled bbcode/html handling
* Removed option import/export
* Overhauled style editor
* Added replacements for WCF.Like, WCF.User.List and $.ui.wcfPages
* Added update support for styles
* `\wcf\system\condition\MultiPageControllerCondition` has been replaced by `wcf\system\condition\page\MultiPageCondition`
* Added special CSS class to cookie policy notice (`cookiePolicyNotice`)
* Improved confirmation messages (`<span class="confirmationObject">...</span>`)

#### CMS

* Introduced new page, menu, box and media management system.
* Replaced object type definition `com.woltlab.wcf.page` with new CMS pages.
* Replaced header/footer menu with new CMS menus.
* Replaced dashboard box system with new CMS box system.
* User online location is handled via the `wcf\data\page\Page` objects. Complex locations can use the online location-related methods of `wcf\system\page\handler\IMenuPageHandler`.
* Added page-relevant data-attributes on body tag (`data-page-id`, `data-page-identifier`).

#### New Traits

* `wcf\data\TDatabaseObjectOptions` for database object-bound options validation.
* `wcf\data\TDatabaseObjectPermissions` for database object-bound permissions validation.
* `wcf\data\TMultiCategoryObject` provides category-related methods for objects with multiple categories.
* `wcf\data\TUserContent` provides default implementations of the (non-inherited) methods of the IUserContent interface.

#### Package Installation Plugin Improvements

* instruction file name for most PIPs has default value provided by `wcf\system\package\plugin\IPackageInstallationPlugin::getDefaultFilename()`.
* `options` support for cronjob PIP.
* `name` attribute for cronjob PIP (`cronjobName` for cronjob objects).
* `eventName` of event listener PIP supports multiple events.
* `permissions` and `options` support for event listener PIP.
* `name` attribute for event listener PIP (`listenerName` for event listener objects).
* `permissions` and `options` support for template listener PIP.
* file `{WCF_DIR}/acp/uninstall/{packageName}.php` is automatically executed if package is uninstalled right before the first file PIP is executed

#### Template / Design Overhaul

* Overhauled header/footer templates
* Overhauled message templates/styling
* Overhauled search area in page header
* Overhauled user profile header
* Overhauled media queries
* Overhauled user login
* Overhauled exception view
* Redesigned ACP login

* Introduced sticky page header
* Replaced LESS with SCSS
* Removed collapsible sidebar
* Removed obsolete CSS classes `framed`, `containerPadding`, `dividers`, `badgeInverse`
* Replaced `.infoBoxList` boxes with `.footerBoxes`
* Replaced `<fieldset>` tags with `<section class="section">`
* Replaced `<legend>` tags with `<h2 class="sectionTitle">`
* Replaced `.container`/`.marginTop` with `.section`
* Replaced `.boxHeadline` with `.contentHeader`
* Replaced `.boxSubHeadline` with `.sectionTitle`
* Replaced `.sidebarNavigation` with `.boxMenu`
* Replaced deprecated icon class (`icon-*` => `fa-*`)
* Moved closing head / body tags into `footer` template
* Moved documentHeader, head, body, contentHeader, userNotice into `header` template
* Replaced `$sidebarOrientation` with `$sidebarLeft`/`$sidebarRight`
* Renamed `{event name='*fieldsets'}` to `{event name='*sections'}`
* Introduced `.separatorLeft`/`.separatorRight`
* Removed `.tabularBoxTitle` if table title and page tite are identical
* Moved the "No-JS"-Warning to footer template.
* Tables can now be horizontally scrolled on mobile
* Added mobile support for ACP
* Added basic grid layout classes
* Renamed `.pageNavigation` to `.pagination`
* Renamed `.navigation`/`.navigationIcons` to `.pageNavigation`/`.pageNavigationIcons`
* Added CSS classes to style font sizes in tag cloud (`tagWeight1` - `tagWeight7`)

#### Deprecated Code

* Object type definition `com.woltlab.wcf.user.online.location` deprecated.
* Object type definition `com.woltlab.wcf.page` deprecated.

#### Removed Code

* `wcf\system\clipboard\action\UserExtendedClipboardAction` removed.
* `wcf\system\event\listener\PreParserAtUserListener` removed.
* `wcf\action\AJAXProxyAction::getData()` removed.
* `wcf\system\page\PageManager` removed.
* `wcf\system\option\PageMultiSelectOptionType` removed.
* `wcf\system\option\PageSelectOptionType` removed.
* `wcf\system\user\online\location\UserLocation` removed.
* Version system removed.
* Support for query string based sessions in Frontend removed.
* Language server system removed.
* Deprecated methods in `wcf\util\StringUtil` removed.
* Option `message_sidebar_enable_message_group_starter_icon` removed.
* Option `module_privacy_policy_page` removed.
* Option `show_clock` removed.
* Option `message_sidebar_enable_rank` removed.
* Option `message_sidebar_enable_avatar` removed.
* Removed obsolete `$activeMenuItem` in frontend forms/pages

#### Documentation

* Added missing and fixed existing PHPDoc comments.
* `@property-read` tags for database table columns of classes extending `wcf\data\DatabaseObject`.
* `@method` tags for classes extending `wcf\data\AbstractDatabaseObjectAction` to specify return types.
* `@mixin` tag for classes extending `wcf\data\DatabaseObjectDecorator` for autocompletion/recognition of properties and methods of the decorated object.
* `@method` tag for classes extending `wcf\data\DatabaseObjectEditor` to specify return type.
* `@method` and `@property` tags for classes extending `wcf\data\DatabaseObjectList` to specify (return) types.
* `@property` tag for classes extending `wcf\page\MultipleLinkPage` to specify type.
* `@mixin` tag for classes extending `wcf\system\database\statement\PreparedStatement` for autocompletion/recognition of properties and methods of the decorated `\PDOStatement` object.
* `@method` tags for `wcf\system\io\File` and `wcf\system\io\GZipFile` for autocompletion/recognition of methods called via `__call()`.
Commit	Line	Data
77eea9a2 MS	1	# Changelog
	2
	3	## 2.2 (Vortex)
	4
	5	### 2.2.0 Alpha 1 (XXXX-YY-ZZ)
	6
ea3185a0	7	* Clipboard support for tags in ACP ("delete" and "set as synonyms").
3b5fb8ef	8	* `wcf\data\user\UserProfileCache` for caching user profiles during runtime.
77eea9a2	9	* `wcf\system\cache\builder\EventListenerCacheBuilder` returns `wcf\data\event\listener\EventListener` objects instead of data arrays.
8b77f574	10	* `wcf\system\cache\source\RedisCacheSource` added.
28f2c3b1	11	* Background queue (`wcf\system\background\*`) added.
652ab955	12	* Rewritten email system (`wcf\system\email\*`) added.
6cc54f29	13	* CryptoUtil (`wcf\util\CryptoUtil`) added.
652ab955	14	* Old email system (`wcf\system\mail\*`) deprecated.
36c34e9a MS	15	* Abstract bulk processing system added.
36c34e9a MS	16	* Replaced old user bulk processing with new implementation using the abstract bulk processing system.
47124303	17	* `conditionContainers` template event in template `noticeAdd.tpl` added.
a5f8fd9f	18	* Use condition system for user search.
e934d809	19	* Image proxy for images included with the image BBCode.
0560ab7d AE	20	* Overhauled Redactor integration
0560ab7d AE	21	* Linebreaks mode instead of using paragraphs, works better with the PHP-side parser which works with linebreaks
6cc54f29	22	* Ported the PHP-BBCode parser, massively improves accuracy and ensures validity
b2ae2a7b	23	* Show error message if poll options are given but not question instead of discarding poll options.
28854f57	24	* `parentObjectID` column added to `modification_log` and `wcf\system\log\modification\AbstractModificationLogHandler` introduced as a replacement for `wcf\system\log\modification\ModificationLogHandler`.
5c2a59e7 MS	25	* Add sort support for `useroptions` option type.
5c2a59e7 MS	26	* Make user options shown in sidebar sortable.
b896f69d MS	27	* `wcf\system\event\listener\AbstractUserActionRenameListener` added.
b896f69d MS	28	* `wcf\system\event\listener\AbstractUserMergeListener` added.
406e0d01	29	* Notice texts support `{$username}` and `{$email}` placeholders.
ce207cd8	30	* Notifications for comments in moderation.
5266fbf1 MS	31	* Continuous numeration of edit history version in template.
5266fbf1 MS	32	* `\wcf\data\user\UserProfile::getGuestUserProfile()` added.
d8475f48	33	* Make labels sortable in ACP.
7fb9ac68 MW	34	* Core object `wcf\system\search\SearchEngine` added.
	35	* Added 'most online users' to statistics box.
	36	* Added icon size 64
	37	* Enhanced user ignore feature
	38	* Removed delayed redirect from login/logout
	39	* `appendSession` in LinkHandler is now deprecated
	40	* Added cover photo in user profiles
	41	* Using cookies for ACP sessions
	42	* WCF is now a standalone app
	43	* Overhauled redactor integration
	44	* Overhauled bbcode/html handling
	45	* Removed option import/export
	46	* Overhauled style editor
	47	* Added replacements for WCF.Like, WCF.User.List and $.ui.wcfPages
	48	* Added update support for styles
b2782e46	49	* `\wcf\system\condition\MultiPageControllerCondition` has been replaced by `wcf\system\condition\page\MultiPageCondition`
a75f9dca	50	* Added special CSS class to cookie policy notice (`cookiePolicyNotice`)
f2ef8351	51	* Improved confirmation messages (`<span class="confirmationObject">...</span>`)
9785f7b8	52
cccad2a0 MS	53	#### CMS
cccad2a0 MS	54
7fb9ac68 MW	55	* Introduced new page, menu, box and media management system.
	56	* Replaced object type definition `com.woltlab.wcf.page` with new CMS pages.
	57	* Replaced header/footer menu with new CMS menus.
	58	* Replaced dashboard box system with new CMS box system.
ced41de9	59	* User online location is handled via the `wcf\data\page\Page` objects. Complex locations can use the online location-related methods of `wcf\system\page\handler\IMenuPageHandler`.
7fb9ac68	60	* Added page-relevant data-attributes on body tag (`data-page-id`, `data-page-identifier`).
cccad2a0	61
9785f7b8 MS	62	#### New Traits
	63
	64	* `wcf\data\TDatabaseObjectOptions` for database object-bound options validation.
8ef9a6b6	65	* `wcf\data\TDatabaseObjectPermissions` for database object-bound permissions validation.
9785f7b8 MS	66	* `wcf\data\TMultiCategoryObject` provides category-related methods for objects with multiple categories.
9785f7b8 MS	67	* `wcf\data\TUserContent` provides default implementations of the (non-inherited) methods of the IUserContent interface.
48e5f94e MS	68
	69	#### Package Installation Plugin Improvements
	70
	71	* instruction file name for most PIPs has default value provided by `wcf\system\package\plugin\IPackageInstallationPlugin::getDefaultFilename()`.
	72	* `options` support for cronjob PIP.
	73	* `name` attribute for cronjob PIP (`cronjobName` for cronjob objects).
	74	* `eventName` of event listener PIP supports multiple events.
	75	* `permissions` and `options` support for event listener PIP.
	76	* `name` attribute for event listener PIP (`listenerName` for event listener objects).
	77	* `permissions` and `options` support for template listener PIP.
24d20582	78	* file `{WCF_DIR}/acp/uninstall/{packageName}.php` is automatically executed if package is uninstalled right before the first file PIP is executed
48e5f94e	79
7fb9ac68 MW	80	#### Template / Design Overhaul
	81
	82	* Overhauled header/footer templates
	83	* Overhauled message templates/styling
	84	* Overhauled search area in page header
	85	* Overhauled user profile header
	86	* Overhauled media queries
	87	* Overhauled user login
	88	* Overhauled exception view
	89	* Redesigned ACP login
	90
	91	* Introduced sticky page header
	92	* Replaced LESS with SCSS
	93	* Removed collapsible sidebar
	94	* Removed obsolete CSS classes `framed`, `containerPadding`, `dividers`, `badgeInverse`
	95	* Replaced `.infoBoxList` boxes with `.footerBoxes`
	96	* Replaced `<fieldset>` tags with `<section class="section">`
	97	* Replaced `<legend>` tags with `<h2 class="sectionTitle">`
	98	* Replaced `.container`/`.marginTop` with `.section`
	99	* Replaced `.boxHeadline` with `.contentHeader`
	100	* Replaced `.boxSubHeadline` with `.sectionTitle`
	101	* Replaced `.sidebarNavigation` with `.boxMenu`
	102	* Replaced deprecated icon class (`icon-` => `fa-`)
	103	* Moved closing head / body tags into `footer` template
	104	* Moved documentHeader, head, body, contentHeader, userNotice into `header` template
	105	* Replaced `$sidebarOrientation` with `$sidebarLeft`/`$sidebarRight`
	106	* Renamed `{event name='fieldsets'}` to `{event name='sections'}`
	107	* Introduced `.separatorLeft`/`.separatorRight`
	108	* Removed `.tabularBoxTitle` if table title and page tite are identical
	109	* Moved the "No-JS"-Warning to footer template.
	110	* Tables can now be horizontally scrolled on mobile
	111	* Added mobile support for ACP
	112	* Added basic grid layout classes
	113	* Renamed `.pageNavigation` to `.pagination`
	114	* Renamed `.navigation`/`.navigationIcons` to `.pageNavigation`/`.pageNavigationIcons`
3d21a963	115	* Added CSS classes to style font sizes in tag cloud (`tagWeight1` - `tagWeight7`)
7fb9ac68	116
b2782e46 MS	117	#### Deprecated Code
	118
	119	* Object type definition `com.woltlab.wcf.user.online.location` deprecated.
	120	* Object type definition `com.woltlab.wcf.page` deprecated.
	121
48e5f94e MS	122	#### Removed Code
	123
	124	* `wcf\system\clipboard\action\UserExtendedClipboardAction` removed.
	125	* `wcf\system\event\listener\PreParserAtUserListener` removed.
	126	* `wcf\action\AJAXProxyAction::getData()` removed.
ced41de9 MW	127	* `wcf\system\page\PageManager` removed.
	128	* `wcf\system\option\PageMultiSelectOptionType` removed.
	129	* `wcf\system\option\PageSelectOptionType` removed.
	130	* `wcf\system\user\online\location\UserLocation` removed.
48e5f94e MS	131	* Version system removed.
48e5f94e MS	132	* Support for query string based sessions in Frontend removed.
e97294ab	133	* Language server system removed.
23fc9180	134	* Deprecated methods in `wcf\util\StringUtil` removed.
7fb9ac68 MW	135	* Option `message_sidebar_enable_message_group_starter_icon` removed.
	136	* Option `module_privacy_policy_page` removed.
	137	* Option `show_clock` removed.
	138	* Option `message_sidebar_enable_rank` removed.
	139	* Option `message_sidebar_enable_avatar` removed.
	140	* Removed obsolete `$activeMenuItem` in frontend forms/pages
e9335ed9 MS	141
	142	#### Documentation
	143
cf6e3ee0	144	* Added missing and fixed existing PHPDoc comments.
e9335ed9	145	* `@property-read` tags for database table columns of classes extending `wcf\data\DatabaseObject`.
cf6e3ee0 MS	146	* `@method` tags for classes extending `wcf\data\AbstractDatabaseObjectAction` to specify return types.
	147	* `@mixin` tag for classes extending `wcf\data\DatabaseObjectDecorator` for autocompletion/recognition of properties and methods of the decorated object.
	148	* `@method` tag for classes extending `wcf\data\DatabaseObjectEditor` to specify return type.
	149	* `@method` and `@property` tags for classes extending `wcf\data\DatabaseObjectList` to specify (return) types.
	150	* `@property` tag for classes extending `wcf\page\MultipleLinkPage` to specify type.
	151	* `@mixin` tag for classes extending `wcf\system\database\statement\PreparedStatement` for autocompletion/recognition of properties and methods of the decorated `\PDOStatement` object.
	152	* `@method` tags for `wcf\system\io\File` and `wcf\system\io\GZipFile` for autocompletion/recognition of methods called via `__call()`.