tonyair/silverstripe-docsviewer
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-docsviewer synced 2024-10-22 09:05:56 +00:00
Code Issues Projects Releases Wiki Activity

ENHANCEMENT Added setCurrentVersion()

Browse Source
This commit is contained in:
Ingo Schommer 2010-08-01 07:03:48 +00:00
parent 281e6e1ea7
commit a013923106
2 changed files with 50 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
code/DocumentationEntity.php
View File

@ -8,6 +8,10 @@
*
* Each folder must have at least one language subfolder, which is automatically
* determined through {@link addVersion()} and should not be included in the $path argument.
*
* Versions are assumed to be in numeric format (e.g. '2.4'),
* mainly as an easy way to distinguish them from language codes in the routing logic.
* They're also parsed through version_compare() in {@link getCurrentVersion()} which assumes a certain format.
*
* @package sapphiredocs
*/
@ -33,6 +37,11 @@ class DocumentationEntity extends ViewableData {
*/
private $versions = array();
/**
* @var Array
*/
private $currentVersion;
/**
* @var Array $langs a list of available langauges
*/
@ -111,6 +120,30 @@ class DocumentationEntity extends ViewableData {
return array_keys($this->versions);
}
/**
* @return String|Boolean
*/
public function getCurrentVersion() {
if(!$this->hasVersions()) return false;
if($this->currentVersion) {
return $this->currentVersion;
} else {
$sortedVersions = $this->getVersions();
usort($sortedVersions, create_function('$a,$b', 'return version_compare($a,$b);'));
return array_pop($sortedVersions);
}
}
/**
* @param String $version
*/
public function setCurrentVersion($version) {
if(!$this->hasVersion($version)) throw new InvalidArgumentException(sprintf('Version "%s" does not exist', $version));
$this->currentVersion = $version;
}
/**
* Return whether we have a given version of this entity
*
@ -134,8 +167,9 @@ class DocumentationEntity extends ViewableData {
*
* @param Float $version Version number
* @param String $path path to folder
* @param Boolean $current
*/
public function addVersion($version = '', $path) {
public function addVersion($version = '', $path, $current = false) {
// determine the langs in this path
$langs = scandir($path);
@ -154,6 +188,8 @@ class DocumentationEntity extends ViewableData {
$this->addLanguage($available);
$this->versions[$version] = $path;
if($current) $this->setCurrentVersion($version);
}
/**

13
tests/DocumentationEntityTest.php
View File

@ -18,4 +18,17 @@ class DocumentationEntityTest extends SapphireTest {
$this->assertTrue($entity->hasLanguage('en'));
$this->assertFalse($entity->hasLanguage('fr'));
}
function testGetCurrentVersion() {
$entity = new DocumentationEntity('docs', '1.0', '../sapphiredocs/tests/docs/', 'My Test');
$entity->addVersion('1.1', '../sapphiredocs/tests/docs-2/');
$entity->addVersion('0.0', '../sapphiredocs/tests/docs-3/');
$this->assertEquals('1.1', $entity->getCurrentVersion(), 'Automatic version sorting');
$entity = new DocumentationEntity('docs', '1.0', '../sapphiredocs/tests/docs/', 'My Test');
$entity->addVersion('1.1.', '../sapphiredocs/tests/docs-2/');
$entity->setCurrentVersion('1.0');
$this->assertEquals('1.0', $entity->getCurrentVersion(), 'Manual setting');
}
}