• NAME
• Content
  • LookupObjectRight { ObjectType => undef, ObjectId => undef, Name => undef, Right => { create, update, delete, display } }
  • Create PARAMHASH
  • LoadByNameAndObject (Object => OBJECT, Name => NAME)
  • _DeserializeContent
  • Content
  • SubValue KEY
  • DeleteSubValue NAME
  • DeleteAllSubValues
  • SetSubValues { }
  • Object
  • CurrentUserHasRight
• TODO
  • id
  • Name
  • SetName VALUE
  • Description
  • SetDescription VALUE
  • Content
  • SetContent VALUE
  • ContentType
  • SetContentType VALUE
  • ObjectType
  • SetObjectType VALUE
  • ObjectId
  • SetObjectId VALUE
  • Creator
  • Created
  • LastUpdatedBy
  • LastUpdated
  • URI
  • _SyncLinks
  • CurrentUserCanSee

NAME

  RT::Attribute_Overlay 

Content

LookupObjectRight { ObjectType => undef, ObjectId => undef, Name => undef, Right => { create, update, delete, display } }

Returns the right that the user needs to have on this attribute's object to perform the related attribute operation. Returns "allow" if the right is otherwise unspecified.

Create PARAMHASH

Create takes a hash of values and creates a row in the database:

  varchar(200) 'Name'.
  varchar(255) 'Content'.
  varchar(16) 'ContentType',
  varchar(64) 'ObjectType'.
  int(11) 'ObjectId'.

You may pass a Object instead of ObjectType and ObjectId.

LoadByNameAndObject (Object => OBJECT, Name => NAME)

Loads the Attribute named NAME for Object OBJECT.

_DeserializeContent

DeserializeContent returns this Attribute's "Content" as a hashref.

Content

Returns this attribute's content. If it's a scalar, returns a scalar If it's data structure returns a ref to that data structure.

SubValue KEY

Returns the subvalue for $key.

DeleteSubValue NAME

Deletes the subvalue with the key NAME

DeleteAllSubValues

Deletes all subvalues for this attribute

SetSubValues { }

Takes a hash of keys and values and stores them in the content of this attribute.

Each key replaces the existing key with the same name

Returns a tuple of (status, message)

Object

Returns the object current attribute belongs to.

CAVEAT: the returned object is cached, reload it to get the latest data.

CurrentUserHasRight

One of "display" "update" "delete" or "create" and returns 1 if the user has that right for attributes of this name for this object.Returns undef otherwise.

TODO

We should be deserializing the content on load and then never again, rather than at every access

id

Returns the current value of id. (In the database, id is stored as int(11).)

Name

Returns the current value of Name. (In the database, Name is stored as varchar(255).)

SetName VALUE

Set Name to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, Name will be stored as a varchar(255).)

Description

Returns the current value of Description. (In the database, Description is stored as varchar(255).)

SetDescription VALUE

Set Description to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, Description will be stored as a varchar(255).)

Content

Returns the current value of Content. (In the database, Content is stored as blob.)

SetContent VALUE

Set Content to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, Content will be stored as a blob.)

ContentType

Returns the current value of ContentType. (In the database, ContentType is stored as varchar(16).)

SetContentType VALUE

Set ContentType to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, ContentType will be stored as a varchar(16).)

ObjectType

Returns the current value of ObjectType. (In the database, ObjectType is stored as varchar(64).)

SetObjectType VALUE

Set ObjectType to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, ObjectType will be stored as a varchar(64).)

ObjectId

Returns the current value of ObjectId. (In the database, ObjectId is stored as int(11).)

SetObjectId VALUE

Set ObjectId to VALUE. Returns (1, 'Status message') on success and (0, 'Error Message') on failure. (In the database, ObjectId will be stored as a int(11).)

Creator

Returns the current value of Creator. (In the database, Creator is stored as int(11).)

Created

Returns the current value of Created. (In the database, Created is stored as datetime.)

LastUpdatedBy

Returns the current value of LastUpdatedBy. (In the database, LastUpdatedBy is stored as int(11).)

LastUpdated

Returns the current value of LastUpdated. (In the database, LastUpdated is stored as datetime.)

URI

Returns this attribute's URI

_SyncLinks

For dashboard and homepage attributes, keep links to saved searches they include up to date. It does nothing for other attributes.

Returns 1 on success and 0 on failure.

CurrentUserCanSee

Shortcut of CurrentUserHasRight('display').

← Back to index