wernerkrauss/folderperpage

An extension for automatically creating a folder per page

Installs: 485

Dependents: 0

Suggesters: 2

Security: 0

Stars: 2

Watchers: 3

Forks: 2

Open Issues: 6

Type:silverstripe-vendormodule

0.2.2 2016-03-09 09:59 UTC

This package is auto-updated.

Last update: 2024-10-29 05:16:15 UTC


README

Build Status Scrutinizer Code Quality codecov.io helpfulrobot

Extension that creates a folder per page or dataobject

Requirements

for SS3 compatible versions see SS3 branch

Installation

Download and install manually or use composer.

Make sure you add the extension to the classes you want to decorate. Add this to your config.yml to add it to all Pages:

Page:
  extensions:
    - NetWerkstatt\FolderPerPage\Extensions\RootFolder

Configuration

You can exclude several page types. Just use the RootFolder.ignored_classes config value. The module's config.yml has some default values to get you started:

NetWerkstatt\FolderPerPage\Extensions\RootFolder:
  ignored_classes:
    - SilverStripe\CMS\Model\VirtualPage
    - SilverStripe\ErrorPage\ErrorPage
  create_folder_for_translations: false
  folder_root: 'Articles'

Of course every decorated class can have a seperate folder root, e.g. "Articles" for all pages and "News" for a news data object. Just add the folder_root config to your object.

Update your forms

You can use $this->getRootFoldername() to set the upload folder.

Given you have a has_one relation "Avatar" => "Image" you can add the folder to the UploadField:

function getCMSFields() {
    /*...*/
    $pic = UploadField::create('Avatar', 'Your Avatar');
    $fields->addFieldToTab('Root.Main', $pic);

    $pic->setFolderName($this->getRootFolderName());
    /*...*/
}

TODO

  • make it work for other dataobjects
  • unit tests
  • add function that automatically updates all UploadFields and BulkUploads to use this folder in a form
  • add support for subsites module, e.g. a master root per subsite
  • task for updating / checking all existing pages
  • check if page is moved
    • should it move the rootfolder automatically or by switch? May be a timeout problem with very large trees