tonyair/silverstripe-cms
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-cms synced 2024-06-29 07:59:37 +02:00
Code Issues Projects Releases Wiki Activity

Merge pull request #1769 from open-sausages/pulls/4.0/fix-description-clash

Browse Source 
API Rename SiteTree::description() to SiteTree::classDescription()
This commit is contained in:
Daniel Hensby 2017-03-30 15:03:47 +01:00 committed by GitHub
commit 018766d488
2 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
code/Controllers/CMSMain.php
View File

@ -636,7 +636,7 @@ class CMSMain extends LeftAndMain implements CurrentPageIdentifier, PermissionPr
} }
$singularName = $instance->i18n_singular_name(); $singularName = $instance->i18n_singular_name();
$description = $instance->i18n_description(); $description = $instance->i18n_classDescription();
$result->push(new ArrayData(array( $result->push(new ArrayData(array(
'ClassName' => $class, 'ClassName' => $class,

18
code/Model/SiteTree.php
View File

@ -321,8 +321,8 @@ class SiteTree extends DataObject implements PermissionProvider, i18nEntityProvi
* Description of the class functionality, typically shown to a user * Description of the class functionality, typically shown to a user
* when selecting which page type to create. Translated through {@link provideI18nEntities()}. * when selecting which page type to create. Translated through {@link provideI18nEntities()}.
* *
* @see SiteTree::description() * @see SiteTree::classDescription()
* @see SiteTree::i18n_description() * @see SiteTree::i18n_classDescription()
* *
* @config * @config
* @var string * @var string
@ -333,8 +333,8 @@ class SiteTree extends DataObject implements PermissionProvider, i18nEntityProvi
* Description for Page and SiteTree classes, but not inherited by subclasses. * Description for Page and SiteTree classes, but not inherited by subclasses.
* override SiteTree::$description in subclasses instead. * override SiteTree::$description in subclasses instead.
* *
* @see SiteTree::description() * @see SiteTree::classDescription()
* @see SiteTree::i18n_description() * @see SiteTree::i18n_classDescription()
* *
* @config * @config
* @var string * @var string
@ -3085,11 +3085,11 @@ class SiteTree extends DataObject implements PermissionProvider, i18nEntityProvi
} }
/** /**
* Get description for this page * Get description for this page type
* *
* @return string|null * @return string|null
*/ */
public function description() public function classDescription()
{ {
$base = in_array(static::class, [Page::class, self::class]); $base = in_array(static::class, [Page::class, self::class]);
if ($base) { if ($base) {
@ -3103,9 +3103,9 @@ class SiteTree extends DataObject implements PermissionProvider, i18nEntityProvi
* *
* @return string|null * @return string|null
*/ */
public function i18n_description() public function i18n_classDescription()
{ {
$description = $this->description(); $description = $this->classDescription();
if ($description) { if ($description) {
return _t(static::class.'.DESCRIPTION', $description); return _t(static::class.'.DESCRIPTION', $description);
} }
@ -3123,7 +3123,7 @@ class SiteTree extends DataObject implements PermissionProvider, i18nEntityProvi
$entities = parent::provideI18nEntities(); $entities = parent::provideI18nEntities();
// Add optional description // Add optional description
$description = $this->description(); $description = $this->classDescription();
if ($description) { if ($description) {
$entities[static::class . '.DESCRIPTION'] = $description; $entities[static::class . '.DESCRIPTION'] = $description;
} }