Modules/Groupware/Files/Folder/Model/Folder.php

Show: inherited
Table of Contents

\Conjoon_Modules_Groupware_Files_Folder_Model_Folder

Package: Conjoon\Groupware\Files\Model

Table data gateway. Models the table <tt>groupware_files_folders</tt>.

Parent(s)
\Conjoon_Db_Table < \Zend_Db_Table
Author
Thorsten Suckow-Homberg  
Category
Model  
Uses
\Conjoon_Db_Table  

Properties

Propertyprotectedstring  $_name= ''groupware_files_folders''

The name of the table in the underlying datastore this class represents.

Default value'groupware_files_folders'Details
Type
string
Propertyprotectedstring  $_primary= ''id''

The name of the column that denotes the primary key for this table

Default value'id'Details
Type
string
PropertyprotectedString  $_tblPrefix= '""'
staticinherited

Default table prefix.

Inherited from: \Conjoon_Db_Table::$$_tblPrefix
Default value""Details
Type
String
Inherited_from
\Conjoon_Db_Table::$$_tblPrefix  

Methods

methodpublic__construct( string | array $config = array(), \unknown_type $definition = null ) : void
inherited

__construct() - For concrete implementation of Conjoon_Db_Table

Inherited from: \Conjoon_Db_Table::__construct()

This constructor automatically prepends the prefix as defined using setTablePrefix() to this table's name.

Parameters
Name Type Description
$config string | array

string can reference a Zend_Registry key for a db adapter OR it can refernece the name of a table

$definition \unknown_type
methodprotected_getDefaultFolderIdForType(  $userId,  $type ) : integer

Parameters
Name Type Description
$userId
$type
Returns
Type Description
integer
Throws
Exception Description
\InvalidArgumentException
methodpublicaddFolder( integer $userId, string $name, integer $parentId,  $type,  $isLocked = false,  $isChildAllowed = true ) : integer

Adds a folder to the specified folder id.

Parameters
Name Type Description
$userId integer
$name string
$parentId integer
$type
$isLocked
$isChildAllowed
Returns
Type Description
integer
Throws
Exception Description
\InvalidArgumentException
methodpubliccreateTempFolderForUser( integer $userId ) : integer

Creates the temp folder for the specified user id.

Parameters
Name Type Description
$userId integer
Returns
Type Description
integer
Throws
Exception Description
\InvalidArgumentException
methodpublicgetFolderIdForName( string $name, integer $parentId ) : integer

Returns the id of the folder with the the sppecified name for the specified parent folder. Returns 0 if no wolder was found.

Parameters
Name Type Description
$name string
$parentId integer
Returns
Type Description
integer
Throws
Exception Description
\InvalidArgumentException
methodpublicgetTablePrefix( ) : String
staticinherited

Returns the table prefix.

Inherited from: \Conjoon_Db_Table::getTablePrefix()
Returns
Type Description
String
methodpublicgetTempFolderIdForUser( integer $userId ) : integer

Returns the base temp folder id for the specified user, i.e. the folder with type "temp".

Returns 0 if the folder could not be found

Parameters
Name Type Description
$userId integer
Returns
Type Description
integer
Throws
Exception Description
\InvalidArgumentException
methodpublicsetTablePrefix( String $prefix ) : void
staticinherited

Sets the table prefix.

Inherited from: \Conjoon_Db_Table::setTablePrefix()
Parameters
Name Type Description
$prefix String
Documentation was generated by DocBlox 0.18.1.