MINOR Documentation

git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/cms/trunk@71387 467b73ca-7a2a-4603-9d3b-597d59a354a9
This commit is contained in:
Ingo Schommer 2009-02-04 20:18:12 +00:00
parent 173c495afe
commit bcbdfe2a13
3 changed files with 17 additions and 4 deletions

View File

@ -2,6 +2,11 @@
/** /**
* Usage: Object::add_extension("SiteTree", "FilesystemPublisher('../static-folder/')") * Usage: Object::add_extension("SiteTree", "FilesystemPublisher('../static-folder/')")
*
* @see http://doc.silverstripe.com/doku.php?id=staticpublisher
*
* @package cms
* @subpackage publishers
*/ */
class FilesystemPublisher extends StaticPublisher { class FilesystemPublisher extends StaticPublisher {
protected $destFolder; protected $destFolder;
@ -136,9 +141,6 @@ class FilesystemPublisher extends StaticPublisher {
} }
if(self::$static_base_url) Director::setBaseURL(null); if(self::$static_base_url) Director::setBaseURL(null);
//Debug::show(array_keys($files));
//Debug::show(array_keys($missingFiles));
$base = "../$this->destFolder"; $base = "../$this->destFolder";
foreach($files as $file) { foreach($files as $file) {

View File

@ -3,6 +3,11 @@
/** /**
* This static publisher can be used to deploy static content to multiple hosts, by generating the cache files locally and then rsyncing then to * This static publisher can be used to deploy static content to multiple hosts, by generating the cache files locally and then rsyncing then to
* each destination box. This can be used to set up a load-balanced collection of static servers. * each destination box. This can be used to set up a load-balanced collection of static servers.
*
* @see http://doc.silverstripe.com/doku.php?id=staticpublisher
*
* @package cms
* @subpackage publishers
*/ */
class RsyncMultiHostPublisher extends FilesystemPublisher { class RsyncMultiHostPublisher extends FilesystemPublisher {
/** /**
@ -12,6 +17,9 @@ class RsyncMultiHostPublisher extends FilesystemPublisher {
/** /**
* Set the targets to publish to. * Set the targets to publish to.
* If target is an scp-style remote path, no password is accepted - we assume key-based authentication to be set up on the application server
* initiating the publication.
*
* @param $targets An array of targets to publish to. These can either be local file names, or scp-style targets, in the form "user@server:path" * @param $targets An array of targets to publish to. These can either be local file names, or scp-style targets, in the form "user@server:path"
*/ */
static function set_targets($targets) { static function set_targets($targets) {

View File

@ -1,5 +1,8 @@
<?php <?php
/**
* @package cms
* @subpackage publishers
*/
abstract class StaticPublisher extends DataObjectDecorator { abstract class StaticPublisher extends DataObjectDecorator {
/** /**
* Defines whether to output information about publishing or not. By * Defines whether to output information about publishing or not. By