Account Suspended
Account Suspended
This Account has been suspended.
Contact your hosting provider for more information.
 All Data Structures Functions Variables Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions
OwnedSecurableItem Class Reference
Inheritance diagram for OwnedSecurableItem:
SecurableItem Item CustomFieldsModel RedBeanModel BeanModel ObservableComponent Account Activity ApiTestModelItem ApiTestModelItem2 ApiTestModelItem3 ApiTestModelItem4 Campaign ContactWebForm Conversation Dashboard EmailMessage EmailTemplate EmailTemplateModelTestItem ExportItem ExportTestModelItem ExportTestModelItem2 ExportTestModelItem3 ExportTestModelItem4 ExportTestModelItem5 ExportTestModelItem6 GameReward ImportDedupeModelTestItem ImportModelTestItem ImportModelTestItem2 ImportModelTestItem3 ImportModelTestItem4 ImportModelTestItem5 MarketingList Mission ModelToArrayAdapterTestItem ModelToArrayAdapterTestItem2 ModelToArrayAdapterTestItem3 ModelToArrayAdapterTestItem4 Opportunity OwnedSecurableTestItem OwnedSecurableTestItem2 OwnedSecurableTestItem3 Person Product Project ReportModelTestItem ReportModelTestItem10 ReportModelTestItem12 ReportModelTestItem2 ReportModelTestItem3 ReportModelTestItem4 ReportModelTestItem5 ReportModelTestItem6 ReportModelTestItem7 ReportModelTestItem8 ReportModelTestItem9 SavedCalendar SavedReport SavedSearch SocialItem WorkflowModelTestItem WorkflowModelTestItem2 WorkflowModelTestItem3 WorkflowModelTestItem4 WorkflowModelTestItem5 WorkflowModelTestItem6 WorkflowModelTestItem7 WorkflowModelTestItem8 WorkflowModelTestItem9

Public Member Functions

 setTreatCurrentUserAsOwnerForPermissions ($value)
 
 isReallyModified ($relationType, $isOwned)
 
 getEffectivePermissions ($permitable=null)
 
 getActualPermissions ($permitable=null)
 
 setOwnerUnrestricted (User $user)
 
 __set ($attributeName, $value)
 
 onBeforeOwnerChange (CEvent $event)
 
 onAfterOwnerChange (CEvent $event)
 
 onAfterOwnerChangeAfterSave (CEvent $event)
 
 checkPermissionsHasAnyOf ($requiredPermissions, User $user=null)
 
- Public Member Functions inherited from SecurableItem
 getExplicitReadWriteModelPermissionsForWorkflow ()
 
 setExplicitReadWriteModelPermissionsForWorkflow (ExplicitReadWriteModelPermissions $permissions)
 
 clearExplicitReadWriteModelPermissionsForWorkflow ()
 
 getEffectivePermissions ($permitable=null)
 
 getActualPermissions ($permitable=null)
 
 processGetActualPermissionsAsNonOptimized ()
 
 getPropagatedActualAllowPermissions (Permitable $permitable)
 
 getExplicitActualPermissions ($permitable=null)
 
 getInheritedActualPermissions ($permitable=null)
 
 addPermissions (Permitable $permitable, $permissions, $type=Permission::ALLOW)
 
 removePermissions (Permitable $permitable, $permissions=Permission::ALL, $type=Permission::ALLOW_DENY)
 
 removeAllPermissions ()
 
 __get ($attributeName)
 
 __set ($attributeName, $value)
 
 delete ()
 
 checkPermissionsHasAnyOf ($requiredPermissions, User $user=null)
 
 addPermitableToAttachAfterSave (Permitable $permitable, $checkDetachBeforeAddition=false)
 
 removePermitableFromPermitablesToAttachAfterSave (Permitable $permitable)
 
 addPermitableToDetachAfterSave (Permitable $permitable, $checkAttachBeforeAddition=false)
 
 removePermitableFromPermitablesToDetachAfterSave (Permitable $permitable)
 
 arePermissionsChanged ()
 
- Public Member Functions inherited from Item
 onCreated ()
 
 onModified ()
 
 __set ($attributeName, $value)
 
 delete ()
 
 save ($runValidation=true, array $attributeNames=null)
 
 addWorkflowToProcessAfterSave (Workflow $workflow)
 
 getWorkflowsToProcessAfterSave ()
 
 setDoNotProcessWorkflowOnSave ()
 
 setProcessWorkflowOnSave ()
 
 shouldProcessWorkflowOnSave ()
 
 forgetOriginalAttributeValues ()
 
 testBeforeDelete ()
 
 isAttributeAudited ($attributeName)
 
 isAllowedToSetReadOnlyAttribute ($attributeName)
 
