Class lispa\amos\documenti\controllers\DocumentiController

All Classes | Properties | Methods | Events | Constants

Inheritance	lispa\amos\documenti\controllers\DocumentiController » lispa\amos\core\controllers\CrudController » lispa\amos\core\controllers\BaseController » lispa\amos\core\controllers\BackendController » lispa\amos\core\controllers\AmosController » yii\web\Controller » yii\base\Controller » yii\base\Component » yii\base\Object
Implements	yii\base\Configurable, yii\base\ViewContextInterface
Uses Traits	lispa\amos\dashboard\controllers\TabDashboardControllerTrait

Class DocumentiController

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$action	yii\base\Action	The action that is currently being executed.	yii\base\Controller
$actionParams	array	The parameters bound to the current action.	yii\web\Controller
$availableViews			lispa\amos\core\controllers\CrudController
$behaviors	yii\base\Behavior[]	List of behaviors attached to this component	yii\base\Component
$child_of	string		lispa\amos\dashboard\controllers\TabDashboardControllerTrait
$currentDashboard	lispa\amos\dashboard\models\AmosUserDashboards		lispa\amos\dashboard\controllers\TabDashboardControllerTrait
$currentView			lispa\amos\core\controllers\CrudController
$customModule	string	This custom module is useful to generate other tab internal dashboard other than the base plugin unique name.	lispa\amos\dashboard\controllers\TabDashboardControllerTrait
$dataProvider			lispa\amos\core\controllers\CrudController
$defaultAction	string	The ID of the action that is used when the action ID is not specified in the request.	yii\base\Controller
$documentsModule	lispa\amos\documenti\AmosDocumenti		lispa\amos\documenti\controllers\DocumentiController
$enableCsrfValidation	boolean	Whether to enable CSRF validation for the actions in this controller.	yii\web\Controller
$exportConfig	array	Configurations to export data.	lispa\amos\core\controllers\CrudController
$forceDefaultViewType	boolean		lispa\amos\core\controllers\CrudController
$gridViewColumns			lispa\amos\core\controllers\CrudController
$id	string	The ID of this controller.	yii\base\Controller
$layout	string		lispa\amos\documenti\controllers\DocumentiController
$model	mixed		lispa\amos\core\controllers\BaseController
$modelClass	yii\base\Model		lispa\amos\core\controllers\BaseController
$modelClassName	mixed		lispa\amos\core\controllers\BaseController
$modelName	mixed		lispa\amos\core\controllers\BaseController
$modelObj	mixed		lispa\amos\core\controllers\BaseController
$modelSearch			lispa\amos\core\controllers\CrudController
$module	yii\base\Module	The module that this controller belongs to.	yii\base\Controller
$modules	yii\base\Module[]	All ancestor modules that this controller is located within.	yii\base\Controller
$otherViewAvailable			lispa\amos\core\controllers\CrudController
$parametro			lispa\amos\core\controllers\CrudController
$route	string	The route (module ID, controller ID and action ID) of the current request.	yii\base\Controller
$slide	integer		lispa\amos\dashboard\controllers\TabDashboardControllerTrait
$uniqueId	string	The controller ID that is prefixed with the module ID (if any).	yii\base\Controller
$url			lispa\amos\core\controllers\CrudController
$view	yii\base\View\|yii\web\View	The view object that can be used to render views or view files.	yii\base\Controller
$viewGrid	array		lispa\amos\core\controllers\CrudController
$viewIcon	array		lispa\amos\core\controllers\CrudController
$viewList	array		lispa\amos\core\controllers\CrudController
$viewPath	string	The view path that may be prefixed to a relative view name.	yii\base\ViewContextInterface

Public Methods

