Home > Modules >
Example: Video Embed for YouTube/Vimeo
Module Class Name
Use upper and lowercase, like this: TextformatterVideoEmbedFor admin themes or site profiles, make this the same as the title, but with no spaces.
SummaryThe Local Audio Files DB is a combination of a Module and a SiteProfile. It is intended to import MP3-files from your filesystem into ProcessWire, read ID3-Tags and pull coverImages from it to feed the DB.
A short description of what this module does (max 1 paragraph). No markup or links.You can enter a detailed description later if you want to.
Current Module Version
Example: 1.0.2If your project is hosted at GitHub, this version number will be automatically kept up-to-date (once per day, or whenever you submit this form).
Categories (check all categories that apply)
ProcessWire Version Compatibility
Check all versions this module is known to be compatible with.
All of these URLs are required before your module will be published in the directory. If you have not yet posted a forum thread about your module in the ProcessWire forums, please do so now.
Project URL (use GitHub URL if available)
Download URL (preferably a link directly to a ZIP file)
Forum Thread URL (in the ProcessWire forums)
If your project is hosted at GitHub, your README file will be automatically displayed with your module listing. If you want to provide additional information beyond that, or if your project is not hosted at GitHub, please complete the Extended Module Description and/or Instructions fields below. In these fields, you may optionally use BBCode for formatting. For example:
[b]bold[/b] [i]italic[/i] [u]underline[/u] [url=http://domain.com]link text[/url][code]Code Example[/code] [img]http://domain.com/image.jpg[/img] [list] [*]Entry 1 [*]Entry 2 [/list]
Extended Module Description (optional)[size=6][b]Local Audio Files[/b][/size] [size=3]-[/size] [b][size=5]MP3-DB[/size][/b]
The Local Audio Files DB is a combination of a Module and a SiteProfile. It is intended to import MP3-files from your filesystem into ProcessWire, read ID3-Tags and pull coverImages from it to feed the DB.
[b][size=5]How does it work?[/size][/b]
[*]The Site has [color=#0000cd]4 sibling[/color] Tree Branches: [color=#0000cd]genres - artists - albums - songs[/color].[/*]
[*]Each of them hold child-pages: [color=#0000cd]genre - artist - album - song[/color].[/*]
[*]The [color=#0000cd]logical relations[/color] are [color=#0000cd]nested parent-children[/color] ones: a genre hold artists, each artist hold albums, each album hold songs.[/*]
[*]To support both, slim and fast data relations & the logical hirarchy, the module extends the ProcessWire variable [color=#800080][i][b]$page[/b][/i][/color] with some additions. It uses the addHookProperty mechanism to achieve that.[/*]
[*]It uses an own [color=#0000cd]caching mechanism[/color] for large lists, that can be prebuild when running the [color=#0000cd]importer-shellscript[/color], or it build the cache on demand.[/*]
[*]Also it comes with a [color=#800080]FrontEndHandler class[/color] that provides a lot of functionality, for example fully customizable FormSelectFields of all genres, artists or albums.[/*]
[*]More [color=#0000cd]detailed informations[/color] and [color=#0000cd]code examples[/color] are collected in [color=#0000cd]a demo section[/color] of the site.[/*]
The [color=#800080]extended [i][b]$page[/b][/i] variable[/color] together with the [color=#800080][i][b]LocalAudioFiles-FrontEndHandler[/b][/i][/color] gives you comprehensive tools to work with your music collection.
Instructions (optional, how to install and use this module)[size=5][b]How to Install[/b][/size]
Grab a copy of the [url=http://grab.pw/]latest ProcessWire[/url]. Replace the [i]install[/i], [i]modules[/i] and [i]templates[/i] directories with those in this profile, as shown below:
With SiteProfile-Installs normally that is all there is to do. With this Profile you also have to copy the file [color=#0000cd]LocalAudioFilesImportShellScript.php[/color] (for simplicity) to your PW-rootfolder, (where the index.php reside). If you are on Windows you also should copy [color=#0000cd]mp3_import_starter4win.cmd[/color] to the same location.
Now install ProcessWire as per the instructions included with it and it will install the LocalAudioFiles profile automatically.
After that you find a Quickstart Guide at the homepage of the profile where you are advised to follow 2 steps before you are done!
If left blank, ProcessWire's standard module installation instructions will be shown.
Author's Forum Name (1-word per author, as it appears the ProcessWire forum)
This is so that we can link with your forum profile. If there are multiple authors, separate each by a space. If an author name actually has a space in it, then replace the space with a hyphen. If you don't have an account in the forum, you can create one here.
When you created this module page, you were asked to select an email address and password to authenticate future edits. Please enter them below. If you lost your password for this module, you can retrieve it here.
Password Please note that these passwords are not encrypted! Choose something you've never used before and won't ever use elsewhere.
Go to the forums
Follow us on Twitter
ProcessWire.com is powered by Amazon Web Services
with servers managed by Perago Solutions.
ProcessWire Open Source CMS
© 2020 by Ryan Cramer Design, LLC
• Contact Us