Class Set

Represents a file set.

Concrete\Core\File\Set\Set implements Concrete\Core\Permission\ObjectInterface

Direct known subclasses

Concrete\Core\File\Set\SavedSearch

Namespace: Concrete\Core\File\Set
Located at src/File/Set/Set.php

Methods summary

public static
# getGlobal( )

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

public static array
# getMySets( boolean|User $u = false )
public static Mixed
# createAndGetSet( string $fs_name, integer $fs_type, integer|boolean $fs_uid = false )

Creats a new fileset if set doesn't exists.

public static Concrete\Core\File\Set\Set
# getByID( integer $fsID )

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

public static
# __callStatic( $name, $arguments )
public static Concrete\Core\File\Set\Set
# create( string $setName, integer $fsOverrideGlobalPermissions = 0, boolean|User $u = false, integer $type = Concrete\Core\File\Set\Set::TYPE_PUBLIC )

Adds a File 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, integer|boolean $uID = false )

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

public static Concrete\Core\File\Set\Set
# getByName( string $fsName, integer|boolean $uID = false )

Get a file set object by a file name.

public Concrete\Core\File\Set\File[]
# getFiles( )

Returns an array of File objects from the current set.

public integer
# getFileSetUserID( )
public integer
# getFileSetType( )
public
public
public
public
public integer
public integer
# getFileSetID( )
public
# updateFileSetDisplayOrder( array $files )
public integer
# overrideGlobalPermissions( )
public string
# getFileSetName( )
public string
# getFileSetDisplayName( string $format = 'html' )

Returns the display name for this file set (localized and escaped accordingly to $format).

public Concrete\Core\File\Set\Set
# update( $setName, $fsOverrideGlobalPermissions = 0 )

Updates a file set.

public Concrete\Core\File\Set\File|mixed
# addFileToSet( integer|File $f_id )

Adds the file to the set.

public
public
public
# removeFileFromSet( integer|File $f_id )
public
# hasFileID( $f_id )
public
# delete( )
public
public
public
# assignPermissions( $userOrGroup, $permissions = array(), $accessType = Concrete\Core\File\Set\FileSetPermissionKey::ACCESS_TYPE_INCLUDE )
public

Constants summary

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

Properties summary

protected $fileSetFiles
#
public integer $fsID

File Set ID

#
public integer $uID

User ID

#
public string $fsName

File Set Name

#
public integer $fsOverrideGlobalPermissions
#
public integer $fsType
#
public $fsSearchRequest
#
public $fsResultColumns
#