Hide inherited methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	yii\base\Component
__clone()	This method is called after the object is created by cloning an existing one.	yii\base\Component
__construct()		yii\base\Controller
__get()	Returns the value of a component property.	yii\base\Component
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\Component
__set()	Sets the value of a component property.	yii\base\Component
__unset()	Sets a component property to be null.	yii\base\Component
actionAdminAllDocuments()	Get all the documents without any visibility/status filters	lispa\amos\documenti\controllers\DocumentiController
actionAllDocuments()	Action for search all documenti.	lispa\amos\documenti\controllers\DocumentiController
actionCreate()	Creates a new Documenti model.	lispa\amos\documenti\controllers\DocumentiController
actionDelete()	Deletes an existing Documenti model.	lispa\amos\documenti\controllers\DocumentiController
actionDeleteNewDocumentVersion()		lispa\amos\documenti\controllers\DocumentiController
actionIndex()	Lists all Documenti models.	lispa\amos\documenti\controllers\DocumentiController
actionListOnly()	Render the sub-table of version, it's called with ajax	lispa\amos\documenti\controllers\DocumentiController
actionNewDocumentVersion()		lispa\amos\documenti\controllers\DocumentiController
actionOwnDocuments()	Action to search only for own documents	lispa\amos\documenti\controllers\DocumentiController
actionOwnInterestDocuments()	Action to search only for own interest documents	lispa\amos\documenti\controllers\DocumentiController
actionRejectDocument()		lispa\amos\documenti\controllers\DocumentiController
actionRequestInformation()	Used by information request widget to send email about a model (from modal)	lispa\amos\core\controllers\CrudController
actionToValidateDocuments()	Action to search to validate documents.	lispa\amos\documenti\controllers\DocumentiController
actionUpdate()	Updates an existing Documenti model.	lispa\amos\documenti\controllers\DocumentiController
actionValidateDocument()		lispa\amos\documenti\controllers\DocumentiController
actionView()	Displays a single Documenti model.	lispa\amos\documenti\controllers\DocumentiController
actions()	Declares external actions for the controller.	lispa\amos\documenti\controllers\DocumentiController
addFlash()	If not present, add flash message to session	lispa\amos\core\controllers\BackendController
afterAction()	This method is invoked right after an action is executed.	yii\base\Controller
asJson()	Send data formatted as JSON.	yii\web\Controller
asXml()	Send data formatted as XML.	yii\web\Controller
attachBehavior()	Attaches a behavior to this component.	yii\base\Component
attachBehaviors()	Attaches a list of behaviors to the component.	yii\base\Component
beforeAction()	This method is invoked right before an action is executed.	yii\web\Controller
behaviors()		lispa\amos\documenti\controllers\DocumentiController
bindActionParams()	Binds the parameters to the action.	yii\web\Controller
can()		lispa\amos\core\controllers\CrudController
canGetProperty()	Returns a value indicating whether a property can be read.	yii\base\Component
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\Component
className()	Returns the fully qualified name of this class.	yii\base\Object
createAction()	Creates an action based on the given action ID.	yii\base\Controller
detachBehavior()	Detaches a behavior from the component.	yii\base\Component
detachBehaviors()	Detaches all behaviors from the component.	yii\base\Component
documentIsFolder()	If a given document model is a folder or not	lispa\amos\documenti\controllers\DocumentiController
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.	yii\base\Component
findLayoutFile()	Finds the applicable layout file.	yii\base\Controller
getAvailableView()		lispa\amos\core\controllers\CrudController
getAvailableViews()		lispa\amos\core\controllers\CrudController
getBehavior()	Returns the named behavior object.	yii\base\Component
getBehaviors()	Returns all behaviors attached to this component.	yii\base\Component
getCurrentDashboard()		lispa\amos\dashboard\controllers\TabDashboardControllerTrait
getCurrentView()		lispa\amos\core\controllers\CrudController
getDataProvider()		lispa\amos\core\controllers\CrudController
getFormCloseLabel()		lispa\amos\documenti\controllers\DocumentiController
getFormCloseUrl()		lispa\amos\documenti\controllers\DocumentiController
getGridViewColumns()		lispa\amos\core\controllers\CrudController
getModel()		lispa\amos\core\controllers\BaseController
getModelClass()		lispa\amos\core\controllers\BaseController
getModelClassName()		lispa\amos\core\controllers\BaseController
getModelName()		lispa\amos\core\controllers\BaseController
getModelObj()		lispa\amos\core\controllers\BaseController
getModelSearch()		lispa\amos\core\controllers\CrudController
getModules()	Returns all ancestor modules of this controller.	yii\base\Controller
getParametro()		lispa\amos\core\controllers\CrudController
getRoute()	Returns the route of the current request.	yii\base\Controller
getSlide()		lispa\amos\dashboard\controllers\TabDashboardControllerTrait
getUniqueId()	Returns the unique ID of the controller.	yii\base\Controller
getUrl()		lispa\amos\core\controllers\CrudController
getView()	Returns the view object that can be used to render views or view files.	yii\base\Controller
getViewPath()		yii\base\ViewContextInterface
goBack()	Redirects the browser to the last visited page.	yii\web\Controller
goHome()	Redirects the browser to the home page.	yii\web\Controller
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named event.	yii\base\Component
hasMethod()	Returns a value indicating whether a method is defined.	yii\base\Component
hasProperty()	Returns a value indicating whether a property is defined for this component.	yii\base\Component
init()		lispa\amos\documenti\controllers\DocumentiController
initAvailableViews()		lispa\amos\core\controllers\CrudController
initCurrentView()		lispa\amos\core\controllers\CrudController
initDashboardTrait()	Metodo per inizializzazione del trait	lispa\amos\dashboard\controllers\TabDashboardControllerTrait
initModelName()		lispa\amos\core\controllers\BaseController
off()	Detaches an existing event handler from this component.	yii\base\Component
on()	Attaches an event handler to an event.	yii\base\Component
redirect()	Redirects the browser to the specified URL.	yii\web\Controller
refresh()	Refreshes the current page.	yii\web\Controller
render()	Renders a view and applies layout if available.	yii\base\Controller
renderAjax()	Renders a view in response to an AJAX request.	yii\web\Controller
renderContent()	Renders a static string by applying a layout.	yii\base\Controller
renderFile()	Renders a view file.	yii\base\Controller
renderMailPartial()	Renders a view without applying layout.	lispa\amos\core\controllers\AmosController
renderPartial()	Renders a view without applying layout.	yii\base\Controller
run()	Runs a request specified in terms of a route.	yii\base\Controller
runAction()	Runs an action within this controller with the specified action ID and parameters.	yii\base\Controller
sendNotificationEmail()		lispa\amos\documenti\controllers\DocumentiController
setAvailableViews()		lispa\amos\core\controllers\CrudController
setCurrentDashboard()		lispa\amos\dashboard\controllers\TabDashboardControllerTrait
setCurrentView()		lispa\amos\core\controllers\CrudController
setDataProvider()		lispa\amos\core\controllers\CrudController
setGridViewColumns()		lispa\amos\core\controllers\CrudController
setModel()		lispa\amos\core\controllers\BaseController
setModelClass()		lispa\amos\core\controllers\BaseController
setModelClassName()		lispa\amos\core\controllers\BaseController
setModelName()		lispa\amos\core\controllers\BaseController
setModelObj()		lispa\amos\core\controllers\BaseController
setModelSearch()		lispa\amos\core\controllers\CrudController
setNetworkDashboardBreadcrumb()		lispa\amos\documenti\controllers\DocumentiController
setParametro()		lispa\amos\core\controllers\CrudController
setSlide()		lispa\amos\dashboard\controllers\TabDashboardControllerTrait
setUpLayout()		lispa\amos\core\controllers\BackendController
setUrl()		lispa\amos\core\controllers\CrudController
setView()	Sets the view object to be used by this controller.	yii\base\Controller
setViewPath()	Sets the directory that contains the view files.	yii\base\Controller
trigger()	Triggers an event.	yii\base\Component

