Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Tests

on:
push:
branches:
- master
pull_request:
branches:
- master

jobs:
test:
uses: phpbb-extensions/test-framework/.github/workflows/tests.yml@3.3.x
with:
EXTNAME: 'senky/notes'
PRIMARY_PHP_VERSION: '8.1'
PHP_VERSION_MATRIX: '["8.1", "8.2", "8.3", "8.4"]'
RUN_MSSQL_JOBS: 0
18 changes: 18 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
### macOS
# Finder metadata
.DS_Store

# Thumbnails
._*

# Custom folder icons
Icon

# Volume root files
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns
.com.apple.timemachine.donotpresent
Expand Down
57 changes: 0 additions & 57 deletions .travis.yml

This file was deleted.

56 changes: 39 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,49 @@
# phpBB Notes Extension
Notes for phpBB 3.3
===========

This is the repository for the development of the phpBB Notes Extension
Extension for phpBB that lets every registered user keep a private notepad on the forum.
Extension by Jakub Senko ([Senky](https://github.com/Senky)).

[![Build Status](https://travis-ci.org/Senky/phpbb-ext-notes.svg?branch=develop)](https://travis-ci.org/Senky/phpbb-ext-notes)
**Version:** 2.1.0 (22/05/2026)

## Install
#### Requirements
- phpBB 3.3.0 or higher
- PHP 7.1.3 or higher

1. [Download the latest validated release](https://www.phpbb.com/customise/db/extension/notes/).
2. Unzip the downloaded release and copy it to the `ext` directory of your phpBB board.
3. Navigate in the ACP to `Customise -> Manage extensions`.
4. Look for `Notes` under the Disabled Extensions list, and click its `Enable` link.
#### Features
- Per-user private notepad accessible from the quick links menu
- Notes are stored on the `user_note` column of the users table and never shown to other users, administrators, or moderators
- Single page at `/app.php/notes`
- Bots are redirected to the index

#### ACP Options
None — the extension has no configurable settings.

## Uninstall
#### Extension integrations
None.

1. Navigate in the ACP to `Customise -> Extension Management -> Extensions`.
2. Look for `Notes` under the Enabled Extensions list, and click its `Disable` link.
3. To permanently uninstall, click `Delete Data` and then delete the `/ext/senky/notes` directory.
#### Languages
English, German, Dutch, French, Spanish, Estonian, Portuguese (Brazil), Russian, Arabic

## Support
#### Tested on
prosilver

#### Installation
1. [Download the latest release](https://github.com/Senky/notes) and unzip it.
2. Copy the contents to `/ext/senky/notes/` (so that `composer.json` is at `/ext/senky/notes/composer.json`).
3. Navigate in the ACP to `Customise -> Manage extensions`.
4. Find `Notes` under "Disabled Extensions" and click `Enable`.

* **Important: Only official release versions validated by the phpBB Extensions Team should be installed on a live forum. Pre-release (beta, RC) versions downloaded from this repository are only to be used for testing on offline/development forums and are not officially supported.**
* Report bugs and other issues to our [Issue Tracker](https://github.com/Senky/phpbb-ext-notes/issues).
* Support requests should be posted and discussed in the [Notes topic at phpBB.com](https://www.phpbb.com/customise/db/extension/notes/support).
#### Uninstallation
1. Navigate in the ACP to `Customise -> Manage extensions`.
2. Click the `Disable` link for `Notes`.
3. To permanently uninstall, click `Delete Data`, then delete the `notes` folder from `/ext/senky/`.

## License
#### Support
- [Support forum](https://www.avathar.be/forum/viewforum.php?f=16)

#### License
[GNU General Public License v2](http://opensource.org/licenses/GPL-2.0)


Originally by Jakub Senko. Updated for phpBB 3.3 by Andy Vandenberghe (Sajaki).
61 changes: 36 additions & 25 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,27 +1,38 @@
{
"name": "senky/notes",
"type": "phpbb-extension",
"description": "This extension allow users to write their own notes.",
"version": "2.0.0",
"time": "2016-08-30",
"license": "GPL-2.0",
"authors": [
{
"name": "Jakub Senko",
"email": "jakubsenko@gmail.com",
"role": "Lead Developer"
}
],
"require": {
"php": ">=5.3.3"
},
"require-dev": {
"phpbb/epv": "dev-master"
},
"extra": {
"display-name": "Notes",
"soft-require": {
"phpbb/phpbb": ">=3.1.0,<3.3"
}
}
"name": "senky/notes",
"type": "phpbb-extension",
"description": "This extension allow users to write their own notes.",
"version": "2.1.0",
"time": "2026-05-22",
"license": "GPL-2.0-only",
"authors": [
{
"name": "Jakub Senko",
"email": "jakubsenko@gmail.com",
"role": "Lead Developer"
},
{
"name": "Andreas Van den berghe",
"email": "sajaki@avathar.be",
"role": "Contributor"
}
],
"require": {
"php": ">=7.1.3",
"phpbb/phpbb": ">=3.3.0,<4.0"
},
"require-dev": {
"phpbb/epv": "dev-master"
},
"extra": {
"display-name": "Notes",
"soft-require": {
"phpbb/phpbb": ">=3.3.0,<4.0"
},
"version-check": {
"host": "www.phpbb.com",
"directory": "/customise/db/extension/notes",
"filename": "version_check"
}
}
}
19 changes: 9 additions & 10 deletions config/services.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,17 @@ services:
senky.notes.controller:
class: senky\notes\controller\main_controller
arguments:
- @dbal.conn
- @template
- @user
- @controller.helper
- @request
- %core.root_path%
- %core.php_ext%
- '@dbal.conn'
- '@template'
- '@user'
- '@controller.helper'
- '@request'
- '%core.root_path%'
- '%core.php_ext%'
senky.notes.listener:
class: senky\notes\event\listener
arguments:
- @template
- @controller.helper
- @config
- '@template'
- '@controller.helper'
tags:
- { name: event.listener }
14 changes: 14 additions & 0 deletions contrib/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
### Changelog

- 2.1.0 (22/05/2026)
- [CHG] Updated composer requirements to phpBB 3.3.0+ and PHP 7.1.3+
- [CHG] Replaced FontAwesome 4 icon class `fa-sticky-note-o` with FA5 `far fa-sticky-note` in the quick links template
- [CHG] Quoted service references (`@template`, `@dbal.conn`, ...) in `config/services.yml` for compatibility with the phpBB 3.3 Symfony YAML parser
- [DEL] Removed obsolete `S_IS_31` template branch and the phpBB-3.1 quick-link fallback markup
- [DEL] Removed unused `\phpbb\config\config` injection from the event listener
- [NEW] added Dutch translation

- 2.0.0 (30/08/2016)
- Original release by Jakub Senko ([Senky](https://github.com/Senky)) for phpBB 3.1 / 3.2

Originally by Jakub Senko. Updated for phpBB 3.3 by Andy Vandenberghe (Sajaki).
8 changes: 1 addition & 7 deletions event/listener.php
Original file line number Diff line number Diff line change
Expand Up @@ -23,22 +23,17 @@ class listener implements EventSubscriberInterface
/** @var \phpbb\controller\helper */
protected $helper;

/** @var \phpbb\config\config */
protected $config;

/**
* Constructor
*
* @param \phpbb\template\template $template Template object
* @param \phpbb\controller\helper $helper Helper object
* @param \phpbb\config\config $config Config object
* @access public
*/
public function __construct(\phpbb\template\template $template, \phpbb\controller\helper $helper, \phpbb\config\config $config)
public function __construct(\phpbb\template\template $template, \phpbb\controller\helper $helper)
{
$this->template = $template;
$this->helper = $helper;
$this->config = $config;
}

/**
Expand Down Expand Up @@ -84,7 +79,6 @@ public function assign_common_template_variables($event)
{
$this->template->assign_vars(array(
'U_SENKY_NOTES' => $this->helper->route('senky_notes_notes'),
'S_IS_31' => version_compare($this->config['version'], '3.2.0', '<'),
));
}
}
26 changes: 26 additions & 0 deletions language/nl/notes.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<?php
/**
*
* Notes extension for the phpBB Forum Software package.
*
* @copyright (c) 2016 Senky <https://github.com/Senky>
* @license GNU General Public License, version 2 (GPL-2.0)
*
*/

if (!defined('IN_PHPBB'))
{
exit;
}

if (empty($lang) || !is_array($lang))
{
$lang = array();
}

$lang = array_merge($lang, array(
'NOTES' => 'Notities',
'NOTES_DESCRIPTION' => 'De notities die je hier ziet, zijn voor niemand anders zichtbaar, ook niet voor beheerders en moderators.',
'SAVE_NOTES' => 'Notities opslaan',
'NOTES_SAVED' => 'Je notities zijn opgeslagen.<br /><br /> <a href="%s">Terug naar notities</a>',
));
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
{% if S_IS_31 %}
<li class="small-icon icon-pages"><a href="{{ U_SENKY_NOTES }}" role="menuitem">{{ lang('NOTES') }}</a></li>
{% else %}
<li>
<a href="{{ U_SENKY_NOTES }}" role="menuitem">
<i class="icon fa-sticky-note-o fa-fw icon-gray" aria-hidden="true"></i><span>{{ lang('NOTES') }}</span>
</a>
</li>
{% endif %}
<li>
<a href="{{ U_SENKY_NOTES }}" role="menuitem">
<i class="icon far fa-sticky-note fa-fw icon-gray" aria-hidden="true"></i><span>{{ lang('NOTES') }}</span>
</a>
</li>
24 changes: 0 additions & 24 deletions travis/prepare-phpbb.sh

This file was deleted.