- Public Member Functions inherited from RedBeanModel
 getIsNewModel ()
 
 __construct ($setDefaults=true, RedBean_OODBBean $bean=null, $forceTreatAsCreation=false, $runConstruction=true)
 
 serialize ()
 
 unserialize ($data)
 
 getPrimaryBean ()
 
 getClassId ($modelClassName)
 
 getClassBean ($modelClassName)
 
 getModelIdentifier ()
 
 castDown (array $derivedModelClassNames)
 
 isSame (RedBeanModel $model)
 
 __toString ()
 
 __get ($attributeName)
 
 __set ($attributeName, $value)
 
 __isset ($attributeName)
 
 __unset ($attributeName)
 
 attributeNames ()
 
 isAttribute ($attributeName)
 
 isAttributeWithLowerCaseConversion ($attributeName)
 
 isAttributeReadOnly ($attributeName)
 
 isAttributeFormattedAsProbability ($attributeName)
 
 isAllowedToSetReadOnlyAttribute ($attributeName)
 
 rules ()
 
 behaviors ()
 
 attributeLabels ()
 
 abbreviatedAttributeLabels ()
 
 validate (array $attributeNames=null, $ignoreRequiredValidator=false)
 
 onBeforeValidate (CModelEvent $event)
 
 onAfterValidate ($event)
 
 getValidatorList ()
 
 getValidators ($attributeName=null)
 
 forgetValidators ()
 
 createValidators ()
 
 isUniqueAttributeValue ($attributeName, $value)
 
 save ($runValidation=true, array $attributeNames=null)
 
 isRelatedModelReallyModified ($relatedModel, $relationType, $isOwned)
 
 isReallyModified ($relationType, $isOwned)
 
 onBeforeSave ($event)
 
 onAfterSave ($event)
 
 onRedBeanOneToManyRelatedModelsChange ($event)
 
 onBeforeDelete ($event)
 
 onAfterDelete ($event)
 
 isModified ()
 
 delete ()
 
 isDeleted ()
 
 isDeletable ()
 
 forget ()
 
 isAttributeRequired ($attributeName)
 
 isAttributeSafe ($attributeName)
 
 getAttributeLabel ($attributeName)
 
 getAttributeLabelsForAllActiveLanguagesByAttributeName ($attributeName)
 
 hasErrors ($attributeNameOrNames=null)
 
 getErrors ($attributeNameOrNames=null)
 
 getError ($attributeName)
 
 addError ($attributeName, $errorMessage)
 
 addErrors (array $errors)
 
 clearErrors ($attributeName=null)
 
 generateAttributeLabel ($attributeName)
 
 getAttributes (array $attributeNames=null)
 
 setAttributes (array $values, $safeOnly=true)
 
 unsetAttributes ($attributeNames=null)
 
 onUnsafeAttribute ($name, $value)
 
 getScenario ()
 
 setScenario ($scenarioName)
 
 getSafeAttributeNames ()
 
 getIterator ()
 
 offsetExists ($offset)
 
 offsetGet ($offset)
 
 offsetSet ($offset, $item)
 
 offsetUnset ($offset)
 
 stringifyOneToManyRelatedModelsValues ($values)
 
 setIsCopied ()
 
 isCopied ()
 
 addValidator ($attribute, $validator, $params=array())
 
- Public Member Functions inherited from ObservableComponent
 init ()
 
 attachEvents ($events)
 
 events ()
 
 attachEventHandler ($name, $handler)
 
 detachEventHandler ($name, $handler)
 

Static Public Member Functions

static getDefaultMetadata ()
 
static makeSubsetOrCountSqlQuery ($tableName, RedBeanModelJoinTablesQueryAdapter $joinTablesAdapter=null, $offset=null, $count=null, $where=null, $orderBy=null, $selectCount=false, $selectDistinct=false, array $quotedExtraSelectColumnNameAndAliases=array())
 
static resolveReadPermissionsOptimizationToSqlQuery (User $user, RedBeanModelJoinTablesQueryAdapter $joinTablesAdapter, &$where, &$selectDistinct)
 
static isTypeDeletable ()
 
static hasReadPermissionsSubscriptionOptimization ()
 
static supportsQueueing ()
 
- Static Public Member Functions inherited from SecurableItem
static getDefaultMetadata ()
 
static isTypeDeletable ()
 
static hasReadPermissionsOptimization ()
 
- Static Public Member Functions inherited from Item
static getDefaultMetadata ()
 
static isTypeDeletable ()
 
