chore(legacy): format code

This commit is contained in:
jo 2022-09-12 13:16:14 +02:00 committed by Jonas L
parent da52f495b4
commit 63d9e430e1
33 changed files with 111 additions and 102 deletions

View File

@ -31,9 +31,9 @@ class CeleryManager
* @param $exchange string the amqp exchange name
* @param $queue string the amqp queue name
*
* @throws Exception when a connection error occurs
*
* @return Celery the Celery connection object
*
* @throws Exception when a connection error occurs
*/
private static function _setupCeleryExchange($config, $exchange, $queue)
{
@ -76,11 +76,11 @@ class CeleryManager
*
* @param $task CeleryTasks the Celery task object
*
* @return array the message response array
*
* @throws CeleryException when no message is found
* @throws CeleryTimeoutException when no message is found and more than
* $_CELERY_MESSAGE_TIMEOUT milliseconds have passed
*
* @return array the message response array
*/
private static function getAsyncResultMessage($task)
{
@ -183,10 +183,10 @@ class CeleryManager
*
* @param $task CeleryTasks the Celery task object
*
* @return object the task message object
*
* @throws CeleryException when the result message for this task is still pending
* @throws CeleryTimeoutException when the result message for this task no longer exists
*
* @return object the task message object
*/
protected static function _getTaskMessage($task)
{

View File

@ -59,9 +59,9 @@ class FileDataHelper
*
* @param string $mime
*
* @throws Exception
*
* @return string file extension with(!) a dot (for convenience)
*
* @throws Exception
*/
public static function getFileExtensionFromMime($mime)
{

View File

@ -10,6 +10,6 @@ class Application_Common_Storage
return null;
}
return [$storage_path, substr($p_filepath, strlen($storage_path))];
return [$storage_path, substr($p_filepath, strlen($storage_path))];
}
}

View File

@ -849,8 +849,9 @@ class Application_Form_SmartBlockCriteria extends Zend_Form_SubForm
$element->addError(_("'Length' should be in '00:00:00' format"));
$isValid = false;
}
// this looks up the column type for the criteria the modified time, upload time etc.
} elseif ($column->getType() == PropelColumnTypes::TIMESTAMP) {
}
// this looks up the column type for the criteria the modified time, upload time etc.
elseif ($column->getType() == PropelColumnTypes::TIMESTAMP) {
// need to check for relative modifiers first - bypassing currently
if (in_array($d['sp_criteria_modifier'], ['before', 'after', 'between'])) {
if (!preg_match('/^[1-9][0-9]*$|0/', $d['sp_criteria_value'])) {

View File

@ -66,7 +66,7 @@ class Application_Form_StreamSettingSubForm extends Zend_Form_SubForm
$output
->setLabel(_('Service Type:'))
->setAttrib('readonly', true)
->setValue((isset($setting[$prefix . '_output']) ? $setting[$prefix . '_output'] : 'icecast'))
->setValue(isset($setting[$prefix . '_output']) ? $setting[$prefix . '_output'] : 'icecast')
->setDecorators(['ViewHelper']);
$this->addElement($output);
@ -82,7 +82,7 @@ class Application_Form_StreamSettingSubForm extends Zend_Form_SubForm
$host
->setLabel(_('Server'))
->setAttrib('readonly', true)
->setValue((isset($setting[$prefix . '_host']) ? $setting[$prefix . '_host'] : ''))
->setValue(isset($setting[$prefix . '_host']) ? $setting[$prefix . '_host'] : '')
->setDecorators(['ViewHelper']);
$host->setAttrib('alt', 'domain');
$this->addElement($host);
@ -91,7 +91,7 @@ class Application_Form_StreamSettingSubForm extends Zend_Form_SubForm
$port
->setLabel(_('Port'))
->setAttrib('readonly', true)
->setValue((isset($setting[$prefix . '_port']) ? $setting[$prefix . '_port'] : ''))
->setValue(isset($setting[$prefix . '_port']) ? $setting[$prefix . '_port'] : '')
->setDecorators(['ViewHelper']);
$this->addElement($port);
@ -99,7 +99,7 @@ class Application_Form_StreamSettingSubForm extends Zend_Form_SubForm
$mount
->setLabel(_('Mount Point'))
->setAttrib('readonly', true)
->setValue((isset($setting[$prefix . '_mount']) ? $setting[$prefix . '_mount'] : ''))
->setValue(isset($setting[$prefix . '_mount']) ? $setting[$prefix . '_mount'] : '')
->setDecorators(['ViewHelper']);
$mount->setAttrib('alt', 'regular_text');
$this->addElement($mount);

View File

@ -782,8 +782,6 @@ final class Application_Model_Scheduler
++$pos;
}
// $pos++;
}
// selected empty row to add after
else {

View File

@ -584,9 +584,9 @@ SQL;
* @param Propel Connection
* @param null|mixed $con
*
* @throws Exception
*
* @return Application_Model_StoredFile
*
* @throws Exception
*/
public static function RecallById($p_id = null, $con = null)
{
@ -914,9 +914,9 @@ SQL;
* @param string $originalFilename
* @param bool $copyFile copy the file instead of moving it
*
* @throws Exception
*
* @return Ambigous <unknown, string>
*
* @throws Exception
*/
public static function moveFileToStor($tempFilePath, $originalFilename, $copyFile = false)
{

View File

@ -6,7 +6,7 @@ class Application_Model_StreamConfig
{
private static function toOutputKey($id)
{
return 's' . ($id);
return 's' . $id;
}
private static function toOutputId($key)

View File

@ -80,8 +80,9 @@ class Application_Model_Systemstatus
if ($pid->length == 0) {
$data = $notRunning;
}
// running!
} elseif ($status == 0) {
}
// running!
elseif ($status == 0) {
$data = $notMonitored;
}
}

View File

@ -15,9 +15,9 @@ class CcBlock extends BaseCcBlock
* @param string $format The date/time format string (either date()-style or strftime()-style).
* If format is NULL, then the raw DateTime object will be returned.
*
* @throws propelException - if unable to parse/validate the date/time value
*
* @return mixed Formatted date/time value as string or DateTime object (if format is NULL), NULL if column is NULL
*
* @throws propelException - if unable to parse/validate the date/time value
*/
public function getDbUtime($format = 'Y-m-d H:i:s')
{
@ -48,9 +48,9 @@ class CcBlock extends BaseCcBlock
* @param string $format The date/time format string (either date()-style or strftime()-style).
* If format is NULL, then the raw DateTime object will be returned.
*
* @throws propelException - if unable to parse/validate the date/time value
*
* @return mixed Formatted date/time value as string or DateTime object (if format is NULL), NULL if column is NULL
*
* @throws propelException - if unable to parse/validate the date/time value
*/
public function getDbMtime($format = 'Y-m-d H:i:s')
{

View File

@ -14,9 +14,9 @@ class CcBlockcontents extends BaseCcBlockcontents
*
* @param mixed $format
*
* @throws propelException - if unable to parse/validate the date/time value
*
* @return mixed Formatted date/time value as string or DateTime object (if format is NULL), NULL if column is NULL
*
* @throws propelException - if unable to parse/validate the date/time value
*/
public function getDbFadein($format = 's.u')
{
@ -28,9 +28,9 @@ class CcBlockcontents extends BaseCcBlockcontents
*
* @param mixed $format
*
* @throws propelException - if unable to parse/validate the date/time value
*
* @return mixed Formatted date/time value as string or DateTime object (if format is NULL), NULL if column is NULL
*
* @throws propelException - if unable to parse/validate the date/time value
*/
public function getDbFadeout($format = 's.u')
{

View File

@ -69,9 +69,9 @@ class CcFiles extends BaseCcFiles
*
* @param $fileArray An array containing metadata for a CcFiles object
*
* @throws Exception
*
* @return object the sanitized response
*
* @throws Exception
*/
public static function createFromUpload($fileArray)
{
@ -126,10 +126,10 @@ class CcFiles extends BaseCcFiles
* @param string $originalFilename
* @param bool $copyFile
*
* @return mixed
*
* @throws Exception
* @throws PropelException
*
* @return mixed
*/
private static function createAndImport($fileArray, $filePath, $originalFilename, $copyFile = false)
{
@ -190,11 +190,11 @@ class CcFiles extends BaseCcFiles
* @param $fileId string The ID of the file to update in the DB
* @param $fileArray array An associative array containing metadata. Replaces those fields if they exist.
*
* @return array a sanitized version of the file metadata array
*
* @throws Exception
* @throws LibreTimeFileNotFoundException
* @throws PropelException
*
* @return array a sanitized version of the file metadata array
*/
public static function updateFromArray($fileId, $fileArray)
{

View File

@ -15,9 +15,9 @@ class CcPlaylist extends BaseCcPlaylist
* @param string $format The date/time format string (either date()-style or strftime()-style).
* If format is NULL, then the raw DateTime object will be returned.
*
* @throws propelException - if unable to parse/validate the date/time value
*
* @return mixed Formatted date/time value as string or DateTime object (if format is NULL), NULL if column is NULL
*
* @throws propelException - if unable to parse/validate the date/time value
*/
public function getDbUtime($format = 'Y-m-d H:i:s')
{
@ -48,9 +48,9 @@ class CcPlaylist extends BaseCcPlaylist
* @param string $format The date/time format string (either date()-style or strftime()-style).
* If format is NULL, then the raw DateTime object will be returned.
*
* @throws propelException - if unable to parse/validate the date/time value
*
* @return mixed Formatted date/time value as string or DateTime object (if format is NULL), NULL if column is NULL
*
* @throws propelException - if unable to parse/validate the date/time value
*/
public function getDbMtime($format = 'Y-m-d H:i:s')
{

View File

@ -14,9 +14,9 @@ class CcPlaylistcontents extends BaseCcPlaylistcontents
*
* @param mixed $format
*
* @throws propelException - if unable to parse/validate the date/time value
*
* @return mixed Formatted date/time value as string or DateTime object (if format is NULL), NULL if column is NULL
*
* @throws propelException - if unable to parse/validate the date/time value
*/
public function getDbFadein($format = 's.u')
{
@ -28,9 +28,9 @@ class CcPlaylistcontents extends BaseCcPlaylistcontents
*
* @param mixed $format
*
* @throws propelException - if unable to parse/validate the date/time value
*
* @return mixed Formatted date/time value as string or DateTime object (if format is NULL), NULL if column is NULL
*
* @throws propelException - if unable to parse/validate the date/time value
*/
public function getDbFadeout($format = 's.u')
{

View File

@ -15,9 +15,9 @@ class CcSchedule extends BaseCcSchedule
* @param string $format The date/time format string (either date()-style or strftime()-style).
* If format is NULL, then the raw DateTime object will be returned.
*
* @throws propelException - if unable to parse/validate the date/time value
*
* @return mixed Formatted date/time value as string or DateTime object (if format is NULL), NULL if column is NULL
*
* @throws propelException - if unable to parse/validate the date/time value
*/
public function getDbStarts($format = 'Y-m-d H:i:s.u')
{
@ -48,9 +48,9 @@ class CcSchedule extends BaseCcSchedule
* @param string $format The date/time format string (either date()-style or strftime()-style).
* If format is NULL, then the raw DateTime object will be returned.
*
* @throws propelException - if unable to parse/validate the date/time value
*
* @return mixed Formatted date/time value as string or DateTime object (if format is NULL), NULL if column is NULL
*
* @throws propelException - if unable to parse/validate the date/time value
*/
public function getDbEnds($format = 'Y-m-d H:i:s.u')
{
@ -80,9 +80,9 @@ class CcSchedule extends BaseCcSchedule
*
* @param mixed $format
*
* @throws propelException - if unable to parse/validate the date/time value
*
* @return mixed Formatted date/time value as string or DateTime object (if format is NULL), NULL if column is NULL
*
* @throws propelException - if unable to parse/validate the date/time value
*/
public function getDbFadeIn($format = 's.u')
{
@ -94,9 +94,9 @@ class CcSchedule extends BaseCcSchedule
*
* @param mixed $format
*
* @throws propelException - if unable to parse/validate the date/time value
*
* @return mixed Formatted date/time value as string or DateTime object (if format is NULL), NULL if column is NULL
*
* @throws propelException - if unable to parse/validate the date/time value
*/
public function getDbFadeOut($format = 's.u')
{

View File

@ -38,9 +38,9 @@ class CcShow extends BaseCcShow
* @param Criteria $criteria optional Criteria object to narrow the query
* @param PropelPDO $con optional connection object
*
* @throws PropelException
*
* @return array|PropelCollection CcShowDays[] List of CcShowDays objects
*
* @throws PropelException
*/
public function getFirstCcShowDay($criteria = null, PropelPDO $con = null)
{
@ -157,9 +157,9 @@ class CcShow extends BaseCcShow
* @param Criteria $criteria optional Criteria object to narrow the query
* @param PropelPDO $con optional connection object
*
* @throws PropelException
*
* @return array|PropelCollection CcShowInstances[] List of CcShowInstances objects
*
* @throws PropelException
*/
public function getFutureCcShowInstancess($criteria = null, PropelPDO $con = null)
{
@ -242,9 +242,9 @@ class CcShow extends BaseCcShow
* @param Criteria $criteria optional Criteria object to narrow the query
* @param PropelPDO $con optional connection object
*
* @throws PropelException
*
* @return array|PropelCollection CcShowInstances[] List of CcShowInstances objects
*
* @throws PropelException
*/
public function getCcShowInstancess($criteria = null, PropelPDO $con = null)
{

View File

@ -15,9 +15,9 @@ class CcShowInstances extends BaseCcShowInstances
* @param string $format The date/time format string (either date()-style or strftime()-style).
* If format is NULL, then the raw DateTime object will be returned.
*
* @throws propelException - if unable to parse/validate the date/time value
*
* @return mixed Formatted date/time value as string or DateTime object (if format is NULL), NULL if column is NULL
*
* @throws propelException - if unable to parse/validate the date/time value
*/
public function getDbStarts($format = 'Y-m-d H:i:s')
{
@ -48,9 +48,9 @@ class CcShowInstances extends BaseCcShowInstances
* @param string $format The date/time format string (either date()-style or strftime()-style).
* If format is NULL, then the raw DateTime object will be returned.
*
* @throws propelException - if unable to parse/validate the date/time value
*
* @return mixed Formatted date/time value as string or DateTime object (if format is NULL), NULL if column is NULL
*
* @throws propelException - if unable to parse/validate the date/time value
*/
public function getDbEnds($format = 'Y-m-d H:i:s')
{
@ -81,9 +81,9 @@ class CcShowInstances extends BaseCcShowInstances
* @param string $format The date/time format string (either date()-style or strftime()-style).
* If format is NULL, then the raw DateTime object will be returned.
*
* @throws propelException - if unable to parse/validate the date/time value
*
* @return mixed Formatted date/time value as string or DateTime object (if format is NULL), NULL if column is NULL
*
* @throws propelException - if unable to parse/validate the date/time value
*/
public function getDbLastScheduled($format = 'Y-m-d H:i:s')
{

View File

@ -2,6 +2,7 @@
/**
* @internal
*
* @coversNothing
*/
class SchedulerExportTests extends PHPUnit_TestCase

View File

@ -2,6 +2,7 @@
/**
* @internal
*
* @coversNothing
*/
class SchedulerTests extends PHPUnit_TestCase

View File

@ -2,6 +2,7 @@
/**
* @internal
*
* @coversNothing
*/
class StoredFileTest extends PHPUnit_TestCase

View File

@ -170,7 +170,7 @@ class Rest_PodcastController extends Zend_Rest_Controller
Application_Service_PodcastService::deletePodcastById($id);
}
break;
break;
case HttpRequestType::GET:
$path = 'podcast/podcast.phtml';
@ -181,7 +181,7 @@ class Rest_PodcastController extends Zend_Rest_Controller
];
}
break;
break;
}
$this->_helper->json->sendJson($responseBody);

View File

@ -146,11 +146,11 @@ class Rest_ShowImageController extends Zend_Rest_Controller
* @param int $showId the ID of the show we're adding the image to
* @param string $tempFilePath temporary filepath assigned to the upload generally of the form /tmp/:tmp_name
*
* @return string the path to the new location for the file
*
* @throws Exception
* - when a file with an unsupported file extension is uploaded or an
* error occurs in copyFileToStor
*
* @return string the path to the new location for the file
*/
private function processUploadedImage($showId, $tempFilePath)
{
@ -219,12 +219,12 @@ class Rest_ShowImageController extends Zend_Rest_Controller
* @param string $importedStorageDirectory the path to the new location for the file
* @param string $fileExtension the file's extension based on its MIME type
*
* @return string the new full path to the file in stor
*
* @throws Exception if either the storage directory does not exist and cannot be
* created, the storage directory does not have write permissions
* enabled, or the user's hard drive does not have enough space to
* store the file
*
* @return string the new full path to the file in stor
*/
private function copyFileToStor($tempFilePath, $importedStorageDirectory, $fileExtension)
{

View File

@ -19,9 +19,9 @@ class Application_Service_MediaService
* @param $ownerId string The ID of the user that will own the file inside Airtime
* @param $copyFile bool True if you want to copy the file to the "organize" directory, false if you want to move it (default)
*
* @throws Exception
*
* @return Ambigous
*
* @throws Exception
*/
public static function importFileToLibrary($fileId, $filePath, $originalFilename, $ownerId, $copyFile)
{

View File

@ -88,9 +88,9 @@ class Application_Service_PodcastEpisodeService extends Application_Service_Thir
* @param int $podcastId Podcast object identifier
* @param array $episode array of podcast episode data
*
* @throws DuplicatePodcastEpisodeException
*
* @return PodcastEpisodes the stored PodcastEpisodes object
*
* @throws DuplicatePodcastEpisodeException
*/
public function addPlaceholder($podcastId, $episode)
{
@ -116,10 +116,10 @@ class Application_Service_PodcastEpisodeService extends Application_Service_Thir
* @param string $title the title of the episode
* @param string $description the description of the epsiode
*
* @return PodcastEpisodes the newly created PodcastEpisodes object
*
* @throws Exception
* @throws PropelException
*
* @return PodcastEpisodes the newly created PodcastEpisodes object
*/
private function _buildEpisode($podcastId, $url, $guid, $publicationDate, $title = null, $description = null)
{
@ -202,10 +202,10 @@ class Application_Service_PodcastEpisodeService extends Application_Service_Thir
* @param $episode stdClass simple object containing Podcast episode information
* @param $status string Celery task status
*
* @return ThirdPartyTrackReferences the updated ThirdPartyTrackReferences object
*
* @throws Exception
* @throws PropelException
*
* @return ThirdPartyTrackReferences the updated ThirdPartyTrackReferences object
*/
public function updateTrackReference($task, $episodeId, $episode, $status)
{
@ -320,9 +320,9 @@ class Application_Service_PodcastEpisodeService extends Application_Service_Thir
/**
* @param $episodeId
*
* @throws PodcastEpisodeNotFoundException
*
* @return array
*
* @throws PodcastEpisodeNotFoundException
*/
public static function getPodcastEpisodeById($episodeId)
{
@ -343,9 +343,9 @@ class Application_Service_PodcastEpisodeService extends Application_Service_Thir
* @param string $sortColumn
* @param string $sortDir "ASC" || "DESC"
*
* @throws PodcastNotFoundException
*
* @return array
*
* @throws PodcastNotFoundException
*/
public function getPodcastEpisodes(
$podcastId,
@ -408,9 +408,9 @@ class Application_Service_PodcastEpisodeService extends Application_Service_Thir
* @param ImportedPodcast $podcast Podcast object to fetch the episodes for
* @param array $episodes array of PodcastEpisodes objects to
*
* @throws CcFiles/LibreTimeFileNotFoundException
*
* @return array array of episode data
*
* @throws CcFiles/LibreTimeFileNotFoundException
*/
public function _getImportedPodcastEpisodeArray($podcast, $episodes)
{

View File

@ -44,10 +44,10 @@ class Application_Service_PodcastService
*
* @param string $feedUrl Podcast RSS Feed Url
*
* @return array Podcast Array with a full list of episodes
*
* @throws Exception
* @throws InvalidPodcastException
*
* @return array Podcast Array with a full list of episodes
*/
public static function createFromFeedUrl($feedUrl)
{
@ -278,10 +278,10 @@ class Application_Service_PodcastService
*
* @param $podcastId
*
* @return array - Podcast Array with a full list of episodes
*
* @throws PodcastNotFoundException
* @throws InvalidPodcastException
*
* @return array - Podcast Array with a full list of episodes
*/
public static function getPodcastById($podcastId)
{
@ -325,9 +325,9 @@ class Application_Service_PodcastService
* @param int $podcastId ID of the podcast to build a response for
* @param Zend_View_Interface $view Zend view object to render the response HTML
*
* @throws PodcastNotFoundException
*
* @return array the response array containing the podcast data and editor HTML
*
* @throws PodcastNotFoundException
*/
public static function buildPodcastEditorResponse($podcastId, $view)
{
@ -349,10 +349,10 @@ class Application_Service_PodcastService
* @param $podcastId
* @param $data
*
* @return array
*
* @throws Exception
* @throws PodcastNotFoundException
*
* @return array
*/
public static function updatePodcastFromArray($podcastId, $data)
{

View File

@ -19,9 +19,9 @@ abstract class Application_Service_ThirdPartyCeleryService extends Application_S
* @param array $data the data array to send as task parameters
* @param int $fileId the unique identifier for the file involved in the task
*
* @throws Exception
*
* @return CeleryTasks the created task
*
* @throws Exception
*/
protected function _executeTask($taskName, $data, $fileId = null)
{
@ -49,10 +49,10 @@ abstract class Application_Service_ThirdPartyCeleryService extends Application_S
* receive completed task messages
* @param $taskName string broker task name
*
* @return CeleryTasks the created task
*
* @throws Exception
* @throws PropelException
*
* @return CeleryTasks the created task
*/
protected function _createTaskReference($fileId, $brokerTaskId, $taskName)
{
@ -95,10 +95,10 @@ abstract class Application_Service_ThirdPartyCeleryService extends Application_S
* @param $result mixed Celery task result message
* @param $status string Celery task status
*
* @return ThirdPartyTrackReferences the updated ThirdPartyTrackReferences object
*
* @throws Exception
* @throws PropelException
*
* @return ThirdPartyTrackReferences the updated ThirdPartyTrackReferences object
*/
public function updateTrackReference($task, $trackId, $result, $status)
{

View File

@ -24,10 +24,10 @@ abstract class Application_Service_ThirdPartyService
*
* @param $fileId int local CcFiles identifier
*
* @return string the new ThirdPartyTrackReferences identifier
*
* @throws Exception
* @throws PropelException
*
* @return string the new ThirdPartyTrackReferences identifier
*/
public function createTrackReference($fileId)
{

View File

@ -2,6 +2,7 @@
/**
* @internal
*
* @coversNothing
*/
class BlockDbTest extends Zend_Test_PHPUnit_DatabaseTestCase // PHPUnit_Framework_TestCase

View File

@ -2,6 +2,7 @@
/**
* @internal
*
* @coversNothing
*/
class ScheduleDbTest extends Zend_Test_PHPUnit_DatabaseTestCase

View File

@ -4,6 +4,7 @@ require_once '../application/configs/conf.php';
/**
* @internal
*
* @coversNothing
*/
class PreferenceUnitTest extends PHPUnit_Framework_TestCase

View File

@ -2,6 +2,7 @@
/**
* @internal
*
* @coversNothing
*/
class ScheduleUnitTest extends Zend_Test_PHPUnit_ControllerTestCase // PHPUnit_Framework_TestCase

View File

@ -12,6 +12,7 @@ require_once '../application/configs/conf.php';
*/
/**
* @internal
*
* @coversNothing
*/
class ShowServiceDbTest extends Zend_Test_PHPUnit_DatabaseTestCase

View File

@ -4,6 +4,7 @@ require_once '../application/configs/conf.php';
/**
* @internal
*
* @coversNothing
*/
class ShowServiceUnitTest extends PHPUnit_Framework_TestCase