Class CollectionType

Description
Description | Vars (details) | Methods (details)

The CollectionType or PageType object represents reusable types of pages that can be added to a Concrete site.

Located in /models/collection_types.php (line 26) 

Object
   |
   --CollectionType
Variable Summary
Description | Vars (details) | Methods (details)
mixed $addCTGArray
mixed $addCTUArray
mixed $akIDArray
mixed $composerAKIDArray
mixed $ctID
Method Summary
Description | Vars (details) | Methods (details)
static void add ( $data, [ $pkg = null])
static CollectionType getByHandle (string $ctHandle)
static void getByID ( $ctID, [ $obj = null])
static void getList ([ $limiterType = null])
static void getListByPackage ( $pkg)
void assignCollectionAttribute ( $ak)
void canAddSubCollection ( $obj)
void delete ()
void getAvailableAttributeKeys ()
void getCollectionTypeComposerPublishMethod ()
void getCollectionTypeComposerPublishPageParentID ()
void getCollectionTypeComposerPublishPageTypeID ()
void getCollectionTypeHandle ()
void getCollectionTypeIcon ()
void getCollectionTypeIconImage ()
void getCollectionTypeID ()
void getCollectionTypeName ()
void getComposerAttributeKeys ()
void getComposerContentItems ()
void getComposerPageTypes ()
void getIcons ()
void getMasterCollectionID ()
void getMasterTemplate ()
void getPackageHandle ()
void getPackageID ()
void getPages ()
void isAvailableCollectionTypeAttribute ( $akID)
void isCollectionTypeIncludedInComposer ()
void limit ( $obj)
void populateAvailableAttributeKeys ()
void refreshCache ()
void resetComposerData ()
void saveComposerAttributeKeys ([ $atids = array()])
void saveComposerContentItemOrder ( $items)
void saveComposerPublishTargetAll ()
void saveComposerPublishTargetPage ( $c)
void saveComposerPublishTargetPageType ( $ct)
void setComposerProperties ()
void setPropertiesFromArray ( $row)
void update ( $data)
Variables
Description | Vars (details) | Methods (details)
mixed $addCTGArray = array() (line 30)
  • access: public
mixed $addCTUArray = array() (line 29)
  • access: public
mixed $akIDArray = array() (line 31)
  • access: public
mixed $composerAKIDArray = array() (line 32)
  • access: public
mixed $ctID (line 28)
  • access: public
Methods
Description | Vars (details) Methods (details)
static add (line 218)
  • access: public
void add ( $data, [ $pkg = null])
  • $data
  • $pkg
static getByHandle (line 39)
  • access: public
CollectionType getByHandle (string $ctHandle)
  • string $ctHandle
static getByID (line 82)
  • access: public
void getByID ( $ctID, [ $obj = null])
  • $ctID
  • $obj
static getList (line 181)
  • access: public
void getList ([ $limiterType = null])
  • $limiterType
static getListByPackage (line 163)
  • access: public
void getListByPackage ( $pkg)
  • $pkg
assignCollectionAttribute (line 380)
  • access: public
void assignCollectionAttribute ( $ak)
  • $ak
canAddSubCollection (line 469)
  • access: public
void canAddSubCollection ( $obj)
  • $obj
delete (line 112)
  • access: public
void delete ()
getAvailableAttributeKeys (line 416)
  • access: public
void getAvailableAttributeKeys ()
getCollectionTypeComposerPublishMethod (line 504)
  • access: public
void getCollectionTypeComposerPublishMethod ()
getCollectionTypeComposerPublishPageParentID (line 507)
  • access: public
void getCollectionTypeComposerPublishPageParentID ()
getCollectionTypeComposerPublishPageTypeID (line 510)
  • access: public
void getCollectionTypeComposerPublishPageTypeID ()
getCollectionTypeHandle (line 502)
  • access: public
void getCollectionTypeHandle ()
getCollectionTypeIcon (line 514)
  • access: public
void getCollectionTypeIcon ()
getCollectionTypeIconImage (line 483)

returns the complete html img tag for this collection type's icon

  • access: public
void getCollectionTypeIconImage ()
getCollectionTypeID (line 500)
  • access: public
void getCollectionTypeID ()
getCollectionTypeName (line 501)
  • access: public
void getCollectionTypeName ()
getComposerAttributeKeys (line 430)
  • access: public
void getComposerAttributeKeys ()
getComposerContentItems (line 445)
  • access: public
void getComposerContentItems ()
getComposerPageTypes (line 130)
  • access: public
void getComposerPageTypes ()
getIcons (line 398)
  • access: public
void getIcons ()
getMasterCollectionID (line 513)
  • access: public
void getMasterCollectionID ()
getMasterTemplate (line 76)
  • access: public
void getMasterTemplate ()
getPackageHandle (line 516)
  • access: public
void getPackageHandle ()
getPackageID (line 515)
  • access: public
void getPackageID ()
getPages (line 260)
  • access: public
void getPages ()
isAvailableCollectionTypeAttribute (line 465)
  • access: public
void isAvailableCollectionTypeAttribute ( $akID)
  • $akID
isCollectionTypeIncludedInComposer (line 503)
  • access: public
void isCollectionTypeIncludedInComposer ()
limit (line 143)
  • access: public
void limit ( $obj)
  • $obj
populateAvailableAttributeKeys (line 386)
  • access: public
void populateAvailableAttributeKeys ()
refreshCache (line 175)
  • access: public
void refreshCache ()
resetComposerData (line 279)
  • access: public
void resetComposerData ()
saveComposerAttributeKeys (line 286)
  • access: public
void saveComposerAttributeKeys ([ $atids = array()])
  • $atids
saveComposerContentItemOrder (line 341)
  • access: public
void saveComposerContentItemOrder ( $items)
  • $items
saveComposerPublishTargetAll (line 333)
  • access: public
void saveComposerPublishTargetAll ()
saveComposerPublishTargetPage (line 317)
  • access: public
void saveComposerPublishTargetPage ( $c)
  • $c
saveComposerPublishTargetPageType (line 325)
  • access: public
void saveComposerPublishTargetPageType ( $ct)
  • $ct
setComposerProperties (line 60)
  • access: public
void setComposerProperties ()
setPropertiesFromArray (line 69)
  • access: public
void setPropertiesFromArray ( $row)
  • $row
update (line 359)
  • access: public
void update ( $data)
  • $data

Documentation generated on Thu, 15 Sep 2011 16:36:19 -0700 by phpDocumentor 1.4.1