silverstripe / silverstripe-staticpublishqueue

code/model/StaticPagesQueue.php

Doc Comments +3 added lines, -3 removed lines

@@ -151,8 +151,9 @@ 
 	 * If we are using MySQLDatabase with InnoDB, we do row-level locking when updating the dataobject to allow for
 	 * distributed cache rebuilds
 	 * @static
-	 * @param $freshness
+	 * @param string $freshness
 	 * @param $sortOrder
+	 * @param string $interval
 	 */
 	protected static function get_queue_object($freshness, $interval = null, $sortOrder = array('Priority'=>'DESC', 'ID'=>'ASC')) {
 		$className = __CLASS__;
@@ -254,7 +255,7 @@ 
 	 * Removes all duplicates that has the same URLSegment as $ID
 	 *
 	 * @param int $ID - ID of the object whose duplicates we want to remove
-	 * @return void
+	 * @return integer|null
 	 */
 	static function remove_duplicates( $ID ) {
 		$obj = DataObject::get_by_id('StaticPagesQueue', $ID);
@@ -267,7 +268,6 @@ 
 	/**
 	 *
 	 * @param string $url
-	 * @param bool $onlyStale - Get only stale entries
 	 * @return DataObject || false - The first item matching the query
 	 */
 	protected static function get_by_link($url) {

code/model/StaticPagesQueueEvent.php

Doc Comments +1 added lines, -1 removed lines

@@ -54,7 +54,7 @@
 
 	/**
 	 *
-	 * @param StaticPagesQueue $eventClass
+	 * @param StaticPagesQueueEvent $eventClass
 	 * @return bool - if the event was fired or not
 	 * @throws Exception 
 	 */

code/reports/BuildStaticCacheSummaryReport.php

Doc Comments +1 added lines, -1 removed lines

@@ -45,7 +45,7 @@
 	 * @param unknown $params
 	 * @param array $sort
 	 * @param int $limit
-	 * @return DataObjectSet or false
+	 * @return DataList or false
 	 */
 	function sourceRecords($params, $sort, $limit) {
 		if($sort) {

code/reports/StaticPagesQueueReport.php

Doc Comments +1 added lines, -1 removed lines

@@ -27,7 +27,7 @@
 	 * @param array $params
 	 * @param array $sort
 	 * @param int $limit
-	 * @return DataObjectSet or false
+	 * @return ArrayList or false
 	 */
 	public function sourceRecords(array $params, $sort, $limit) {
 		if($sort) {

code/tasks/BuildStaticCacheFromQueue.php

Doc Comments +4 added lines, -2 removed lines

@@ -157,7 +157,7 @@ 
 	 * If a SubsiteID GET parameter is found in the URL, the page is generated into a directory,
 	 * regardless if it's from the main site or subsite.
 	 *
-	 * @param array $URLSegments
+	 * @param string[] $URLSegments
 	 */
 	protected function createCachedFiles(array $URLSegments) {
 		$results = array();
@@ -302,6 +302,8 @@ 
 	/**
 	 *
 	 * @param int $publishedPages - the number of pages published so far
+	 * @param boolean $finished
+	 * @param double $prePublishTime
 	 */
 	protected function logSummary( $publishedPages, $finished, $prePublishTime ) {
 		if(!$publishedPages) {
@@ -345,6 +347,7 @@ 
 	 * Check if another instance is running with the regard to a timelimit.
 	 *
 	 * @var int $secondsBeforeDead
+	 * @param integer $secondsBeforeDead
 	 * @return bool
 	 */
 	protected function anotherInstanceRunning($secondsBeforeDead) {
@@ -369,7 +372,6 @@ 
 	/**
 	 * Adds information to the pid file
 	 *
-	 * @param float $microtime
 	 * @return void
 	 */
 	protected function updatePid() {

code/tasks/SiteTreeFullBuildEngine.php

Doc Comments +2 added lines, -2 removed lines

@@ -46,7 +46,7 @@ 
 	/**
 	 * 
 	 * @param SS_HTTPRequest $request
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public function run($request) {
 
@@ -89,7 +89,7 @@ 
 
 	/**
 	 * Process a chunk of pages
-	 * @param $start
+	 * @param integer $start
 	 */
 	protected function runFrom($start) {
 		$chunkSize = (int)self::config()->records_per_request;

code/model/FilesystemPublisher.php

Doc Comments +2 added lines, -2 removed lines

@@ -78,7 +78,7 @@ 
 	/**
 	 * @param $destFolder The folder to save the cached site into.
 	 *   This needs to be set in framework/static-main.php as well through the {@link $cacheBaseDir} variable.
-	 * @param $fileExtension  The file extension to use, e.g 'html'.  
+	 * @param string $fileExtension  The file extension to use, e.g 'html'.  
 	 *   If omitted, then each page will be placed in its own directory, 
 	 *   with the filename 'index.html'.  If you set the extension to PHP, then a simple PHP script will
 	 *   be generated that can do appropriate cache & redirect header negotation.
@@ -449,7 +449,7 @@ 
 	/**
 	 * @param string $url
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public function getMetadata($url) {
 		return array(

tests/unit/SiteTreePublishingEngineTest.php

Doc Comments +4 added lines

@@ -257,6 +257,10 @@
 
 class SiteTreePublishingEngineTest_StaticPublishingTrigger extends SiteTree implements TestOnly, StaticPublishingTrigger {
 
+	/**
+	 * @param string $url
+	 * @param integer $prio
+	 */
 	public function generatePublishable($url, $prio) {
 		$obj = Object::create('SiteTreePublishingEngineTest_StaticallyPublishable');
 		$obj->url = $url;