MODX Revolution Object Cheat Sheet: modTemplateVar

MODX Revolution Object Cheat Sheet: modTemplateVar

modTemplateVar database table fields, schema definitions, and relationships: aggregate, composite, ancestral. Also provides default object values.

Posted on February 02, 2015 at 08:03:00
Tags: Cheatsheet, modTemplateVar
Words: 749
Level: Beginner
Dependencies: None

modTemplateVar (2.7.0-pl)

Table Fields



    [id] => 
    [source] => 0
    [property_preprocess] => 0
    [type] => 
    [name] => 
    [caption] => 
    [description] => 
    [editor_type] => 0
    [category] => 0
    [locked] => 0
    [elements] => 
    [rank] => 0
    [display] => 
    [default_text] => 
    [properties] => 
    [input_properties] => 
    [output_properties] => 
    [static] => 0
    [static_file] => 

Validation Rules



    [name] => 
        
            [invalid] => 
                
                    [type] => preg_match
                    [rule] => /^?!\s[a-zA-Z0-9\x2d-\x2f\x7f-\xff-_\s]+?!\s$/
                    [message] => tv_err_invalid_name
                

            [reserved] => 
                
                    [type] => preg_match
                    [rule] => /^?!id|type|contentType|pagetitle|longtitle|description|alias|link_attributes|published|pub_date|unpub_date|parent|isfolder|introtext|content|richtext|template|menuindex|searchable|cacheable|createdby|createdon|editedby|editedon|deleted|deletedby|deletedon|publishedon|publishedby|menutitle|donthit|privateweb|privatemgr|content_dispo|hidemenu|class_key|context_key|content_type|uri|uri_override|hide_children_in_tree|show_in_tree$/
                    [message] => tv_err_reserved_name
                

        


Index Meta



    [PRIMARY] => 
        
            [alias] => PRIMARY
            [primary] => 1
            [unique] => 1
            [type] => BTREE
            [columns] => 
                
                    [id] => 
                        
                            [length] => 
                            [collation] => A
                            [null] => 
                        

                

        

    [name] => 
        
            [alias] => name
            [primary] => 
            [unique] => 1
            [type] => BTREE
            [columns] => 
                
                    [name] => 
                        
                            [length] => 
                            [collation] => A
                            [null] => 
                        

                

        

    [category] => 
        
            [alias] => category
            [primary] => 
            [unique] => 
            [type] => BTREE
            [columns] => 
                
                    [category] => 
                        
                            [length] => 
                            [collation] => A
                            [null] => 
                        

                

        

    [locked] => 
        
            [alias] => locked
            [primary] => 
            [unique] => 
            [type] => BTREE
            [columns] => 
                
                    [locked] => 
                        
                            [length] => 
                            [collation] => A
                            [null] => 
                        

                

        

    [rank] => 
        
            [alias] => rank
            [primary] => 
            [unique] => 
            [type] => BTREE
            [columns] => 
                
                    [rank] => 
                        
                            [length] => 
                            [collation] => A
                            [null] => 
                        

                

        

    [static] => 
        
            [alias] => static
            [primary] => 
            [unique] => 
            [type] => BTREE
            [columns] => 
                
                    [static] => 
                        
                            [length] => 
                            [collation] => A
                            [null] => 
                        

                

        


Field Aliases



    [content] => default_text

