Website SS

My website iteration using SilverStripe CMS v4

requirements

• Ms Visual Studio Code
• XAMPP (make sure its PHP is v7+)
• setup Apache vhosts and Windows hosts in etc/
• composer
• in my case, a Windows Git bash console

set up

• enabled PHP extension:

  • intl
  • fileinfo
  • mysqli
  • openssl
  • mbstring

• create SilverStripe app using composer

composer create-project silverstripe/installer websiteSS

• change .env.example to .env

specify database credential in it and set the project to dev mode and add an admin account to CMS

# For a complete list of core environment variables see
# https://docs.silverstripe.org/en/4/getting_started/environment_management/#core-environment-variables

# DB credentials
SS_DATABASE_CLASS="MySQLDatabase"
SS_DATABASE_SERVER="localhost"
SS_DATABASE_USERNAME="abe"
SS_DATABASE_PASSWORD="12345678"
# SS will try generate the DB name
SS_DATABASE_CHOOSE_NAME=true

# SS is in dev mode
SS_ENVIRONMENT_TYPE='dev'

# generate default admin
SS_DEFAULT_ADMIN_USERNAME='root'
SS_DEFAULT_ADMIN_PASSWORD='root'

• basic commands before running the project in browser

if you add new page+controller, re-build the project using project.url/dev/build

changes in templates/themes use project.url/?flush

• project front-end requirements like javascript, css, fonts and images belongs in /public

• add them in app/src/PageController.php

use SilverStripe\View\Requirements;

    parent::init();
    Requirements::css('css/bootstrap.min.css');
    Requirements::css('css/style.css');
    Requirements::javascript('javascript/common/modernizr.js');
    Requirements::javascript('javascript/common/jquery-1.11.1.min.js');
    Requirements::javascript('javascript/common/bootstrap.min.js');
    Requirements::javascript('javascript/common/bootstrap-datepicker.js');
    Requirements::javascript('javascript/common/chosen.min.js');
    Requirements::javascript('javascript/common/bootstrap-checkbox.js');
    Requirements::javascript('javascript/common/nice-scroll.js');
    Requirements::javascript('javascript/common/jquery-browser.js');
    Requirements::javascript('javascript/scripts.js');

relational

• one to one

in Thing class

// recommended table name declaration,
// SS generate a long table name based on class and namespace
// this will be incompatible with future SS version

private static $table_name = 'Things';

private static has_one = [
    'Things' => Things::class,
];

• one to many

in Things class

private static $has_many = [
    'Thing' => Thing::class,
];

private static $owns = [
    'Thing'
];

templates

<?php

namespace Website\PegBoard;

use Page;

class PortfolioPage extends Page
{

}

<?php

namespace Website\PegBoard;

use PageController;

class PortfolioPageController extends PageController
{

}

notes to self

• naming and project structure convention

app/src/
PageNamePage.php
PageNamePageController.php

app/src/templates/namespace/Layout
PageNamePage.ss

• using DropDownField

declare the property as usual

private static $db = [
    'Colour' => 'Varchar(10)',
];

set in '$fields = FieldList::create();'

DropdownField::create( 'Colour', 'Colour',
    array(
        'value expected in db' => 'Displayed in dropdown',
        'white' => 'White',
        'green' => 'Green',
        'yellow' => 'Yellow',
        'pink' => 'Pink',
        'blue' => 'Blue',
    )),

• template anchor rewriting

for using # links in pages like bootstrap nav tabs/carousels

disable template's engine to automatically rewrite any anchor links that doesn't specify URL

2 ways to do this

in app/_config/youprojectname.yml

SilverStripe\View\SSViewer:
  rewrite_hash_links: false

only disable in specific page we disable it thru the page's controller class

namespace Example\HashLink;

use PageController;
use SilverStripe\View\SSViewer;

class ExamplePageController extends PageController
{
    protected function init()
    {
        parent::init();
        SSViewer::setRewriteHashLinksDefault(false);
    }
}

• Base URL

in .env add

SS_BASE_URL="https://yourdomain.com"

in site _config yml file

SilverStripe\Control\Director:
   alternate_base_url: '`SS_BASE_URL`'

• Could be helpful for form styling

composer require axllent/silverstripe-bootstrap-forms dev-master

• injecting a css and js in a page

<% require css("css/gallery.css") %> <% require javascript("css/gallery.js") %>