Update example theme with App URLs and PHPDoc

This commit is contained in:
Morris Jobke 2015-10-05 11:15:14 +02:00
parent 56c35da8d5
commit ed2ed4be8d
1 changed files with 81 additions and 0 deletions

View File

@ -20,34 +20,106 @@
class OC_Theme { class OC_Theme {
/**
* Returns the base URL
* @return string URL
*/
public function getBaseUrl() { public function getBaseUrl() {
return 'https://owncloud.org'; return 'https://owncloud.org';
} }
/**
* Returns the URL where the sync clients are listed
* @return string URL
*/
public function getSyncClientUrl() { public function getSyncClientUrl() {
return 'https://owncloud.org/install'; return 'https://owncloud.org/install';
} }
/**
* Returns the URL to the App Store for the iOS Client
* @return string URL
*/
public function getiOSClientUrl() {
return 'https://itunes.apple.com/us/app/owncloud/id543672169?mt=8';
}
/**
* Returns the AppId for the App Store for the iOS Client
* @return string AppId
*/
public function getiTunesAppId() {
return '543672169';
}
/**
* Returns the URL to Google Play for the Android Client
* @return string URL
*/
public function getAndroidClientUrl() {
return 'https://play.google.com/store/apps/details?id=com.owncloud.android';
}
/**
* Returns the documentation URL
* @return string URL
*/
public function getDocBaseUrl() { public function getDocBaseUrl() {
return 'https://doc.owncloud.org'; return 'https://doc.owncloud.org';
} }
/**
* Returns the title
* @return string title
*/
public function getTitle() { public function getTitle() {
return 'Custom Cloud'; return 'Custom Cloud';
} }
/**
* Returns the short name of the software
* @return string title
*/
public function getName() { public function getName() {
return 'Custom Cloud'; return 'Custom Cloud';
} }
/**
* Returns the short name of the software containing HTML strings
* @return string title
*/
public function getHTMLName() {
return 'Custom Cloud';
}
/**
* Returns entity (e.g. company name) - used for footer, copyright
* @return string entity name
*/
public function getEntity() { public function getEntity() {
return 'Custom Cloud Co.'; return 'Custom Cloud Co.';
} }
/**
* Returns slogan
* @return string slogan
*/
public function getSlogan() { public function getSlogan() {
return 'Your custom cloud, personalized for you!'; return 'Your custom cloud, personalized for you!';
} }
/**
* Returns logo claim
* @return string logo claim
*/
public function getLogoClaim() {
return '';
}
/**
* Returns short version of the footer
* @return string short footer
*/
public function getShortFooter() { public function getShortFooter() {
$footer = '© 2015 <a href="'.$this->getBaseUrl().'" target="_blank\">'.$this->getEntity().'</a>'. $footer = '© 2015 <a href="'.$this->getBaseUrl().'" target="_blank\">'.$this->getEntity().'</a>'.
'<br/>' . $this->getSlogan(); '<br/>' . $this->getSlogan();
@ -55,6 +127,10 @@ class OC_Theme {
return $footer; return $footer;
} }
/**
* Returns long version of the footer
* @return string long footer
*/
public function getLongFooter() { public function getLongFooter() {
$footer = '© 2015 <a href="'.$this->getBaseUrl().'" target="_blank\">'.$this->getEntity().'</a>'. $footer = '© 2015 <a href="'.$this->getBaseUrl().'" target="_blank\">'.$this->getEntity().'</a>'.
'<br/>' . $this->getSlogan(); '<br/>' . $this->getSlogan();
@ -66,6 +142,11 @@ class OC_Theme {
return $this->getDocBaseUrl() . '/server/8.0/go.php?to=' . $key; return $this->getDocBaseUrl() . '/server/8.0/go.php?to=' . $key;
} }
/**
* Returns mail header color
* @return string
*/
public function getMailHeaderColor() { public function getMailHeaderColor() {
return '#745bca'; return '#745bca';
} }