Protected Methods

Hide inherited methods

Method	Description	Defined By
findModel()	Finds the modelObj model based on its primary key value.	lispa\amos\core\controllers\CrudController
getDefaultCurrentView()		lispa\amos\core\controllers\CrudController
getRules()		lispa\amos\core\controllers\BaseController
redirectOnCreate()		lispa\amos\documenti\controllers\DocumentiController
redirectOnUpdate()		lispa\amos\documenti\controllers\DocumentiController
setListViewsParams()	This method is useful to set all common params for all list views.	lispa\amos\documenti\controllers\DocumentiController
setUserLanguage()		lispa\amos\core\controllers\AmosController

Events

Hide inherited events

Event	Type	Description	Defined By
EVENT_AFTER_ACTION	yii\base\ActionEvent	An event raised right after executing a controller action.	yii\base\Controller
EVENT_BEFORE_ACTION	yii\base\ActionEvent	An event raised right before executing a controller action.	yii\base\Controller

Constants

Hide inherited constants

Constant	Value	Description	Defined By
AFTER_FINDMODEL_EVENT	"afterFindModel"		lispa\amos\core\controllers\CrudController
BEFORE_FINDMODEL_EVENT	"beforeFindModel"		lispa\amos\core\controllers\CrudController

Property Details

$documentsModule public property

