mirror of
https://github.com/silverstripe/silverstripe-iframe
synced 2024-10-22 11:05:51 +02:00
Merge branch '2.0'
This commit is contained in:
commit
5fd8fcb561
13
.travis.yml
13
.travis.yml
@ -7,13 +7,15 @@ env:
|
||||
matrix:
|
||||
include:
|
||||
- php: 5.6
|
||||
env: DB=MYSQL PHPCS_TEST=1 PHPUNIT_TEST=1
|
||||
env: DB=MYSQL RECIPE_VERSION=1.0.x-dev PHPCS_TEST=1 PHPUNIT_TEST=1
|
||||
- php: 7.0
|
||||
env: DB=MYSQL PHPUNIT_TEST=1
|
||||
env: DB=MYSQL RECIPE_VERSION=1.1.x-dev PHPUNIT_TEST=1
|
||||
- php: 7.1
|
||||
env: DB=MYSQL PHPUNIT_COVERAGE_TEST=1
|
||||
env: DB=MYSQL RECIPE_VERSION=4.2.x-dev PHPUNIT_COVERAGE_TEST=1
|
||||
- php: 7.2
|
||||
env: DB=MYSQL PHPUNIT_TEST=1
|
||||
env: DB=PGSQL RECIPE_VERSION=4.3.x-dev PHPUNIT_TEST=1
|
||||
- php: 7.3
|
||||
env: DB=MYSQL RECIPE_VERSION=4.x-dev PHPUNIT_TEST=1
|
||||
|
||||
before_script:
|
||||
# Init PHP
|
||||
@ -23,7 +25,8 @@ before_script:
|
||||
|
||||
# Install composer dependencies
|
||||
- composer validate
|
||||
- composer require --no-update silverstripe/recipe-cms:1.0.x-dev
|
||||
- composer require --no-update silverstripe/recipe-cms:"$RECIPE_VERSION"
|
||||
- if [[ $DB == PGSQL ]]; then composer require --no-update silverstripe/postgresql:2.2.x-dev; fi
|
||||
- composer install --prefer-dist --no-interaction --no-progress --no-suggest --optimize-autoloader --verbose --profile
|
||||
|
||||
script:
|
||||
|
21
README.md
21
README.md
@ -8,8 +8,16 @@
|
||||
|
||||
## Introduction
|
||||
|
||||
The iframe module provides an IFrame page type that allows you to embed an IFrame into a page without resorting to
|
||||
custom code.
|
||||
The IFrame module provides an IFrame page type in the CMS which allows you to embed an IFrame into a page without
|
||||
resorting to custom code in your templates or TinyMCE instance.
|
||||
|
||||
This can help if you have `iframe` disabled in TinyMCE's [valid_elements](https://www.tiny.cloud/docs-3x/reference/configuration/Configuration3x@valid_elements/)
|
||||
and do not want to to re-enable it in for a single/specific use-case. It's also possible that using a Web Application
|
||||
Firewall (WAF) may block page save requests that contain iframe elements in HTML content, which using this module would
|
||||
circumvent.
|
||||
|
||||
Various attributes of the IFrame can be controlled from CMS fields, such as size and content that surrounds the
|
||||
IFrame itself.
|
||||
|
||||
## Requirements
|
||||
|
||||
@ -19,8 +27,13 @@ custom code.
|
||||
|
||||
## Installation
|
||||
|
||||
Run `composer require silverstripe/iframe`, then append dev/build?flush=all to the website URL in your
|
||||
browser. e.g. http://mysite.test/dev/build?flush=all
|
||||
Install with Composer:
|
||||
|
||||
```
|
||||
composer require silverstripe/iframe
|
||||
```
|
||||
|
||||
After installation, ensure you run `dev/build?flush` in either your browser or via command line.
|
||||
|
||||
## Instructions
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
title: IFrame page
|
||||
summary: Embed IFrames in your website without adding code
|
||||
summary: Embed IFrames in your website without adding custom code
|
||||
|
||||
# IFrame
|
||||
|
||||
@ -8,29 +8,31 @@ summary: Embed IFrames in your website without adding code
|
||||
* Create and modify an IFrame
|
||||
|
||||
## Before we begin
|
||||
Make sure that your SilverStripe installation has the [IFrame](http://addons.silverstripe.org/add-ons/silverstripe/iframe) module installed.
|
||||
Make sure that your SilverStripe installation has the [IFrame](https://addons.silverstripe.org/add-ons/silverstripe/iframe) module installed.
|
||||
|
||||
This module provides a page type that you can use to embed IFrames in your website.
|
||||
|
||||
## Creating an IFrame
|
||||
|
||||
IFrame pages are created like any other page. When you create a new page, selected the **I Frame Page** from the list of available page types.
|
||||
IFrame pages are created like any other page. When you create a new page, select the **IFrame Page** from the list of
|
||||
available page types.
|
||||
|
||||
There are a few new fields on an IFrame page.
|
||||
There are a few extra fields on an IFrame page which can help you to customise the IFrame that gets created on the
|
||||
frontend of your website.
|
||||
|
||||
The most important is *Iframe URL*: this is the URL that wish you display inside the IFrame. This can be an absolute
|
||||
path (ie, http://example.com/) or a relative path (ie, /about-us/). If it is a relative path then it will be assumed to
|
||||
be from the root of your site (ie, http://mysite.com/about-us/).
|
||||
The most important is *IFrame URL*: this is the URL that wish you display inside the IFrame. This can be an absolute
|
||||
path (e.g. `http://example.com/`) or a relative path (e.g. `/about-us/`). If it is a relative path then it will be assumed to
|
||||
be from the root of your site (e.g `http://mysite.com/about-us/`).
|
||||
|
||||
*Auto height* will change the height of the IFrame to match the total height of the remote page.
|
||||
"Auto height" will change the height of the IFrame to match the total height of the remote page.
|
||||
_This will only work if the remote page is hosted on the same domain._
|
||||
|
||||
If you check *Auto width* the IFrame will take up the entire width of the content area that it is in.
|
||||
If you check "Auto width" the IFrame will take up the entire width of the content area that it is in.
|
||||
|
||||
You can manually set the height and width with the *Fixed height* and *Fixed width* fields.
|
||||
The Auto width/height options must not be enabled for these fields to work.
|
||||
You can manually set the height and width with the "Fixed height" and "Fixed width" fields.
|
||||
The "Auto width/height" options must not be enabled for these fields to work.
|
||||
|
||||
The *Content* field has been broken up into three separate fields: one to display above the IFrame, one to display
|
||||
The "Content" field has been broken up into three separate fields: one to display above the IFrame, one to display
|
||||
beneath the IFrame, and another to display instead of the IFrame if the user has disabled them.
|
||||
|
||||
## Known Issues
|
||||
|
@ -1,4 +1,4 @@
|
||||
Copyright (c) 2017, SilverStripe Limited
|
||||
Copyright (c) 2019, SilverStripe Limited
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
|
||||
|
@ -2,7 +2,7 @@
|
||||
<ruleset name="SilverStripe">
|
||||
<description>CodeSniffer ruleset for SilverStripe coding conventions.</description>
|
||||
|
||||
<rule ref="PSR2" >
|
||||
<rule ref="PSR12" >
|
||||
<!-- Current exclusions -->
|
||||
<exclude name="PSR1.Methods.CamelCapsMethodName" />
|
||||
</rule>
|
||||
|
@ -2,11 +2,11 @@
|
||||
|
||||
namespace SilverStripe\IFrame;
|
||||
|
||||
use SilverStripe\CMS\Controllers\ContentController;
|
||||
use PageController;
|
||||
use SilverStripe\Control\Director;
|
||||
use SilverStripe\View\Requirements;
|
||||
|
||||
class IFramePageController extends ContentController
|
||||
class IFramePageController extends PageController
|
||||
{
|
||||
protected function init()
|
||||
{
|
||||
|
Loading…
Reference in New Issue
Block a user