This is the API documentation for concrete5 version 5.6 and earlier. View Current API Documentation

Class Concrete5_Model_FileSet

Concrete Model Class The model class extends the ADOdb active record class, allowing items that inherit from it to use the automatic create, updating, read and delete functionality it provides.

ADOdb_Active_Record
Extended by Concrete5_Library_Model
Extended by Model
Extended by Concrete5_Model_FileSet

Direct known subclasses

Concrete5_Model_FileSetSavedSearch, FileSet

Indirect known subclasses

FileSetSavedSearch

Methods summary

public
# getGlobal( )

Returns an object mapping to the global file set, fsID = 0. This is really only used for permissions mapping

public
public
public
public
public
# getMySets( $u = false )
public
public static FileSet
# getByID( integer $fsID )

Get a file set object by a file set's id

public static FileSet
# getByName( string $fsName )

Get a file set object by a file name

public
public
public
public static Mixed
# createAndGetSet( string $fs_name, integer $fs_type, integer $fs_uid = false )

Creats a new fileset if set doesn't exists

public object
# addFileToSet( type $f_id )

Adds the file to the set

public
public
public
# removeFileFromSet( $f_id )
public
# hasFileID( $f_id )
public array
# getFiles( )

Returns an array of File objects from the current set

public static array
# getFilesBySetID( integer $fsID )

Static method to return an array of File objects by the set id

public static array
# getFilesBySetName( string $fsName )

Static method to return an array of File objects by the set name

public
# delete( )
public
public
public
# assignPermissions( $userOrGroup, $permissions = array(), $accessType = Concrete5_Model_PermissionKey::ACCESS_TYPE_INCLUDE )

Constants summary

integer TYPE_PRIVATE
# 0
integer TYPE_PUBLIC
# 1
integer TYPE_STARRED
# 2

Properties summary

protected $fileSetFiles
#