public lispa\amos\documenti\AmosDocumenti $documentsModule = null

$layout public property

public string $layout = 'main'

Method Details

actionAdminAllDocuments() public method

Get all the documents without any visibility/status filters

public string actionAdminAllDocuments ( $currentView = null, $parentId = null )
$currentView	null
$parentId	integer\|null	id of document folder

actionAllDocuments() public method

Action for search all documenti.

public string actionAllDocuments ( $currentView = null, $parentId = null )
$currentView
$parentId	integer\|null	id of document folder

actionCreate() public method

Creates a new Documenti model.

If creation is successful, the browser will be redirected to the 'view' page.

public mixed actionCreate ( )

actionDelete() public method

Deletes an existing Documenti model.

If deletion is successful, the browser will be redirected to the 'index' page.

public yii\web\Response actionDelete ( $id )
$id	integer
throws	Exception
throws	yii\db\StaleObjectException
throws	yii\web\NotFoundHttpException

actionDeleteNewDocumentVersion() public method

public yii\web\Response actionDeleteNewDocumentVersion ( $id )
$id	integer
throws	yii\web\NotFoundHttpException

actionIndex() public method

Lists all Documenti models.

public mixed actionIndex ( $layout = null )
$layout

actionListOnly() public method

Render the sub-table of version, it's called with ajax

public string actionListOnly ( )
throws	Exception

actionNewDocumentVersion() public method

public yii\web\Response actionNewDocumentVersion ( $id )
$id	integer
throws	\raoul2000\workflow\base\WorkflowException
throws	yii\web\NotFoundHttpException

actionOwnDocuments() public method

Action to search only for own documents

public string actionOwnDocuments ( $parentId = null )
$parentId	integer\|null	id of document folder

actionOwnInterestDocuments() public method

Action to search only for own interest documents

public string actionOwnInterestDocuments ( $currentView = null, $parentId = null )
$currentView
$parentId	integer\|null	id of document folder

actionRejectDocument() public method

public yii\web\Response actionRejectDocument ( $id )
$id	integer	Document id.

actionToValidateDocuments() public method

Action to search to validate documents.

public string actionToValidateDocuments ( $parentId = null )
$parentId	integer\|null	id of document folder

actionUpdate() public method

Updates an existing Documenti model.

public string actionUpdate ( $id, $backToEditStatus = false )
$id	integer
$backToEditStatus	boolean\|false	Save the model with status Editing in progress before form rendering
throws	yii\web\NotFoundHttpException

actionValidateDocument() public method

public yii\web\Response actionValidateDocument ( $id )
$id	integer	Document id.

actionView() public method

Displays a single Documenti model.

public string\|yii\web\Response actionView ( $id )
$id	integer
throws	yii\web\NotFoundHttpException

actions() public method

Declares external actions for the controller.

This method is meant to be overwritten to declare external actions for the controller. It should return an array, with array keys being action IDs, and array values the corresponding action class names or action configuration arrays. For example,

return [
    'action1' => 'app\components\Action1',
    'action2' => [
        'class' => 'app\components\Action2',
        'property1' => 'value1',
        'property2' => 'value2',
    ],
];

Yii::createObject() will be used later to create the requested action using the configuration provided here.

public void actions ( )

behaviors() public method

public array behaviors ( )

documentIsFolder() public method

If a given document model is a folder or not

public boolean documentIsFolder ( $model )
$model	lispa\amos\documenti\models\Documenti

getFormCloseLabel() public method

public string getFormCloseLabel ( $model )
$model	lispa\amos\documenti\models\Documenti

getFormCloseUrl() public method

public mixed\|yii\web\Response getFormCloseUrl ( $model )
$model	lispa\amos\documenti\models\Documenti

init() public method

public void init ( )
throws	yii\base\InvalidConfigException

redirectOnCreate() protected method

protected yii\web\Response redirectOnCreate ( $model )
$model

redirectOnUpdate() protected method

protected yii\web\Response redirectOnUpdate ( $model, $previousStatus = null )
$model
$previousStatus	null

sendNotificationEmail() public method

public void sendNotificationEmail ( )

setListViewsParams() protected method

This method is useful to set all common params for all list views.

protected void setListViewsParams ( )

setNetworkDashboardBreadcrumb() public method

public void setNetworkDashboardBreadcrumb ( )