Skip to content

Commit

Permalink
Fixed markdown whitespace usage
Browse files Browse the repository at this point in the history
  • Loading branch information
chillu committed Oct 2, 2012
1 parent fe4f0c9 commit 4684601
Show file tree
Hide file tree
Showing 9 changed files with 20 additions and 32 deletions.
2 changes: 1 addition & 1 deletion docs/en/howto/grouping-dataobjectsets.md
Expand Up @@ -117,7 +117,7 @@ sorted by month name from January to December. This can be accomplshed by sortin
class Page extends SiteTree {
// ...

/**
* Returns all news items, sorted by the month they were posted
* @return GroupedList
Expand Down
1 change: 0 additions & 1 deletion docs/en/reference/execution-pipeline.md
Expand Up @@ -30,7 +30,6 @@ The basic .htaccess file after installing SilverStripe look like this:
RewriteRule .* framework/main.php?url=%1&%{QUERY_STRING} [L]
</IfModule>
### SILVERSTRIPE END ###

</file>

The `<Files>` section denies direct access to the template files from anywhere but the server itself.
Expand Down
6 changes: 3 additions & 3 deletions docs/en/reference/injector.md
Expand Up @@ -61,7 +61,7 @@ The subsequent call returns the SAME object as the first call.
// set by the injector on object creation
public $permissions;
public $textProperty;

static $dependencies = array(
'textProperty' => 'a string value',
'permissions' => '%$PermissionService',
Expand Down Expand Up @@ -123,11 +123,11 @@ Assuming a class structure such as
$this->database = $d;
}
}

class MySQLDatabase {
private $username;
private $password;

public function __construct($username, $password) {
$this->username = $username;
$this->password = $password;
Expand Down
1 change: 0 additions & 1 deletion docs/en/reference/member.md
Expand Up @@ -34,7 +34,6 @@ Returns the full *Member* Object for the current user, returns *null* if user is
}



## Subclassing

<div class="warning" markdown="1">
Expand Down
15 changes: 6 additions & 9 deletions docs/en/reference/restfulservice.md
Expand Up @@ -49,7 +49,7 @@ RestfulService (see [flickrservice](http://silverstripe.org/flickr-module/) and
$peopleXML = $service->connect('/people');
$people = $service->getValues($peopleXML, 'user');

...
// ...

$taskXML = $service->connect('/tasks');
$tasks = $service->getValues($taskXML, 'task');
Expand Down Expand Up @@ -117,16 +117,13 @@ If the web service returned an error (for example, API key not available or inad
could delgate the error handling to it's descendant class. To handle the errors define a function called errorCatch

:::php
/*
This will raise Youtube API specific error messages (if any).

*/
// This will raise Youtube API specific error messages (if any).
public function errorCatch($response){
$err_msg = $response;
if(strpos($err_msg, '<') === false)
//user_error("YouTube Service Error : $err_msg", E_USER_ERROR);
user_error("YouTube Service Error : $err_msg", E_USER_ERROR);
else
if(strpos($err_msg, '<') === false) {
user_error("YouTube Service Error : $err_msg", E_USER_ERROR);
}
return $response;
}

Expand Down
13 changes: 6 additions & 7 deletions docs/en/reference/site-reports.md
Expand Up @@ -31,13 +31,13 @@ CustomSideReport.php
<?php
class CustomSideReport_NameOfReport extends SideReport {
public function title() {
// the name of our report
// the name of our report
}
public function records() {
// what we want the report to return and what order
// what we want the report to return and what order
}
public function fieldsToShow() {
// which fields on that object do we want to show? Title, Author?
// which fields on that object do we want to show? Title, Author?
}
}
?>
Expand All @@ -52,23 +52,22 @@ CustomSideReport.php
:::php
<?php
/**

* This report lists all the pages in the CMS
* of type Page. Sorted by title.
*/
class CustomSideReport_AllPages extends SideReport {
public function title() {
// this is the title of the report
// this is the title of the report
return "All Pages";
}
public function records() {
// the data the report returns all the dataobjects of type Page and sorted by title. See datamodel for more info
// the data the report returns all the dataobjects of type Page and sorted by title. See datamodel for more info
return Page::get()->sort("Title");
}
public function fieldsToShow() {
// fields you want to display. This will display a list of titles which link to the page in the cms. Handy!
// fields you want to display. This will display a list of titles which link to the page in the cms. Handy!
return array(
"Title" => array("NestedTitle", array("2")),
);
Expand Down
2 changes: 1 addition & 1 deletion docs/en/reference/templates.md
Expand Up @@ -21,7 +21,7 @@ Here is a very simple template:
<header>
<h1>Bob's Chicken Shack</h1>
</header>

<% with $CurrentMember %>
<p>Welcome $FirstName $Surname.</p>
<% end_with %>
Expand Down
1 change: 0 additions & 1 deletion docs/en/topics/datamodel.md
Expand Up @@ -276,7 +276,6 @@ For example:
:::php
// Without an alias
$members = Member::get()->leftJoin("Group_Members", "\"Group_Members\".\"MemberID\" = \"Member\".\"ID\"");

$members = Member::get()->innerJoin("Group_Members", "\"Rel\".\"MemberID\" = \"Member\".\"ID\"", "REl");

Passing a *$join* statement to DataObject::get will filter results further by the JOINs performed against the foreign
Expand Down
11 changes: 3 additions & 8 deletions docs/en/tutorials/2-extending-a-basic-site.md
Expand Up @@ -193,7 +193,6 @@ the date field will have the date format defined by your locale.

:::php
<?php

class ArticlePage extends Page {

// .....
Expand Down Expand Up @@ -356,26 +355,24 @@ It would be nice to greet page visitors with a summary of the latest news when t
**mysite/code/HomePage.php**

:::php
...
// ...
public function LatestNews($num=5) {
$holder = ArticleHolder::get()->First();
return ($holder) ? ArticlePage::get()->filter('ParentID', $holder->ID)->sort('Date DESC')->limit($num) : false;
}
...


This function simply runs a database query that gets the latest news articles from the database. By default, this is five, but you can change it by passing a number to the function. See the [Data Model](../topics/datamodel) documentation for details. We can reference this function as a page control in our *HomePage* template:

**themes/simple/templates/Layout/Homepage.ss**

:::ss
...
<div class="content">$Content</div>
<!-- ... -->
<div class="content">$Content</div>
</article>
<% loop LatestNews %>
<% include ArticleTeaser %>
<% end_loop %>
...


When SilverStripe comes across a variable or page control it doesn't recognize, it first passes control to the controller. If the controller doesn't have a function for the variable or page control, it then passes control to the data object. If it has no matching functions, it then searches its database fields. Failing that it will return nothing.
Expand Down Expand Up @@ -444,7 +441,6 @@ Nothing here should be new. The *StaffPage* page type is more interesting though

:::php
<?php

class StaffPage extends Page {
static $db = array(
);
Expand All @@ -462,7 +458,6 @@ Nothing here should be new. The *StaffPage* page type is more interesting though
}

class StaffPage_Controller extends Page_Controller {
}


Expand Down

0 comments on commit 4684601

Please sign in to comment.