static getGamificationRulesType ()
 
static getNonConfigurableAttributes ()
 
static getByName ($name)
 
- Static Public Member Functions inherited from CustomFieldsModel
static getCanHaveBean ()
 
- Static Public Member Functions inherited from RedBeanModel
static model ($className=null)
 
static getAll ($orderBy=null, $sortDescending=false, $modelClassName=null)
 
static getSubset (RedBeanModelJoinTablesQueryAdapter $joinTablesAdapter=null, $offset=null, $count=null, $where=null, $orderBy=null, $modelClassName=null, $selectDistinct=false)
 
static getSubsetIds (RedBeanModelJoinTablesQueryAdapter $joinTablesAdapter=null, $offset=null, $count=null, $where=null, $orderBy=null, $modelClassName=null, $selectDistinct=false)
 
static makeSubsetOrCountSqlQuery ($tableName, RedBeanModelJoinTablesQueryAdapter $joinTablesAdapter, $offset=null, $count=null, $where=null, $orderBy=null, $selectCount=false, $selectDistinct=false, array $quotedExtraSelectColumnNameAndAliases=array())
 
static getCount (RedBeanModelJoinTablesQueryAdapter $joinTablesAdapter=null, $where=null, $modelClassName=null, $selectDistinct=false)
 
static getById ($id, $modelClassName=null)
 
static deleteAll ()
 
static mangleTableName ()
 
static getTableName ()
 
static getTableNames ($classNames)
 
static getForeignKeyName ($modelClassName, $relationName)
 
static getModelClassNameByIdentifier ($identifier)
 
static getMetadata ()
 
static canSaveMetadata ()
 
static setMetadata (array $metadata)
 
static getDefaultMetadata ()
 
static isTypeDeletable ()
 
static forgetAll ()
 
static getModelLabelByTypeAndLanguage ($type, $language=null)
 
static getAnAttributeLabel ($attributeName)
 
static makeModel (RedBean_OODBBean $bean, $modelClassName=null)
 
static makeModels (array $beans, $modelClassName=null)
 
static getModuleClassName ()
 
static getLastClassInBeanHeirarchy ()
 
static getSortAttributesByAttribute ($attribute)
 
static isCacheable ()
 
static getYiiValidatorsToRedBeanValidators ()
 
static getHasManyOpposingRelationName (RedBeanModel $model, $precedingModelClassName, $precedingRelation)
 
static relationLinksToPrecedingRelation ($modelClassName, $relation, $precedingModelClassName=null, $precedingRelation=null)
 
static allowMemcacheCache ()
 
- Static Public Member Functions inherited from BeanModel
static getCanHaveBean ()
 
static getMetadata ()
 
static isAnAttribute ($attributeName)
 
static resolveAttributeModelClassName ($attributeName)
 
static getAttributeModelClassName ($attributeName)
 
static isRelation ($attributeName)
 
static isOwnedRelation ($attributeName)
 
static getRelationType ($relationName)
 
static getRelationModelClassName ($relationName)
 
static getRelationLinkType ($relationName)
 
static getRelationLinkName ($relationName)
 
static isRelationTypeAHasManyVariant ($relationName)
 
static isRelationTypeAHasOneVariant ($relationName)
 
static isADerivedRelationViaCastedUpModel ($relationName)
 
static getDerivedRelationType ($relationName)
 
static getDerivedRelationModelClassName ($relationName)
 
static getDerivedRelationViaCastedUpModelOpposingRelationName ($relationName)
 
static getInferredRelationModelClassNamesForRelation ($relation)
 
static getColumnNameByAttribute ($attributeName)
 
static getAttributeNames ()
 
static generateAnAttributeLabel ($attributeName)
 
static getAbbreviatedAttributeLabel ($attributeName)
 
static getTranslatedAttributeLabels ($language)
 
static getMixedInModelClassNames ()
 
static isRelationTypeAManyManyVariant ($relationName)
 

Protected Member Functions

 constructDerived ($bean, $setDefaults)
 
 resolveEffectivePermissionsForOwnerAndCreatedByUser ($permitable)
 
 ownerChange ($newOwnerValue)
 
 afterSave ()
 
 beforeDelete ()
 
- Protected Member Functions inherited from SecurableItem
 recursiveGetPropagatedAllowPermissions ($role)
 
 getAllDescendentRoles ($role)
 
 afterSave ()
 
 resolvePermitablesToUpdate ()
 
 updatePermitables (ExplicitReadWriteModelPermissions $explicitReadWriteModelPermissions)
 
 isPermitableUpdateRequired (ExplicitReadWriteModelPermissions $explicitReadWriteModelPermissions)
 
 resolveRelativePermitablesToBeUpdated (ExplicitReadWriteModelPermissions $explicitReadWriteModelPermissions)
 
 resolvePermitablesToAttach (ExplicitReadWriteModelPermissions $explicitReadWriteModelPermissions)
 
 resolvePermitablesToDetach (ExplicitReadWriteModelPermissions $explicitReadWriteModelPermissions)
 
