While working on an update for one of my SilverStripe modules, I came upon a problem which held me back for some time, changing configurations and doing all kinds of tests.
The thing is – Facebook engine verifies the link you’re trying to post, so the post from localhost fails with “Unknown error”. You need to give Facebook a link it can scrape and extract meta data from it, so for testing purposes use an existing link, and when your test is online try how the regular link would work.
Silverstripe 3 has been out for a few months now, and most the big bugs have been fixed… This tutorial describes the code required to set up a grid field to manage ‘Has Many’ relations. Eg – a staff page that lists many staff members.
Also, we’ll add in some code that will make the table list in the CMS display a wee thumbnail of each staff member – making it much easier for CMS users to manage the content.
Create StaffPage.php
This is the page on your site that contains all the staff page. Eg, one ‘staff page’ -> ‘has many’ -> ‘staff members’
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
class StaffPage extends Page { public static $has_many = ['StaffMembers' => 'StaffMember']; public function getCMSFields() { $fields = parent::getCMSFields(); $gridFieldConfig = GridFieldConfig_RecordEditor::create(); $gridfield = new GridField("StaffMembers", "StaffMember", $this->StaffMembers, $gridFieldConfig); $fields->addFieldToTab('Root.Staff', $gridfield); return $fields; } } class StaffPage_Controller extends Page_Controller { } |
Create StaffMember.php
|
1 2 3 4 5 6 7 8 |
class StaffMember extends DataObject { public static $db = ['Name' => 'Varchar', 'Details' => 'HTMLText']; public static $has_one = [ 'Image' => 'Image', 'Page' => 'Page', ]; } |
This is the object that contains data about each staff member. They belong to a Staff Page
In the code above, we simple create a DataObject, and define two feilds, a name, and a details.
We also attach the DataObject to an image object (allowing us to add an image) and to a page – this forms the connection with the Staff page it belongs to
At this stage, upload the files, run a dev/build and create a ‘staffPage’ in your CMS. You should be able to see a datagrid and start adding staff members and photos.
|
1 2 3 4 5 6 7 |
// Summary fields public static $summary_fields = ['Thumbnail' => 'Thumbnail', 'Name' => 'Name']; public function getThumbnail() { return $this->Image()->CMSThumbnail(); } |
However, the grid field will probably just list your items by their ID – which is a bit meaningless.
By adding the code above into the StaffMember.php file, we can define the fields (summary_fields) that are shown on the summary table in the CMS.
The function getThumbnail takes the attached Image, and creates a thumbnail to use in the summary fields.
Most of the times group access in SilverStripe is sufficient for controlling user access, but for this project I had a specific situation where every user needs to have a dedicated page. In order to avoid unnecessary editing and creating groups for each individual user, I decided to extend SiteTree and create a page with per user access control.
So, I’ve created a new page type, since I only needed it for a single page type, but you can extend/decorate SiteTree any way you like.
Let’s get to the code. This goes to mysite/code/FilePage.php
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 |
<?php class FilePage extends Page { static $db = array( "CanViewTypeExtended" => "Enum('Anyone, LoggedInUsers, OnlyTheseUsers, OnlyTheseMembers, Inherit', 'Inherit')", ); static $has_one = array( "ViewerMember" => "Member", ); public function getSettingsFields(){ global $project; $fields = parent::getSettingsFields(); Requirements::javascript($project.'/javascript/CMSMain.EditFormMember.js'); //Not sure where to put this :) $members = Member::map_in_groups(); $field = new DropdownField("ViewerMemberID", "Viewer Members", $members); $field->setEmptyString('(Select one)'); $fields->addFieldToTab("Root.Settings", $field, 'CanEditType'); $viewersOptionsField = $fields->removeByName('CanViewType'); $viewersOptions = new OptionsetField( "CanViewTypeExtended", _t('SiteTree.ACCESSHEADER', "Who can view this page?") ); $viewersOptionsSource = array(); $viewersOptionsSource["Inherit"] = _t('SiteTree.INHERIT', "Inherit from parent page"); $viewersOptionsSource["Anyone"] = _t('SiteTree.ACCESSANYONE', "Anyone"); $viewersOptionsSource["LoggedInUsers"] = _t('SiteTree.ACCESSLOGGEDIN', "Logged-in users"); $viewersOptionsSource["OnlyTheseUsers"] = _t('SiteTree.ACCESSONLYTHESE', "Only these people (choose from list)"); $viewersOptionsSource["OnlyTheseMembers"] = _t('SiteTree.ACCESSONLYTHESEMEMBERS', "Only these members (choose from list)"); $viewersOptions->setSource($viewersOptionsSource); $fields->addFieldToTab("Root.Settings", $viewersOptions, 'ViewerGroups'); return $fields; } // Override the SiteTree canView function to implement the new variable public function canView($member = null) { if(!$member || !(is_a($member, 'Member')) || is_numeric($member)) { $member = Member::currentUserID(); } // admin override if($member && Permission::checkMember($member, array("ADMIN", "SITETREE_VIEW_ALL"))) return true; // Standard mechanism for accepting permission changes from extensions $extended = $this->extendedCan('canView', $member); if($extended !== null) return $extended; // check for empty spec if(!$this->CanViewTypeExtended || $this->CanViewTypeExtended == 'Anyone') return true; // check for inherit if($this->CanViewTypeExtended == 'Inherit') { if($this->ParentID) return $this->Parent()->canView($member); else return $this->getSiteConfig()->canView($member); } // check for any logged-in users if($this->CanViewTypeExtended == 'LoggedInUsers' && $member) { return true; } // check for specific groups if($member && is_numeric($member)) $member = DataObject::get_by_id('Member', $member); if( $this->CanViewTypeExtended == 'OnlyTheseUsers' && $member && $member->inGroups($this->ViewerGroups()) ) return true; //Check for specific Member if( $this->CanViewTypeExtended == 'OnlyTheseMembers' && $member && $member->ID == $this->ViewerMemberID ) return true; return false; } } |
So, let’s break it down a bit:
I’ve created a new variable – CanViewTypeExtended to replace SiteTree’s CanViewType, since I couldn’t find the way to add an option (If you know a way, feel free to drop a line). It replicates SiteTree’s CanViewType with OnlyTheseMembers option added, which is our per user access type.
Then, we have has one ViewerMember, which holds actual user ID for single user (I’ve limited it to one user, since using any more would be a group).
The rest is pretty basic, mostly copied from SiteTree with a bit of additions, getSettingsFields is a standard function for updating the Settings tab in CMS. There we have first included the JavaScript file, which will be shown later, and is only for decoration – showing and hiding fields based on selection.
Then we have created Member selection field, to pick a member to which the access will be granted, and replicated creating CanViewType field from SiteTree.php with addition of our new OnlyTheseMembers option.
After this is saved, all that is left is to check user permissions in canView() method. Since we don’t use CanViewType any more, but have replaced it with CanViewTypeExtended, the entire function is copied from SiteTree.php, except for the last part which grants the access if current member is our selected member:
if($this->CanViewTypeExtended == ‘OnlyTheseMembers’ && $member && $member->ID == $this->ViewerMemberID)
return true;
So, here’s the remaining js file, which goes to mysite/javascript/CMSMain.EditFormMember.js
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
/** * File: CMSMain.EditFormMember.js */ (function($) { $.entwine('ss', function($){ /** * Class: .cms-edit-form #CanViewTypeExtended * * Toggle display of Member dropdown in "access" tab, * based on selection of radiobuttons. */ $('.cms-edit-form #CanViewTypeExtended').entwine({ // Constructor: onmatch onmatch: function() { // TODO Decouple var dropdownMembers = $('#ViewerMemberID'); var dropdownGroups = $('#ViewerGroups'); this.find('.optionset :input').bind('change', function(e) { var wrapper = $(this).closest('.middleColumn').parent('div'); var wrapper2 = dropdownMembers.closest('.middleColumn').parent('div'); if(e.target.value == 'OnlyTheseMembers') { wrapper.addClass('remove-splitter'); dropdownMembers['show'](); dropdownGroups['hide'](); }else if(e.target.value == 'OnlyTheseUsers') { wrapper.addClass('remove-splitter'); dropdownMembers['hide'](); dropdownGroups['show'](); }else{ wrapper.removeClass('remove-splitter'); dropdownMembers['hide'](); dropdownGroups['hide'](); } }); // initial state var currentVal = this.find('input[name=' + this.attr('id') + ']:checked').val(); dropdownMembers[currentVal == 'OnlyTheseMembers' ? 'show' : 'hide'](); dropdownGroups[currentVal == 'OnlyTheseUsers' ? 'show' : 'hide'](); this._super(); }, onunmatch: function() { this._super(); } }); }); }(jQuery)); |
Not something big or important, but I just tried several ways to get tidy library on my Ubuntu box, and none other then this worked. Might save some searching to others.
sudo apt-get install php5-tidy
Tidy is recommended for running SilverStripe (not required).
php5 comes with Tidy library preinstalled but it has to be compiled –with-tidy which is sometimes skipped (well, on the box I’m setting up for example).
The grid field system in Silverstripe 3 has a number of preset config options – here’s what they do, and what they look like:
If we don’t add any config options, the grid field just displays a list of items… We can’t view the record details, or edit anything though…
|
1 2 |
$gridfield =newGridField("RegisterEvents","RegisterEvent", $this->RegisterEvents()); $fields->addFieldToTab('Root.Events', $gridfield); |
|
1 2 3 |
$gridFieldConfig =GridFieldConfig_RecordViewer::create(); $gridfield =newGridField("RegisterEvents","RegisterEvent", $this->RegisterEvents(), $gridFieldConfig); $fields->addFieldToTab('Root.Events', $gridfield); |
This option just adds in the ability to click the magnifying glass and view the details of each item – but not edit anything.
|
1 2 3 |
$gridFieldConfig =GridFieldConfig_RecordEditor::create(); $gridfield =newGridField("RegisterEvents","RegisterEvent", $this->RegisterEvents(), $gridFieldConfig); $fields->addFieldToTab('Root.Events', $gridfield); |
Now we’re starting to get something useful – a list that lets us Add, View, and Remove records…
The final option is the Relation Edition set up. This adds features to work with ‘has-many’ and ‘many-many’ relationships.
See our article about Many_Many relations for more details
Or, you can just create an empty configuration, and add the bits you need….
|
1 2 3 4 5 6 7 8 9 10 |
$gridFieldConfig =GridFieldConfig::create()->addComponents( newGridFieldToolbarHeader(), newGridFieldAddNewButton('toolbar-header-right'), newGridFieldSortableHeader(), newGridFieldDataColumns(), newGridFieldPaginator(15), newGridFieldEditButton(), newGridFieldDeleteAction(), newGridFieldDetailForm(),newGridFieldFilterHeader(), ); |
When you first install your SilverStripe site, the ‘Settings’ menu is pretty limited, offering just Title, Tagline, and a choice of templates.
This is fine, but it’s often useful to add other options, such as logo upload, links to facebook, uploading a banner image that appears on every page.
In your ‘mysite/code/’ folder, create a new file called ‘MySiteConfig.php’, and insert the following text:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 |
<?php class MySiteConfig extends DataExtension { public static $has_one = array( 'HeaderImage' => 'Image', 'LogoImage' => 'Image', ); public static $db = array( 'FacebookURL' => "Varchar(250)", 'VimeoURL' => "Varchar(250)", ); public function updateCMSFields(FieldList $fields) { $fields->addFieldToTab("Root.Main", new UploadField("LogoImage", "Choose an image for your site logo")); $fields->addFieldToTab("Root.Main", new UploadField("HeaderImage", "Choose an image for the site header")); $fields->addFieldToTab("Root.Main", new TextField("FacebookURL", "Enter the full URL of your Facebook page")); $fields->addFieldToTab("Root.Main", new TextField("VimeoURL", "Enter the full URL of your Vimeo page")); } } |
This file creates a ‘DataExtension’. A DataExtension, as the name suggests, is used to extend any set of data. You declare the additional databse fields and relations just as you would when creating a new page.
And you use the function ‘public function updateCMSFields {}’ to add the fields to the CMS page, just as you would when creating a new page.
In your ‘mysite’ folder, open the ‘_config,php’ file, and add the following line:
|
1 |
Object::add_extension('SiteConfig', 'MySiteConfig'); |
This line simple tells SilverStripe to take the ‘SiteConfig’ (the basic settings that already exist) and add ‘MySiteConfig’ to it.
Go to your site, log in, and add ‘/dev/build’ to the URL – eg ‘mysite.com/dev/build’ to refresh the database.
Now, in the admin area, go to the site settings page and you should see your new options.
You can now add a logo, banner image, and enter the facebook / vimeo links – the data is stored in the database, but we need to show it on our page.
We do this by adding ‘$SiteConfig.’ in front of the names of the fields. Eg:
|
1 2 |
$SiteConfig.LogoImage.SetRatioSize(250,250) <a href="$SiteConfig.FacebookURL">Visit my facebook page</a> |
As a common request around the web is to translate the entire Site Tree. Following the post on: https://www.silverstripe.org/customising-the-cms/show/7318 Which was made for SS 2.3.2, I’ve adopted the code to work with SilverStripe 3.0 (Tested on 3.0.5). It gives you the ability to select entire site tree, or just parts of it, and translate it to draft or to published site.
I just started with SilverStripe, and here are a few things I stumbled upon while testing the possibilities of this Framework/CMS, hope it will be helpful to someone.
First, some things you can do right in your mysite/_config.php. You can remove most of the admin menu links by using:
CMSMenu::remove_menu_item(‘ReportAdmin’); // Reports link for example
Also, you can define the Admin page title, not to display SilverStripe with:
LeftAndMain::setApplicationName(“MyApplication”);
There are two ways to remove the index.php/ part from the url, but before you do that make sure your mod_rewrite is working. First way is to edit the first line of code in index.php so it says:
define('BASE_SCRIPT_URL',''); // Originally : define('BASE_SCRIPT_URL','index.php/');
The other way is to just completely delete index.php
And for those that don’t like the “Help” link in the admin menu, you have to go a bit deeper and edit /framework/admin/code/LeftAndMain.php.
As it says at line 173:
// can’t be done in cms/_config.php as locale is not set yet
So, you can just comment out the following lines:
/*CMSMenu::add_link(
'Help',
_t('LeftAndMain.HELP', 'Help', 'Menu title'),
self::$help_link
);*/
Happy coding!
I just started testing the Zend Framework 2, and I wanted to give it a quick look around with the Skeleton Application. I didn’t want to add virtual hosts to my local Apache, as I have more important stuff I’m working on, so I just wanted to make a folder for it and run the application.
I’ve read some post about placing it in sub folder, but the real thing was much simpler. What I did was installing the application in https://localhost/zend/, then just copied everything from “public” folder to the sub folder root . After that, it was enough just to comment out the line:
|
1 |
// Change the folowing line: chdir(dirname(__DIR__)); // to: //chdir(dirname(__DIR__)); |
It’s just as easy as that, navigate to https://localhost/zend/, and you should be presented with skeleton application.