Merge pull request #1283 from spekulatius/fixing-phpdoc-blocks

fixing phpdoc blocks to refering to Objects to built-in types of PHP
This commit is contained in:
Damian Mooyman 2015-10-06 11:46:37 +13:00
commit 65492d8de0
9 changed files with 19 additions and 19 deletions

View File

@ -422,7 +422,7 @@ class CMSMain extends LeftAndMain implements CurrentPageIdentifier, PermissionPr
* Create serialized JSON string with site tree hints data to be injected into
* 'data-hints' attribute of root node of jsTree.
*
* @return String Serialized JSON
* @return string Serialized JSON
*/
public function SiteTreeHints() {
$json = '';
@ -591,7 +591,7 @@ class CMSMain extends LeftAndMain implements CurrentPageIdentifier, PermissionPr
}
/**
* @param Int $id
* @param int $id
* @param FieldList $fields
* @return Form
*/
@ -701,7 +701,7 @@ class CMSMain extends LeftAndMain implements CurrentPageIdentifier, PermissionPr
/**
* @param SS_HTTPRequest $request
* @return String HTML
* @return string HTML
*/
public function treeview($request) {
return $this->renderWith($this->getTemplatesWithSuffix('_TreeView'));
@ -709,7 +709,7 @@ class CMSMain extends LeftAndMain implements CurrentPageIdentifier, PermissionPr
/**
* @param SS_HTTPRequest $request
* @return String HTML
* @return string HTML
*/
public function listview($request) {
return $this->renderWith($this->getTemplatesWithSuffix('_ListView'));

View File

@ -17,7 +17,7 @@ class CMSPagesController extends CMSMain {
}
/**
* @return String
* @return string
*/
public function ViewState() {
return $this->getRequest()->getVar('view');

View File

@ -44,7 +44,7 @@ abstract class CMSSiteTreeFilter extends Object implements LeftAndMain_SearchFil
protected $_cache_expanded = array();
/**
* @var String
* @var string
*/
protected $childrenMethod = null;

View File

@ -15,7 +15,7 @@ class LeftAndMainPageIconsExtension extends Extension {
* Include CSS for page icons. We're not using the JSTree 'types' option
* because it causes too much performance overhead just to add some icons.
*
* @return String CSS
* @return string CSS
*/
public function generatePageIconsCss() {
$css = '';

View File

@ -120,13 +120,13 @@ class SilverStripeNavigatorItem extends ViewableData {
}
/**
* @return String HTML, mostly a link - but can be more complex as well.
* @return string HTML, mostly a link - but can be more complex as well.
* For example, a "future state" item might show a date selector.
*/
public function getHTML() {}
/**
* @return String
* @return string
* Get the Title of an item
*/
public function getTitle() {}
@ -143,12 +143,12 @@ class SilverStripeNavigatorItem extends ViewableData {
* Not all items are simple links, please use {@link getHTML()}
* to represent an item in markup unless you know what you're doing.
*
* @return String
* @return string
*/
public function getLink() {}
/**
* @return String
* @return string
*/
public function getMessage() {}
@ -160,7 +160,7 @@ class SilverStripeNavigatorItem extends ViewableData {
}
/**
* @return Int
* @return int
*/
public function getPriority() {
return $this->stat('priority');

View File

@ -280,7 +280,7 @@ class ErrorPage extends Page {
* which is generated through {@link publish()}.
*
* @param int $statusCode A HTTP Statuscode, mostly 404 or 500
* @param String $locale A locale, e.g. 'de_DE' (Optional)
* @param string $locale A locale, e.g. 'de_DE' (Optional)
*
* @return string
*/

View File

@ -177,7 +177,7 @@ class SiteTree extends DataObject implements PermissionProvider,i18nEntityProvid
/**
* @config
* @var String Description of the class functionality, typically shown to a user
* @var string Description of the class functionality, typically shown to a user
* when selecting which page type to create. Translated through {@link provideI18nEntities()}.
*/
private static $description = 'Generic content page';

View File

@ -24,7 +24,7 @@ class SiteTreeFileExtension extends DataExtension {
/**
* Generate an HTML list which provides links to where a file is used.
*
* @return String
* @return string
*/
public function BackLinkHTMLList() {
$html = '<em>' . _t('SiteTreeFileExtension.BACKLINK_LIST_DESCRIPTION', 'This list shows all pages where the file has been added through a WYSIWYG editor.') . '</em>';
@ -91,7 +91,7 @@ class SiteTreeFileExtension extends DataExtension {
/**
* @todo Unnecessary shortcut for AssetTableField, coupled with cms module.
*
* @return Integer
* @return integer
*/
public function BackLinkTrackingCount() {
$pages = $this->owner->BackLinkTracking();
@ -133,8 +133,8 @@ class SiteTreeFileExtension extends DataExtension {
*
* @uses SiteTree->rewriteFileURL()
*
* @param String $old File path relative to the webroot
* @param String $new File path relative to the webroot
* @param string $old File path relative to the webroot
* @param string $new File path relative to the webroot
*/
public function updateLinks($old, $new) {
if(class_exists('Subsite')) Subsite::disable_subsite_filter(true);

View File

@ -26,7 +26,7 @@ class FeatureContext extends \SilverStripe\Framework\Test\Behaviour\FeatureConte
* Initializes context.
* Every scenario gets it's own context object.
*
* @param array $parameters context parameters (set them up through behat.yml)
* @param array $parameters context parameters (set them up through behat.yml)
*/
public function __construct(array $parameters) {
parent::__construct($parameters);