- Protected Member Functions inherited from Item
 beforeSave ()
 
 afterSave ()
 
 logAuditEventsListForModified ($newModel)
 
- Protected Member Functions inherited from CustomFieldsModel
 unrestrictedGet ($attributeName)
 
 constructDerived ($bean, $setDefaults)
 
- Protected Member Functions inherited from RedBeanModel
 constructDerived ($bean, $setDefaults)
 
 constructIncomplete ($bean)
 
 setNotModified ()
 
 onCreated ()
 
 onLoaded ()
 
 onModified ()
 
 mapAndCacheMetadataAndSetHints ($modelClassName, RedBean_OODBBean $bean)
 
 runDefaultValidators ()
 
 setClassBean ($modelClassName, RedBean_OODBBean $bean)
 
 unrestrictedGet ($attributeName)
 
 unrestrictedSet ($attributeName, $value)
 
 beforeValidate ()
 
 afterValidate ()
 
 beforeSave ()
 
 afterSave ()
 
 linkBeans ()
 
 beforeDelete ()
 
 afterDelete ()
 
 unrestrictedDelete ()
 
 deleteOwnedRelatedModels ($modelClassName)
 
 deleteForeignRelatedModels ($modelClassName)
 
 deleteManyManyRelations ($modelClassName)
 

Static Protected Member Functions

static getModifiedSignalAttribute ()
 
static bypassReadPermissionsOptimizationToSqlQueryBasedOnWhere ($where)
 
static translatedAttributeLabels ($language)
 
- Static Protected Member Functions inherited from Item
static getByNameOrEquivalent ($attributeName, $value)
 
static translatedAttributeLabels ($language)
 
- Static Protected Member Functions inherited from RedBeanModel
static makeCasedLinkName ($relationType, $linkType, $relationLinkName)
 
static getModelIdentifierByClassNameAndBeanId ($modelClassName, $beanId)
 
static assertMetadataIsValid (array $metadata)
 
static getByRelatedClassId ($relatedModelClassName, $id, $modelClassName=null)
 
static getLabel ($language=null)
 
static getPluralLabel ($language=null)
 
static getAttributeLabelByLanguage ($attributeName, $language)
 
static getTranslatedCustomAttributeLabelByLanguage ($attributeName, $languageCode)
 
static resolveModelClassNameForClassesWithoutBeans (&$modelClassName)
 
- Static Protected Member Functions inherited from BeanModel
static translatedAbbreviatedAttributeLabels ($language)
 
static translatedAttributeLabels ($language)
 
static getAttributeNamesToClassNamesForModel ()
 
static getAttributeNamesNotBelongsToOrManyManyForModel ()
 
static getRelationNameToRelationTypeModelClassNameAndOwnsForModel ()
 
static getDerivedRelationNameToTypeModelClassNameAndOppposingRelationForModel ()
 
static forgetBeanModel ($modelClassName)
 
static forgetAllBeanModels ()
 
static resolveCacheAndMapMetadataForAllClassesInHeirarchy ()
 
static resolveCachedMetadataForIntegrity ($cachedData)
 
static resolveLinkTypeAndRelationLinkName ($relationTypeModelClassNameAndOwns, &$linkType, &$relationLinkName)
 

Additional Inherited Members

- Data Fields inherited from Item
 $originalAttributeValues = array()
 
- Data Fields inherited from RedBeanModel
const MODEL_IDENTIFIER_DELIMITER = '_'
 
- Data Fields inherited from BeanModel
const HAS_ONE_BELONGS_TO = 0
 
const HAS_MANY_BELONGS_TO = 1
 
const HAS_ONE = 2
 
const HAS_MANY = 3
 
const MANY_MANY = 4
 
const OWNED = true
 
const NOT_OWNED = false
 
const CACHE_IDENTIFIER = 'BeanModelMapping'
 
const LINK_TYPE_ASSUMPTIVE = 0
 
const LINK_TYPE_SPECIFIC = 1
 
const LINK_TYPE_POLYMORPHIC = 2
 
- Protected Attributes inherited from Item
 $isSetting = false
 
 $isAudited = true
 
