Class lispa\amos\cwh\AmosCwh

Inheritancelispa\amos\cwh\AmosCwh » lispa\amos\core\module\AmosModule » lispa\amos\core\module\BaseAmosModule » yii\base\Module » yii\di\ServiceLocator » yii\base\Component » yii\base\Object
Implementslispa\amos\core\module\ModuleInterface, yii\base\BootstrapInterface, yii\base\Configurable

Class AmosCwh

Collaboration Web House - This module provides management of rules, scope, relations and further more linking modules to the others

See also [[]].

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$aliases array List of path aliases to be defined. yii\base\Module
$amosUniqueId string lispa\amos\core\module\BaseAmosModule
$basePath string The root directory of the module. yii\base\Module
$behaviors lispa\amos\cwh\AmosCwh
$cacheDuration lispa\amos\cwh\AmosCwh
$cached boolean lispa\amos\cwh\AmosCwh
$components array The list of the component definitions or the loaded component instances (ID => definition or instance). yii\di\ServiceLocator
$controllerMap array Mapping from controller ID to controller configurations. yii\base\Module
$controllerNamespace string lispa\amos\cwh\AmosCwh
$controllerPath string The directory that contains the controller classes. yii\base\Module
$cwhConfWizardEnabled lispa\amos\cwh\AmosCwh
$cwhScope lispa\amos\cwh\AmosCwh
$cwhScopeInSession array The list of cwh scopes lispa\amos\cwh\AmosCwh
$defaultListViews array This set the default views in lists lispa\amos\core\module\AmosModule
$defaultModels array lispa\amos\cwh\AmosCwh
$defaultRoute string The default route of this module. yii\base\Module
$destinatariEnabled lispa\amos\cwh\AmosCwh
$enableDestinatariFatherChildren lispa\amos\cwh\AmosCwh
$fullNetworkModels array lispa\amos\cwh\AmosCwh
$i18nDirPath string lispa\amos\core\module\AmosModule
$id string An ID that uniquely identifies this module among other modules which have the same parent. yii\base\Module
$layout string|boolean The layout that should be applied for views within this module. yii\base\Module
$layoutPath string The root directory of layout files. yii\base\Module
$modelMap array lispa\amos\core\module\AmosModule
$modelsEnabled array lispa\amos\cwh\AmosCwh
$module yii\base\Module The parent module of this module. yii\base\Module
$modules array The modules (indexed by their IDs). yii\base\Module
$networkModels array lispa\amos\cwh\AmosCwh
$params array Custom module parameters (name => value). yii\base\Module
$permissionPrefix lispa\amos\cwh\AmosCwh
$postKey string lispa\amos\cwh\AmosCwh
$rbacEnabled boolean lispa\amos\core\module\BaseAmosModule
$regolaPubblicazioneEnabled lispa\amos\cwh\AmosCwh
$regolaPubblicazioneFilter boolean If true publication rule 'PUBLIC' (to all users) only if the user has the specified role $regolaPubblicazioneFilterRole lispa\amos\cwh\AmosCwh
$regolaPubblicazioneFilterRole string - default VALIDATOR_PLUS role if $regolaPubblicazioneFilter flag is setted only the specified role can view publication rule 1. lispa\amos\cwh\AmosCwh
$scope array The entities scope for which contents needs to be filtered lispa\amos\cwh\AmosCwh
$tagsMatchEachTree boolean Set to true if a content is to be considered of user interest when there is tag-match of each tag tree Default is false - at least one content tag matching user interest (any tree) lispa\amos\cwh\AmosCwh
$uniqueId string The unique ID of the module. yii\base\Module
$userEntityRelationTable lispa\amos\cwh\AmosCwh
$userNetworks mixed lispa\amos\cwh\AmosCwh
$userProfileClass lispa\amos\cwh\AmosCwh
$validateOnStatus array Configuration array: for each content type class type the attribute correspondent to status and the status list for validation how to fill : [ 'class' => '', 'attribute' => 'status', 'statuses' => [ 'BOZZA', '. lispa\amos\cwh\AmosCwh
$validatoriEnabled lispa\amos\cwh\AmosCwh
$version string The version of this module. yii\base\Module
$viewPath string The root directory of view files. yii\base\Module
$widgetGraphics lispa\amos\cwh\AmosCwh
$widgetIcons lispa\amos\cwh\AmosCwh

Public Methods

Hide inherited methods

MethodDescriptionDefined 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() Constructor. yii\base\Module
__get() Getter magic method. yii\di\ServiceLocator
__isset() Checks if a property value is null. yii\di\ServiceLocator
__set() Sets the value of a component property. yii\base\Component
__unset() Sets a component property to be null. yii\base\Component
afterAction() This method is invoked right after an action within this module is executed. yii\base\Module
afterSaveModelDelCache() lispa\amos\cwh\AmosCwh
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 within this module is executed. yii\base\Module
beginCreateNewSessionKey() This method return the session key that must be used to add in session the url from the user have started the content creation. lispa\amos\core\module\AmosModule
beginCreateNewSessionKeyDateTime() This method return the session key that must be used to add in session the url date and time creation from the user have started the content creation. lispa\amos\core\module\AmosModule
behaviors() Returns a list of behaviors that this component should behave as. yii\base\Component
bootstrap() lispa\amos\cwh\AmosCwh
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
clear() Removes the component from the locator. yii\di\ServiceLocator
createController() Creates a controller instance based on the given route. yii\base\Module
createControllerByID() Creates a controller based on the given controller ID. yii\base\Module
createModel() lispa\amos\core\module\AmosModule
defineModelClasses() Merges the default and user defined model classes Also let's the developer to set new ones with the parameter being those the ones with most preference. lispa\amos\core\module\AmosModule
detachBehavior() Detaches a behavior from the component. yii\base\Component
detachBehaviors() Detaches all behaviors from the component. yii\base\Component
ensureBehaviors() Makes sure that the behaviors declared in behaviors() are attached to this component. yii\base\Component
get() Returns the component instance with the specified ID. yii\di\ServiceLocator
getAmosUniqueId() lispa\amos\core\module\BaseAmosModule
getBasePath() Returns the root directory of the module. yii\base\Module
getBehavior() Returns the named behavior object. yii\base\Component
getBehaviors() Returns all behaviors attached to this component. yii\base\Component
getComponents() Returns the list of the component definitions or the loaded component instances. yii\di\ServiceLocator
getControllerPath() Returns the directory that contains the controller classes according to $controllerNamespace. yii\base\Module
getCwhScope() lispa\amos\cwh\AmosCwh
getDefaultModels() lispa\amos\cwh\AmosCwh
getFullNetworkModels() lispa\amos\cwh\AmosCwh
getI18nDirPath() lispa\amos\core\module\AmosModule
getInstance() Returns the currently requested instance of this module class. yii\base\Module
getLayoutPath() Returns the directory that contains layout view files for this module. yii\base\Module
getModule() Retrieves the child module of the specified ID. yii\base\Module
getModuleName() lispa\amos\cwh\AmosCwh
getModules() Returns the sub-modules in this module. yii\base\Module
getNetworkModels() lispa\amos\cwh\AmosCwh
getPostKey() Chiave che verrà spedita in post lispa\amos\cwh\AmosCwh
getRbacEnabled() lispa\amos\core\module\BaseAmosModule
getUniqueId() Returns an ID that uniquely identifies this module among all modules within the current application. yii\base\Module
getUserNetworks() Returns Query for CwhNodi (networks) of which user is member. lispa\amos\cwh\AmosCwh
getVersion() Returns current module version. yii\base\Module
getViewPath() Returns the directory that contains the view files for this module. yii\base\Module
getWidgetGraphics() lispa\amos\cwh\AmosCwh
getWidgetIcons() lispa\amos\cwh\AmosCwh
has() Returns a value indicating whether the locator has the specified component definition or has instantiated the component. yii\di\ServiceLocator
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
hasModule() Checks whether the child module of the specified ID exists. yii\base\Module
hasProperty() Returns a value indicating whether a property is defined for this component. yii\base\Component
init() lispa\amos\cwh\AmosCwh
instance() Return an instance of module lispa\amos\core\module\AmosModule
model() Get defined className of model lispa\amos\core\module\AmosModule
off() Detaches an existing event handler from this component. yii\base\Component
on() Attaches an event handler to an event. yii\base\Component
resetCwhMaterializatedView() lispa\amos\cwh\AmosCwh
resetCwhScopeInSession() Reset param cwh-scope in session to an empty array lispa\amos\cwh\AmosCwh
runAction() Runs a controller action specified by a route. yii\base\Module
set() Registers a component definition with this locator. yii\di\ServiceLocator
setAliases() Defines path aliases. yii\base\Module
setBasePath() Sets the root directory of the module. yii\base\Module
setComponents() Registers a set of component definitions in this locator. yii\di\ServiceLocator
setCwhScopeFromSession() Set cwh scope to the value of cwh-scope param in session lispa\amos\cwh\AmosCwh
setCwhScopeInSession() Set param cwh-scope in session lispa\amos\cwh\AmosCwh
setInstance() Sets the currently requested instance of this module class. yii\base\Module
setLayoutPath() Sets the directory that contains the layout files. yii\base\Module
setModule() Adds a sub-module to this module. yii\base\Module
setModules() Registers sub-modules in the current module. yii\base\Module
setPostKey() lispa\amos\cwh\AmosCwh
setRbacEnabled() lispa\amos\core\module\BaseAmosModule
setVersion() Sets current module version. yii\base\Module
setViewPath() Sets the directory that contains the view files. yii\base\Module
t() lispa\amos\core\module\BaseAmosModule
tHtml() Metodo da usare per tutte le traduzioni che non fanno parte di attributi dei tag html (es. Non si può usare nell'attributo "title" del tag "a") lispa\amos\core\module\BaseAmosModule
tOld() Metodo vecchio stile com'era nei plugin prima di introdurre le traduzioni a db. lispa\amos\core\module\BaseAmosModule
trigger() Triggers an event. yii\base\Component

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
defaultVersion() Returns default module version. yii\base\Module

Events

Hide inherited events

EventTypeDescriptionDefined By
EVENT_AFTER_ACTION yii\base\ActionEvent An event raised after executing a controller action. yii\base\Module
EVENT_BEFORE_ACTION yii\base\ActionEvent An event raised before executing a controller action. yii\base\Module

Property Details

$behaviors public read-only property
$cacheDuration public property
public $cacheDuration 86400
$cached public property
public boolean $cached false
$controllerNamespace public property
public string $controllerNamespace 'lispa\amos\cwh\controllers'
$cwhConfWizardEnabled public property
public $cwhConfWizardEnabled false
$cwhScope public read-only property
public void getCwhScope ( )
$cwhScopeInSession public write-only property

The list of cwh scopes

public void setCwhScopeInSession ( $cwhScope, $cwhRelation null )
$defaultModels public read-only property
$destinatariEnabled public property
public $destinatariEnabled true
$enableDestinatariFatherChildren public property
$fullNetworkModels public read-only property
$modelsEnabled public property
public array $modelsEnabled = []
$networkModels public read-only property
$permissionPrefix public property
public $permissionPrefix 'CWH_PERMISSION'
$postKey public property
public string getPostKey ( )
public void setPostKey ( $postKey )
$regolaPubblicazioneEnabled public property
$regolaPubblicazioneFilter public property

If true publication rule 'PUBLIC' (to all users) only if the user has the specified role $regolaPubblicazioneFilterRole

$regolaPubblicazioneFilterRole public property
  • default VALIDATOR_PLUS role if $regolaPubblicazioneFilter flag is setted only the specified role can view publication rule 1. PUBLIC - All users
public string $regolaPubblicazioneFilterRole 'VALIDATOR_PLUS'
$scope public property

The entities scope for which contents needs to be filtered

public array $scope = []
$tagsMatchEachTree public property

Set to true if a content is to be considered of user interest when there is tag-match of each tag tree Default is false - at least one content tag matching user interest (any tree)

public boolean $tagsMatchEachTree false
$userEntityRelationTable public property
$userNetworks public read-only property
public mixed getUserNetworks ( $userId null )
$userProfileClass public property
public $userProfileClass 'lispa\admin\models\UserProfile'
$validateOnStatus public property

Configuration array: for each content type class type the attribute correspondent to status and the status list for validation

how to fill : [

 'class' => '<the content type className>',
 'attribute' => 'status',
 'statuses' => [
     'BOZZA',
     '...'
 ]

]

$validatoriEnabled public property
public $validatoriEnabled true
$widgetGraphics public read-only property
public void getWidgetGraphics ( )
$widgetIcons public read-only property
public void getWidgetIcons ( )

Method Details

afterSaveModelDelCache() public method

public void afterSaveModelDelCache ( $event )
$event
bootstrap() public method

public void bootstrap ( $app )
$app
getCwhScope() public method

public void getCwhScope ( )
getDefaultModels() public method

public array getDefaultModels ( )
getFullNetworkModels() public method

public array getFullNetworkModels ( )
getModuleName() public static method

public static string getModuleName ( )
getNetworkModels() public method

public array getNetworkModels ( )
getPostKey() public method

Chiave che verrà spedita in post

public string getPostKey ( )
getUserNetworks() public method

Returns Query for CwhNodi (networks) of which user is member.

See also lispa\amos\cwh\query\CwhActiveQuery::getUserNetworksQuery().

public mixed getUserNetworks ( $userId null )
$userId integer
  • if null logged user id is considered
getWidgetGraphics() public method

public void getWidgetGraphics ( )
getWidgetIcons() public method

public void getWidgetIcons ( )
init() public method

public void init ( )
resetCwhMaterializatedView() public method

public void resetCwhMaterializatedView ( )
resetCwhScopeInSession() public method

Reset param cwh-scope in session to an empty array

public void resetCwhScopeInSession ( )
setCwhScopeFromSession() public method

Set cwh scope to the value of cwh-scope param in session

public void setCwhScopeFromSession ( )
setCwhScopeInSession() public method

Set param cwh-scope in session

public void setCwhScopeInSession ( $cwhScope, $cwhRelation null )
$cwhScope array

The list of cwh scopes

$cwhRelation array

Relation table between users and entity, specifing the entity data

call example $moduleCwh->setCwhScopeInSession([ 'community' => $id, // simple cwh scope for contents filtering, required ], [ // cwhRelation array specifying name of relation table, name of entity field on relation table and entity id field , // optional for compatibility with previous versions 'mm_name' => 'community_user_mm', 'entity_id_field' => 'community_id', 'entity_id' => $id ]);

setPostKey() public method

public void setPostKey ( $postKey )
$postKey string