Table Construction meta defined in schema



    [id] => 
        
            [dbtype] => int
            [precision] => 10
            [attributes] => unsigned
            [phptype] => integer
            [null] => 
            [index] => pk
            [generated] => native
        

    [source] => 
        
            [dbtype] => int
            [attributes] => unsigned
            [phptype] => integer
            [null] => 
            [default] => 0
            [index] => fk
        

    [property_preprocess] => 
        
            [dbtype] => tinyint
            [precision] => 1
            [attributes] => unsigned
            [phptype] => boolean
            [null] => 
            [default] => 0
        

    [type] => 
        
            [dbtype] => varchar
            [precision] => 20
            [phptype] => string
            [null] => 
            [default] => 
        

    [name] => 
        
            [dbtype] => varchar
            [precision] => 50
            [phptype] => string
            [null] => 
            [default] => 
            [index] => unique
        

    [caption] => 
        
            [dbtype] => varchar
            [precision] => 80
            [phptype] => string
            [null] => 
            [default] => 
        

    [description] => 
        
            [dbtype] => varchar
            [precision] => 191
            [phptype] => string
            [null] => 
            [default] => 
        

    [editor_type] => 
        
            [dbtype] => int
            [precision] => 11
            [phptype] => integer
            [null] => 
            [default] => 0
        

    [category] => 
        
            [dbtype] => int
            [precision] => 11
            [phptype] => integer
            [null] => 
            [default] => 0
            [index] => fk
        

    [locked] => 
        
            [dbtype] => tinyint
            [precision] => 1
            [attributes] => unsigned
            [phptype] => boolean
            [null] => 
            [default] => 0
            [index] => index
        

    [elements] => 
        
            [dbtype] => text
            [phptype] => string
        

    [rank] => 
        
            [dbtype] => int
            [precision] => 11
            [phptype] => integer
            [null] => 
            [default] => 0
            [index] => index
        

    [display] => 
        
            [dbtype] => varchar
            [precision] => 20
            [phptype] => string
            [null] => 
            [default] => 
        

    [default_text] => 
        
            [dbtype] => mediumtext
            [phptype] => string
        

    [properties] => 
        
            [dbtype] => text
            [phptype] => array
            [null] => 1
        

    [input_properties] => 
        
            [dbtype] => text
            [phptype] => array
            [null] => 1
        

    [output_properties] => 
        
            [dbtype] => text
            [phptype] => array
            [null] => 1
        

    [static] => 
        
            [dbtype] => tinyint
            [precision] => 1
            [attributes] => unsigned
            [phptype] => boolean
            [null] => 
            [default] => 0
            [index] => index
        

    [static_file] => 
        
            [dbtype] => varchar
            [precision] => 191
            [phptype] => string
            [null] => 
            [default] => 
        


Aggregate Relations



    [CategoryAcls] => 
        
            [class] => modAccessCategory
            [local] => category
            [foreign] => target
            [owner] => local
            [cardinality] => many
        

    [Source] => 
        
            [class] => sources.modMediaSource
            [local] => source
            [foreign] => id
            [owner] => foreign
            [cardinality] => one
        

    [Category] => 
        
            [class] => modCategory
            [local] => category
            [foreign] => id
            [cardinality] => one
            [owner] => foreign
        


Composite Relations



    [Acls] => 
        
            [class] => modAccessElement
            [local] => id
            [foreign] => target
            [owner] => local
            [cardinality] => many
        

    [PropertySets] => 
        
            [class] => modElementPropertySet
            [local] => id
            [foreign] => element
            [owner] => local
            [cardinality] => many
            [criteria] => 
                
                    [foreign] => 
                        
                            [element_class] => modTemplateVar
                        

                

        

    [TemplateVarTemplates] => 
        
            [class] => modTemplateVarTemplate
            [local] => id
            [foreign] => tmplvarid
            [cardinality] => many
            [owner] => local
        

    [TemplateVarResources] => 
        
            [class] => modTemplateVarResource
            [local] => id
            [foreign] => tmplvarid
            [cardinality] => many
            [owner] => local
        

    [TemplateVarResourceGroups] => 
        
            [class] => modTemplateVarResourceGroup
            [local] => id
            [foreign] => tmplvarid
            [cardinality] => many
            [owner] => local
        


Ancestors



    [0] => modTemplateVar
    [1] => modElement
    [2] => modAccessibleSimpleObject
    [3] => modAccessibleObject
    [4] => xPDOObject

MODX:
Website development platform combining security, power, and innovation.