- Protected Attributes inherited from RedBeanModel
 $modelClassNameToBean = array()
 
 $attributeNameToBeanAndClassName = array()
 
 $relationNameToRelatedModel = array()
 
 $unlinkedRelationNames = array()
 
 $unlinkedOwnedRelatedModelsToRemove = array()
 
 $validators = array()
 
 $attributeNameToErrors = array()
 
 $scenarioName = ''
 
 $modified = false
 
 $deleted = false
 
 $isInIsModified = false
 
 $isInHasErrors = false
 
 $isInGetErrors = false
 
 $isValidating = false
 
 $isSaving = false
 
 $isDeleting = false
 
 $isNewModel = false
 
 $isCopied = false
 
 $isSavableFromRelation = true
 
- Static Protected Attributes inherited from CustomFieldsModel
static $lastClassInBeanHeirarchy = 'CustomFieldsModel'
 
- Static Protected Attributes inherited from RedBeanModel
static $lastClassInBeanHeirarchy = 'RedBeanModel'
 
static $attributeLabelsByLanguage = array()
 
- Static Protected Attributes inherited from BeanModel
static $lastClassInBeanHeirarchy = 'BeanModel'
 

Detailed Description

A securable item 'owned' by a user in the system.

Definition at line 40 of file OwnedSecurableItem.php.

Member Function Documentation

setTreatCurrentUserAsOwnerForPermissions (   $value)

Set when the current user needs to operate like the owner. This can be when a user is creating a new model that he/she does not own. The current user still needs to be able to set permissions for example

Parameters
boolean$value

Definition at line 57 of file OwnedSecurableItem.php.

constructDerived (   $bean,
  $setDefaults 
)
protected
Parameters
RedBean_OODBBean$bean
bool$setDefaults
Exceptions
NoCurrentUserSecurityException

Definition at line 68 of file OwnedSecurableItem.php.

isReallyModified (   $relationType,
  $isOwned 
)

See Stories #82063952 and #82699138 Detects if the model is changed outside of being altered by a default value. An example is a new opportunity that has a default stage value. This shows as isModified=true but this is not sufficient to signal a save is needed. The 'name' attribute for example is a good signal that the model has in fact been modified.

See Also
RedBeanModel::isReallyModified
Parameters
$relationTypeinteger
$isOwnedboolean
Returns
bool

Definition at line 100 of file OwnedSecurableItem.php.

static getModifiedSignalAttribute ( )
staticprotected

Used to signal

See Also
isReallyModified
Returns
string - attribute that must have a value on the model when saving.

Definition at line 120 of file OwnedSecurableItem.php.

setOwnerUnrestricted ( User  $user)

Used to set model's owner without all the checks and audit logs. Used in event handling code for queues.

Parameters
User$user

Definition at line 204 of file OwnedSecurableItem.php.

static makeSubsetOrCountSqlQuery (   $tableName,
RedBeanModelJoinTablesQueryAdapter  $joinTablesAdapter = null,
  $offset = null,
  $count = null,
  $where = null,
  $orderBy = null,
  $selectCount = false,
  $selectDistinct = false,
array  $quotedExtraSelectColumnNameAndAliases = array() 
)
static

Override to add ReadPermissionOptimization query parts.

Parameters
string$tableName
RedBeanModelJoinTablesQueryAdapter$joinTablesAdapter
null | int$offset
null | int$count
null | string$where
null | string$orderBy
bool$selectCount
bool$selectDistinct
array$quotedExtraSelectColumnNameAndAliases
Returns
string
Exceptions
NoCurrentUserSecurityException

Definition at line 344 of file OwnedSecurableItem.php.

static resolveReadPermissionsOptimizationToSqlQuery ( User  $user,
RedBeanModelJoinTablesQueryAdapter  $joinTablesAdapter,
$where,
$selectDistinct 
)
static
Parameters
User$user
RedBeanModelJoinTablesQueryAdapter$joinTablesAdapter
$where
$selectDistinct
Exceptions
NotSupportedException

Definition at line 380 of file OwnedSecurableItem.php.

static hasReadPermissionsSubscriptionOptimization ( )
static

Should model have read permission subscription table or not. This feature is used to track of created/deleted models, so we can easily sync Zurmo with Google Apps or Outlook

Returns
bool

Definition at line 460 of file OwnedSecurableItem.php.

static supportsQueueing ( )
static

Describes if the current model supports being routed through queues. This is for the Queues feature in commercial edition.

Definition at line 469 of file OwnedSecurableItem.php.


The documentation for this class was generated from the following file:
Generated on Thu Aug 6 2020 07:10:55
Account Suspended
Account Suspended
This Account has been suspended.
Contact your hosting provider for more information.