Open Journal Systems  3.3.0
DependentFilesGridDataProvider Class Reference
Inheritance diagram for DependentFilesGridDataProvider:
SubmissionFilesGridDataProvider FilesGridDataProvider GridDataProvider

Public Member Functions

 __construct ($assocId)
 
 getAddFileAction ($request)
 
 getAssocId ()
 
 isDependent ()
 
 loadData ($filter=array())
 
- Public Member Functions inherited from SubmissionFilesGridDataProvider
 __construct ($fileStage, $viewableOnly=false)
 
 getAuthorizationPolicy ($request, $args, $roleAssignments)
 
 getFileStage ()
 
 getRequestArgs ()
 
 getStageId ()
 
 prepareSubmissionFileData ($revisions, $viewableOnly=false, $filter=array())
 
 setStageId ($stageId)
 
- Public Member Functions inherited from FilesGridDataProvider
 getSelectAction ($request)
 
 getUploaderRoles ()
 
 setUploaderRoles ($roleAssignments)
 
 setViewableOnly ($viewableOnly)
 
- Public Member Functions inherited from GridDataProvider
 __construct ()
 
getAuthorizedContextObject ($assocType)
 
 hasAuthorizedContextObject ($assocType)
 
 setAuthorizedContext (&$authorizedContext)
 

Data Fields

 $_assocId
 
- Data Fields inherited from SubmissionFilesGridDataProvider
 $_fileStage
 
 $_stageId
 
- Data Fields inherited from FilesGridDataProvider
 $_uploaderRoles
 
 $_viewableOnly = false
 
- Data Fields inherited from GridDataProvider
 $_authorizedContext
 

Additional Inherited Members

- Protected Member Functions inherited from SubmissionFilesGridDataProvider
 applyFilter ($revisions, $filter)
 
- Protected Member Functions inherited from FilesGridDataProvider
 getSubmission ()
 

Detailed Description

Provide access to dependent file data for grids.

Definition at line 19 of file DependentFilesGridDataProvider.inc.php.

Constructor & Destructor Documentation

◆ __construct()

DependentFilesGridDataProvider::__construct (   $assocId)

Constructor

Parameters
$assocIdint Association ID

Definition at line 34 of file DependentFilesGridDataProvider.inc.php.

Member Function Documentation

◆ getAddFileAction()

DependentFilesGridDataProvider::getAddFileAction (   $request)

Overridden from SubmissionFilesGridDataProvider - we need to also include the assocType and assocId Configures and returns the action to add a file.

NB: Must be overridden by subclasses (if implemented).

Parameters
$requestRequest
Returns
AddFileLinkAction

Reimplemented from SubmissionFilesGridDataProvider.

Definition at line 56 of file DependentFilesGridDataProvider.inc.php.

References FilesGridDataProvider\getSubmission().

◆ getAssocId()

DependentFilesGridDataProvider::getAssocId ( )

returns the id of the parent submission file for these dependent files.

Returns
int

Definition at line 71 of file DependentFilesGridDataProvider.inc.php.

References $_assocId.

Referenced by loadData().

◆ isDependent()

DependentFilesGridDataProvider::isDependent ( )

Convenience function to make the argument to the AddFileLinkAction more obvious.

Returns
true

Definition at line 79 of file DependentFilesGridDataProvider.inc.php.

◆ loadData()

DependentFilesGridDataProvider::loadData (   $filter = array())

Retrieve the data to load into the grid.

Parameters
$filterarray An optional associative array with filter data as returned by GridHandler::getFilterSelectionData(). If no filter has been selected by the user then the array will be empty.
Returns
array

Reimplemented from SubmissionFilesGridDataProvider.

Definition at line 44 of file DependentFilesGridDataProvider.inc.php.

References getAssocId(), DAORegistry\getDAO(), FilesGridDataProvider\getSubmission(), and SubmissionFilesGridDataProvider\prepareSubmissionFileData().

Field Documentation

◆ $_assocId

int DependentFilesGridDataProvider::$_assocId

The submission file id for the parent file.

Definition at line 28 of file DependentFilesGridDataProvider.inc.php.

Referenced by getAssocId().


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