Fossology\UI\Page\UploadPageBase Class Reference

Inheritance diagram for Fossology\UI\Page\UploadPageBase:

Collaboration diagram for Fossology\UI\Page\UploadPageBase:

Public Member Functions
	__construct ($name, $parameters=array())
	str_contains_notescaped_char ($str, $char)
	checks, whether a string contains some special character without escaping More...
	path_is_pattern ($path)
	checks, whether a path is a pattern from the perspective of a shell More...
	normalize_path ($path, $host="localhost", $appendix="")
	normalizes an path and returns FALSE on errors More...
	basicShEscaping ($str)
Public Member Functions inherited from Fossology\Lib\Plugin\DefaultPlugin
	getName ()
	getVersion ()
	getTitle ()
	isRequiresLogin ()
	getDependency ()
	getPluginLevel ()
	getDBaccess ()
	getState ()
	getInitOrder ()
	getNoMenu ()
	getResponse ()
	getObject ($name)
	preInstall ()
	postInstall ()
	unInstall ()
	execute ()
	isLoggedIn ()
	__get ($name)
	__toString ()

Public Attributes
const	NAME = "upload_file"
const	FOLDER_PARAMETER_NAME = 'folder'
const	DESCRIPTION_INPUT_NAME = 'descriptionInputName'
const	DESCRIPTION_VALUE = 'descriptionValue'
const	UPLOAD_FORM_BUILD_PARAMETER_NAME = 'uploadformbuild'
const	PUBLIC_ALL = 'public'
const	PUBLIC_GROUPS = 'protected'
Public Attributes inherited from Fossology\Lib\Plugin\DefaultPlugin
const	PERMISSION = "permission"
const	REQUIRES_LOGIN = "requiresLogin"
const	ENABLE_MENU = "ENABLE_MENU"
const	LEVEL = "level"
const	DEPENDENCIES = "dependencies"
const	INIT_ORDER = "initOrder"
const	MENU_LIST = "menuList"
const	MENU_ORDER = "menuOrder"
const	MENU_TARGET = "menuTarget"
const	TITLE = "title"

Protected Member Functions
	handleUpload (Request $request)
	handleView (Request $request, $vars)
	handle (Request $request)
	postUploadAddJobs (Request $request, $fileName, $uploadId, $jobId=null, $wgetDependency=false)
	path_can_escape ($path)
	checks, whether a path contains substrings, which could enable it to escape his prefix More...
Protected Member Functions inherited from Fossology\Lib\Plugin\DefaultPlugin
	RegisterMenus ()
	Customize submenus.
	render ($templateName, $vars=null, $headers=null)
	getDefaultHeaders ()
	getDefaultVars ()
	mergeWithDefault ($vars)
	flushContent ($content)

Private Member Functions
	rearrangeDependencies (&$parmList)

Private Attributes
	$folderDao
	$uploadDao
	$logger
	$userDao

Additional Inherited Members
Protected Attributes inherited from Fossology\Lib\Plugin\DefaultPlugin
	$container
	$renderer
	$microMenu

Detailed Description

Definition at line 19 of file UploadPageBase.php.

Member Function Documentation

handle()

Fossology\UI\Page\UploadPageBase::handle ( Request  $request )

protected

Parameters

Request

$request

Returns

Response

Reimplemented from Fossology\Lib\Plugin\DefaultPlugin.

Definition at line 51 of file UploadPageBase.php.

normalize_path()

Fossology\UI\Page\UploadPageBase::normalize_path	(		$path,
			$host = "localhost",
			$appendix = ""
	)

normalizes an path and returns FALSE on errors

Parameters

$path	- the path to normalize
$appendix	- optional parameter, which is used for the recursive call

Returns

normalized path on success FALSE on error

Definition at line 217 of file UploadPageBase.php.

path_can_escape()

Fossology\UI\Page\UploadPageBase::path_can_escape (   $path )

protected

checks, whether a path contains substrings, which could enable it to escape his prefix

Parameters

$path

- the path to check

Returns

boolean

Definition at line 201 of file UploadPageBase.php.

path_is_pattern()

Fossology\UI\Page\UploadPageBase::path_is_pattern

(

$path

)

checks, whether a path is a pattern from the perspective of a shell

Parameters

$path

- the path to check

Returns

boolean

Definition at line 185 of file UploadPageBase.php.

rearrangeDependencies()

Fossology\UI\Page\UploadPageBase::rearrangeDependencies ( &  $parmList )

private

Make sure reuser is scheduled before decider so decider does not run another reuser as dependency

Parameters

[in,out]

array

$parmList

List of parameterized agents

Definition at line 267 of file UploadPageBase.php.

str_contains_notescaped_char()

Fossology\UI\Page\UploadPageBase::str_contains_notescaped_char	(		$str,
			$char
	)

checks, whether a string contains some special character without escaping

Parameters

$str	- the string to check
$char	- the character to search for

Returns

boolean

Definition at line 160 of file UploadPageBase.php.

---

The documentation for this class was generated from the following file:

• src/www/ui/page/UploadPageBase.php