tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

Fix broken callout tags

Browse Source
This commit is contained in:
Aaron Carlino 2019-11-19 13:54:19 +13:00
parent 2facc7c80d
commit 9ae617932e
1 changed files with 71 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
docs/en/02_Developer_Guides/01_Templates/03_Requirements.md
View File

@ -13,6 +13,10 @@ coding any references in the `<head>` tag of your template, as it enables a more
**mysite/templates/Page.ss**
```
<% require css("cms/css/TreeSelector.css") %>
<% require themedCSS("TreeSelector") %>
<% require javascript("cms/javascript/LeftAndMain.js") %>
```
[alert]
@ -24,24 +28,48 @@ Requiring assets from the template is restricted compared to the PHP API.
It is common practice to include most Requirements either in the *init()*-method of your [controller](../controllers/), or
as close to rendering as possible (e.g. in [api:FormField]).
```php
<?php
class MyCustomController extends Controller {
public function init() {
parent::init();
Requirements::javascript("cms/javascript/LeftAndMain.js");
Requirements::css("cms/css/TreeSelector.css");
}
}
```
### CSS Files
```php
Requirements::css($path, $media);
```
If you're using the CSS method a second argument can be used. This argument defines the 'media' attribute of the
`<link>` element, so you can define 'screen' or 'print' for example.
```php
Requirements::css("cms/css/TreeSelector.css", "screen,projection");
```
### Javascript Files
```php
Requirements::javascript($path);
```
A variant on the inclusion of custom javascript is the inclusion of *templated* javascript. Here, you keep your
JavaScript in a separate file and instead load, via search and replace, several PHP-generated variables into that code.
```php
$vars = array(
"EditorCSS" => "cms/css/editor.css",
);
Requirements::javascriptTemplate("cms/javascript/editor.template.js", $vars);
```
In this example, `editor.template.js` is expected to contain a replaceable variable expressed as `$EditorCSS`.
@ -53,6 +81,18 @@ of 'configuration' from the database in a raw format. You'll need to use the `h
this is generally speaking the best way to do these things - it clearly marks the copy as belonging to a different
language.
```php
Requirements::customScript(<<<JS
alert("hi there");
JS
);
Requirements::customCSS(<<<CSS
.tree li.$className {
background-image: url($icon);
}
CSS
);
```
## Combining Files
@ -60,6 +100,14 @@ language.
You can concatenate several CSS or javascript files into a single dynamically generated file. This increases performance
by reducing HTTP requests.
```php
Requirements::combine_files(
'foobar.js',
array(
'mysite/javascript/foo.js',
'mysite/javascript/bar.js',
)
);
```
[alert]
@ -72,16 +120,26 @@ By default it stores the generated file in the assets/ folder, but you can confi
**mysite/_config/app.yml**
```yaml
Requirements:
combined_files_folder: '_combined'
```
[info]
<div class="info" markdown='1'>
If SilverStripe doesn't have permissions on your server to write these files it will default back to including them
individually. SilverStripe **will not** rewrite your paths within the file.
[/info]
</div>
You can also combine CSS files into a media-specific stylesheets as you would with the `Requirements::css` call - use
the third paramter of the `combine_files` function:
```php
$printStylesheets = array(
"$themeDir/css/print_HomePage.css",
"$themeDir/css/print_Page.css",
);
Requirements::combine_files('print.css', $printStylesheets, 'print');
```
By default, all requirements files are flushed (deleted) when ?flush querystring parameter is set.
@ -89,10 +147,14 @@ This can be disabled by setting the `Requirements.disable_flush_combined` config
## Clearing assets
```php
Requirements::clear();
```
Clears all defined requirements. You can also clear specific requirements.
```php
Requirements::clear(THIRDPARTY_DIR.'/prototype.js');
```
[alert]
@ -108,6 +170,8 @@ included requirements, and ones included after the `block()` call.
One common example is to block the core `jquery.js` added by various form fields and core controllers, and use a newer
version in a custom location. This assumes you have tested your application with the newer version.
```php
Requirements::block(THIRDPARTY_DIR . '/jquery/jquery.js');
```
[alert]
@ -130,6 +194,8 @@ careful when messing with the order of requirements.
By default, SilverStripe includes all Javascript files at the bottom of the page body, unless there's another script
already loaded, then, it's inserted before the first `<script>` tag. If this causes problems, it can be configured.
```php
Requirements::set_force_js_to_bottom(true);
```
`Requirements.force_js_to_bottom`, will force SilverStripe to write the Javascript to the bottom of the page body, even
@ -138,8 +204,10 @@ if there is an earlier script tag.
If the Javascript files are preferred to be placed in the `<head>` tag rather than in the `<body>` tag,
`Requirements.write_js_to_body` should be set to false.
```php
Requirements::set_write_js_to_body(false);
```
## API Documentation
* [api:Requirements]
* [api:Requirements]