rapila
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
BaseDocument Class Reference
Inheritance diagram for BaseDocument:
Document

Public Member Functions

 applyDefaultValues ()
 
 __construct ()
 
 getId ()
 
 getName ()
 
 getOriginalName ()
 
 getDescription ()
 
 getContentCreatedAt ($format= '%x')
 
 getLicense ()
 
 getAuthor ()
 
 getLanguageId ()
 
 getOwnerId ()
 
 getDocumentTypeId ()
 
 getDocumentCategoryId ()
 
 getIsPrivate ()
 
 getIsProtected ()
 
 getSort ()
 
 getHash ()
 
 getCreatedAt ($format= 'Y-m-d H:i:s')
 
 getUpdatedAt ($format= 'Y-m-d H:i:s')
 
 getCreatedBy ()
 
 getUpdatedBy ()
 
 setId ($v)
 
 setName ($v)
 
 setOriginalName ($v)
 
 setDescription ($v)
 
 setContentCreatedAt ($v)
 
 setLicense ($v)
 
 setAuthor ($v)
 
 setLanguageId ($v)
 
 setOwnerId ($v)
 
 setDocumentTypeId ($v)
 
 setDocumentCategoryId ($v)
 
 setIsPrivate ($v)
 
 setIsProtected ($v)
 
 setSort ($v)
 
 setHash ($v)
 
 setCreatedAt ($v)
 
 setUpdatedAt ($v)
 
 setCreatedBy ($v)
 
 setUpdatedBy ($v)
 
 hasOnlyDefaultValues ()
 
 hydrate ($row, $startcol=0, $rehydrate=false)
 
 ensureConsistency ()
 
 reload ($deep=false, PropelPDO $con=null)
 
 delete (PropelPDO $con=null)
 
 save (PropelPDO $con=null)
 
 getValidationFailures ()
 
 validate ($columns=null)
 
 getByName ($name, $type=BasePeer::TYPE_PHPNAME)
 
 getByPosition ($pos)
 
 toArray ($keyType=BasePeer::TYPE_PHPNAME, $includeLazyLoadColumns=true, $alreadyDumpedObjects=array(), $includeForeignObjects=false)
 
 setByName ($name, $value, $type=BasePeer::TYPE_PHPNAME)
 
 setByPosition ($pos, $value)
 
 fromArray ($arr, $keyType=BasePeer::TYPE_PHPNAME)
 
 buildCriteria ()
 
 buildPkeyCriteria ()
 
 getPrimaryKey ()
 
 setPrimaryKey ($key)
 
 isPrimaryKeyNull ()
 
 copyInto ($copyObj, $deepCopy=false, $makeNew=true)
 
 copy ($deepCopy=false)
 
 getPeer ()
 
 setLanguage (Language $v=null)
 
 getLanguage (PropelPDO $con=null, $doQuery=true)
 
 setUserRelatedByOwnerId (User $v=null)
 
 getUserRelatedByOwnerId (PropelPDO $con=null, $doQuery=true)
 
 setDocumentType (DocumentType $v=null)
 
 getDocumentType (PropelPDO $con=null, $doQuery=true)
 
 setDocumentCategory (DocumentCategory $v=null)
 
 getDocumentCategory (PropelPDO $con=null, $doQuery=true)
 
 setDocumentData (DocumentData $v=null)
 
 getDocumentData (PropelPDO $con=null, $doQuery=true)
 
 setUserRelatedByCreatedBy (User $v=null)
 
 getUserRelatedByCreatedBy (PropelPDO $con=null, $doQuery=true)
 
 setUserRelatedByUpdatedBy (User $v=null)
 
 getUserRelatedByUpdatedBy (PropelPDO $con=null, $doQuery=true)
 
 clear ()
 
 clearAllReferences ($deep=false)
 
 __toString ()
 
 isAlreadyInSave ()
 
 getReferees ()
 
 addTag ($mTag)
 
 removeTag ($mTag)
 
 removeAllTags ()
 
 tags ($sReturn= 'tag')
 
 getTags ()
 
 mayOperate ($sOperation, $oUser=false)
 
 mayBeInserted ($oUser=false)
 
 mayBeUpdated ($oUser=false)
 
 mayBeDeleted ($oUser=false)
 
 keepUpdateDateUnchanged ()
 
 getCreatedAtTimestamp ()
 
 getCreatedAtFormatted ($sLanguageId=null, $sFormatString= 'x')
 
 getUpdatedAtTimestamp ()
 
 getUpdatedAtFormatted ($sLanguageId=null, $sFormatString= 'x')
 
 keepUpdateUserUnchanged ()
 
 getPKArray ()
 
 getPKString ()
 

Static Public Member Functions

static addTagTo ($sDocumentId, $mTag)
 
static removeTagFrom ($sDocumentId, $mTag)
 
static removeAllTagsFrom ($sDocumentId)
 
static tagsFor ($sDocumentId=null, $sReturn= 'tag')
 

Public Attributes

const PEER = 'DocumentPeer'
 
const TAG_MODEL_NAME = 'Tag'
 
const TAG_INSTANCE_MODEL_NAME = 'TagInstance'
 

Protected Member Functions

 doSave (PropelPDO $con)
 
 doInsert (PropelPDO $con)
 
 doUpdate (PropelPDO $con)
 
 doValidate ($columns=null)
 

Protected Attributes

 $startCopy = false
 
 $id
 
 $name
 
 $original_name
 
 $description
 
 $content_created_at
 
 $license
 
 $author
 
 $language_id
 
 $owner_id
 
 $document_type_id
 
 $document_category_id
 
 $is_private
 
 $is_protected
 
 $sort
 
 $hash
 
 $created_at
 
 $updated_at
 
 $created_by
 
 $updated_by
 
 $aLanguage
 
 $aUserRelatedByOwnerId
 
 $aDocumentType
 
 $aDocumentCategory
 
 $aDocumentData
 
 $aUserRelatedByCreatedBy
 
 $aUserRelatedByUpdatedBy
 
 $alreadyInSave = false
 
 $alreadyInValidation = false
 
 $alreadyInClearAllReferencesDeep = false
 
 $validationFailures = array()
 

Static Protected Attributes

static $peer
 

Constructor & Destructor Documentation

BaseDocument::__construct ( )

Initializes internal state of BaseDocument object.

See also
applyDefaults()

Member Function Documentation

BaseDocument::__toString ( )

return the string representation of this object

Returns
string
BaseDocument::addTag (   $mTag)

Add a tag to the current Document

static BaseDocument::addTagTo (   $sDocumentId,
  $mTag 
)
static

Add a tag to the Document given by the id

BaseDocument::applyDefaultValues ( )

Applies default values to this object. This method should be called from the object's constructor (or equivalent initialization method).

See also
__construct()
BaseDocument::buildCriteria ( )

Build a Criteria object containing the values of all modified columns in this object.

Returns
Criteria The Criteria object containing all modified values.
BaseDocument::buildPkeyCriteria ( )

Builds a Criteria object containing the primary key for this object.

Unlike buildCriteria() this method includes the primary key values regardless of whether or not they have been modified.

Returns
Criteria The Criteria object containing value(s) for primary key(s).
BaseDocument::clear ( )

Clears the current object and sets all attributes to their default values

BaseDocument::clearAllReferences (   $deep = false)

Resets all references to other model objects or collections of model objects.

This method is a user-space workaround for PHP's inability to garbage collect objects with circular references (even in PHP 5.3). This is currently necessary when using Propel in certain daemon or large-volume/high-memory operations.

Parameters
boolean$deepWhether to also clear the references on all referrer objects.
BaseDocument::copy (   $deepCopy = false)

Makes a copy of this object that will be inserted as a new row in table when saved. It creates a new object filling in the simple attributes, but skipping any primary keys that are defined for the table.

If desired, this method can also make copies of all associated (fkey referrers) objects.

Parameters
boolean$deepCopyWhether to also copy all rows that refer (by fkey) to the current row.
Returns
Document Clone of current object.
Exceptions
PropelException
BaseDocument::copyInto (   $copyObj,
  $deepCopy = false,
  $makeNew = true 
)

Sets contents of passed object to values from current object.

If desired, this method can also make copies of all associated (fkey referrers) objects.

Parameters
object$copyObjAn object of Document (or compatible) type.
boolean$deepCopyWhether to also copy all rows that refer (by fkey) to the current row.
boolean$makeNewWhether to reset autoincrement PKs and make the object new.
Exceptions
PropelException
BaseDocument::delete ( PropelPDO  $con = null)

Removes this object from datastore and sets delete attribute.

Parameters
PropelPDO$con
Returns
void
Exceptions
PropelException
Exception
See also
BaseObject::setDeleted()
BaseObject::isDeleted()
BaseDocument::doInsert ( PropelPDO  $con)
protected

Insert the row in the database.

Parameters
PropelPDO$con
Exceptions
PropelException
See also
doSave()
BaseDocument::doSave ( PropelPDO  $con)
protected

Performs the work of inserting or updating the row in the database.

If the object is new, it inserts it; otherwise an update is performed. All related objects are also updated in this method.

Parameters
PropelPDO$con
Returns
int The number of rows affected by this insert/update and any referring fk objects' save() operations.
Exceptions
PropelException
See also
save()
BaseDocument::doUpdate ( PropelPDO  $con)
protected

Update the row in the database.

Parameters
PropelPDO$con
See also
doSave()
BaseDocument::doValidate (   $columns = null)
protected

This function performs the validation work for complex object models.

In addition to checking the current object, all related objects will also be validated. If all pass then true is returned; otherwise an aggregated array of ValidationFailed objects will be returned.

Parameters
array$columnsArray of column names to validate.
Returns
mixed true if all validations pass; array of ValidationFailed objects otherwise.
BaseDocument::ensureConsistency ( )

Checks and repairs the internal consistency of the object.

This method is executed after an already-instantiated object is re-hydrated from the database. It exists to check any foreign keys to make sure that the objects related to the current object are correct based on foreign key.

You can override this method in the stub class, but you should always invoke the base method from the overridden method (i.e. parent::ensureConsistency()), in case your model changes.

Exceptions
PropelException
BaseDocument::fromArray (   $arr,
  $keyType = BasePeer::TYPE_PHPNAME 
)

Populates the object using an array.

This is particularly useful when populating an object from one of the request arrays (e.g. $_POST). This method goes through the column names, checking to see whether a matching key exists in populated array. If so the setByName() method is called for that column.

You can specify the key type of the array by additionally passing one of the class type constants BasePeer::TYPE_PHPNAME, BasePeer::TYPE_STUDLYPHPNAME, BasePeer::TYPE_COLNAME, BasePeer::TYPE_FIELDNAME, BasePeer::TYPE_NUM. The default key type is the column's BasePeer::TYPE_PHPNAME

Parameters
array$arrAn array to populate the object from.
string$keyTypeThe type of keys the array uses.
Returns
void
BaseDocument::getAuthor ( )

Get the [author] column value.

Returns
string
BaseDocument::getByName (   $name,
  $type = BasePeer::TYPE_PHPNAME 
)

Retrieves a field from the object by name passed in as a string.

Parameters
string$namename
string$typeThe type of fieldname the $name is of: one of the class type constants BasePeer::TYPE_PHPNAME, BasePeer::TYPE_STUDLYPHPNAME BasePeer::TYPE_COLNAME, BasePeer::TYPE_FIELDNAME, BasePeer::TYPE_NUM. Defaults to BasePeer::TYPE_PHPNAME
Returns
mixed Value of field.
BaseDocument::getByPosition (   $pos)

Retrieves a field from the object by Position as specified in the xml schema. Zero-based.

Parameters
int$posposition in xml schema
Returns
mixed Value of field at $pos
BaseDocument::getContentCreatedAt (   $format = '%x')

Get the [optionally formatted] temporal [content_created_at] column value.

Parameters
string$formatThe date/time format string (either date()-style or strftime()-style). If format is null, then the raw DateTime object will be returned.
Returns
mixed Formatted date/time value as string or DateTime object (if format is null), null if column is null, and 0 if column value is 0000-00-00
Exceptions
PropelException- if unable to parse/validate the date/time value.
BaseDocument::getCreatedAt (   $format = 'Y-m-d H:i:s')

Get the [optionally formatted] temporal [created_at] column value.

Parameters
string$formatThe date/time format string (either date()-style or strftime()-style). If format is null, then the raw DateTime object will be returned.
Returns
mixed Formatted date/time value as string or DateTime object (if format is null), null if column is null, and 0 if column value is 0000-00-00 00:00:00
Exceptions
PropelException- if unable to parse/validate the date/time value.
BaseDocument::getCreatedAtFormatted (   $sLanguageId = null,
  $sFormatString = 'x' 
)
Returns
created_at formatted to the current locale
BaseDocument::getCreatedAtTimestamp ( )
Returns
created_at as int (timestamp)
BaseDocument::getCreatedBy ( )

Get the [created_by] column value.

Returns
int
BaseDocument::getDescription ( )

Get the [description] column value.

Returns
string
BaseDocument::getDocumentCategory ( PropelPDO  $con = null,
  $doQuery = true 
)

Get the associated DocumentCategory object

Parameters
PropelPDO$conOptional Connection object.
$doQueryExecutes a query to get the object if required
Returns
DocumentCategory The associated DocumentCategory object.
Exceptions
PropelException
BaseDocument::getDocumentCategoryId ( )

Get the [document_category_id] column value.

Returns
int
BaseDocument::getDocumentData ( PropelPDO  $con = null,
  $doQuery = true 
)

Get the associated DocumentData object

Parameters
PropelPDO$conOptional Connection object.
$doQueryExecutes a query to get the object if required
Returns
DocumentData The associated DocumentData object.
Exceptions
PropelException
BaseDocument::getDocumentType ( PropelPDO  $con = null,
  $doQuery = true 
)

Get the associated DocumentType object

Parameters
PropelPDO$conOptional Connection object.
$doQueryExecutes a query to get the object if required
Returns
DocumentType The associated DocumentType object.
Exceptions
PropelException
BaseDocument::getDocumentTypeId ( )

Get the [document_type_id] column value.

Returns
int
BaseDocument::getHash ( )

Get the [hash] column value.

Returns
string
BaseDocument::getId ( )

Get the [id] column value.

Returns
int
BaseDocument::getIsPrivate ( )

Get the [is_private] column value.

Returns
boolean
BaseDocument::getIsProtected ( )

Get the [is_protected] column value.

Returns
boolean
BaseDocument::getLanguage ( PropelPDO  $con = null,
  $doQuery = true 
)

Get the associated Language object

Parameters
PropelPDO$conOptional Connection object.
$doQueryExecutes a query to get the object if required
Returns
Language The associated Language object.
Exceptions
PropelException
BaseDocument::getLanguageId ( )

Get the [language_id] column value.

Returns
string
BaseDocument::getLicense ( )

Get the [license] column value.

Returns
string
BaseDocument::getName ( )

Get the [name] column value.

Returns
string
BaseDocument::getOriginalName ( )

Get the [original_name] column value.

Returns
string
BaseDocument::getOwnerId ( )

Get the [owner_id] column value.

Returns
int
BaseDocument::getPeer ( )

Returns a peer instance associated with this om.

Since Peer classes are not to have any instance attributes, this method returns the same instance for all member of this class. The method could therefore be static, but this would prevent one from overriding the behavior.

Returns
DocumentPeer
BaseDocument::getPKArray ( )
Returns
the primary key as an array (even for non-composite keys)
BaseDocument::getPKString ( )
Returns
the composite primary key as a string, separated by _
BaseDocument::getPrimaryKey ( )

Returns the primary key for this object (row).

Returns
int
BaseDocument::getReferees ( )
Returns
A list of References (not Objects) which reference this Document
BaseDocument::getSort ( )

Get the [sort] column value.

Returns
int
BaseDocument::getTags ( )
Returns
A list of TagInstances (not Tags) which reference this Document
Deprecated:
Use ->tags('instances')
BaseDocument::getUpdatedAt (   $format = 'Y-m-d H:i:s')

Get the [optionally formatted] temporal [updated_at] column value.

Parameters
string$formatThe date/time format string (either date()-style or strftime()-style). If format is null, then the raw DateTime object will be returned.
Returns
mixed Formatted date/time value as string or DateTime object (if format is null), null if column is null, and 0 if column value is 0000-00-00 00:00:00
Exceptions
PropelException- if unable to parse/validate the date/time value.
BaseDocument::getUpdatedAtFormatted (   $sLanguageId = null,
  $sFormatString = 'x' 
)
Returns
updated_at formatted to the current locale
BaseDocument::getUpdatedAtTimestamp ( )
Returns
updated_at as int (timestamp)
BaseDocument::getUpdatedBy ( )

Get the [updated_by] column value.

Returns
int
BaseDocument::getUserRelatedByCreatedBy ( PropelPDO  $con = null,
  $doQuery = true 
)

Get the associated User object

Parameters
PropelPDO$conOptional Connection object.
$doQueryExecutes a query to get the object if required
Returns
User The associated User object.
Exceptions
PropelException
BaseDocument::getUserRelatedByOwnerId ( PropelPDO  $con = null,
  $doQuery = true 
)

Get the associated User object

Parameters
PropelPDO$conOptional Connection object.
$doQueryExecutes a query to get the object if required
Returns
User The associated User object.
Exceptions
PropelException
BaseDocument::getUserRelatedByUpdatedBy ( PropelPDO  $con = null,
  $doQuery = true 
)

Get the associated User object

Parameters
PropelPDO$conOptional Connection object.
$doQueryExecutes a query to get the object if required
Returns
User The associated User object.
Exceptions
PropelException
BaseDocument::getValidationFailures ( )

Gets any ValidationFailed objects that resulted from last call to validate().

Returns
array ValidationFailed[]
See also
validate()
BaseDocument::hasOnlyDefaultValues ( )

Indicates whether the columns in this object are only set to default values.

This method can be used in conjunction with isModified() to indicate whether an object is both modified and has some values set which are non-default.

Returns
boolean Whether the columns in this object are only been set with default values.
BaseDocument::hydrate (   $row,
  $startcol = 0,
  $rehydrate = false 
)

Hydrates (populates) the object variables with values from the database resultset.

An offset (0-based "start column") is specified so that objects can be hydrated with a subset of the columns in the resultset rows. This is needed, for example, for results of JOIN queries where the resultset row includes columns from two or more tables.

Parameters
array$rowThe row returned by PDOStatement->fetch(PDO::FETCH_NUM)
int$startcol0-based offset column which indicates which resultset column to start with.
boolean$rehydrateWhether this object is being re-hydrated from the database.
Returns
int next starting column
Exceptions
PropelException- Any caught Exception will be rewrapped as a PropelException.
BaseDocument::isAlreadyInSave ( )

return true is the object is in saving state

Returns
boolean
BaseDocument::isPrimaryKeyNull ( )

Returns true if the primary key for this object is null.

Returns
boolean
BaseDocument::keepUpdateDateUnchanged ( )

Mark the current object so that the update date doesn't get updated during next save

Returns
Document The current object (for fluent API support)
BaseDocument::keepUpdateUserUnchanged ( )

Mark the current object so that the updated user doesn't get updated during next save

Returns
Document The current object (for fluent API support)
BaseDocument::reload (   $deep = false,
PropelPDO  $con = null 
)

Reloads this object from datastore based on primary key and (optionally) resets all associated objects.

This will only work if the object has been saved and has a valid primary key set.

Parameters
boolean$deep(optional) Whether to also de-associated any related objects.
PropelPDO$con(optional) The PropelPDO connection to use.
Returns
void
Exceptions
PropelException- if this object is deleted, unsaved or doesn't have pk match in db
BaseDocument::removeAllTags ( )

Remove all tags from the current Document

static BaseDocument::removeAllTagsFrom (   $sDocumentId)
static

Remove all tags from the Document given by the id

BaseDocument::removeTag (   $mTag)

Remove tag from the current Document

static BaseDocument::removeTagFrom (   $sDocumentId,
  $mTag 
)
static

Remove tag from the Document given by the id

BaseDocument::save ( PropelPDO  $con = null)

Persists this object to the database.

If the object is new, it inserts it; otherwise an update is performed. All modified related objects will also be persisted in the doSave() method. This method wraps all precipitate database operations in a single transaction.

Parameters
PropelPDO$con
Returns
int The number of rows affected by this insert/update and any referring fk objects' save() operations.
Exceptions
PropelException
Exception
See also
doSave()
BaseDocument::setAuthor (   $v)

Set the value of [author] column.

Parameters
string$vnew value
Returns
Document The current object (for fluent API support)
BaseDocument::setByName (   $name,
  $value,
  $type = BasePeer::TYPE_PHPNAME 
)

Sets a field from the object by name passed in as a string.

Parameters
string$namepeer name
mixed$valuefield value
string$typeThe type of fieldname the $name is of: one of the class type constants BasePeer::TYPE_PHPNAME, BasePeer::TYPE_STUDLYPHPNAME BasePeer::TYPE_COLNAME, BasePeer::TYPE_FIELDNAME, BasePeer::TYPE_NUM. Defaults to BasePeer::TYPE_PHPNAME
Returns
void
BaseDocument::setByPosition (   $pos,
  $value 
)

Sets a field from the object by Position as specified in the xml schema. Zero-based.

Parameters
int$posposition in xml schema
mixed$valuefield value
Returns
void
BaseDocument::setContentCreatedAt (   $v)

Sets the value of [content_created_at] column to a normalized version of the date/time value specified.

Parameters
mixed$vstring, integer (timestamp), or DateTime value. Empty strings are treated as null.
Returns
Document The current object (for fluent API support)
BaseDocument::setCreatedAt (   $v)

Sets the value of [created_at] column to a normalized version of the date/time value specified.

Parameters
mixed$vstring, integer (timestamp), or DateTime value. Empty strings are treated as null.
Returns
Document The current object (for fluent API support)
BaseDocument::setCreatedBy (   $v)

Set the value of [created_by] column.

Parameters
int$vnew value
Returns
Document The current object (for fluent API support)
BaseDocument::setDescription (   $v)

Set the value of [description] column.

Parameters
string$vnew value
Returns
Document The current object (for fluent API support)
BaseDocument::setDocumentCategory ( DocumentCategory  $v = null)

Declares an association between this object and a DocumentCategory object.

Parameters
DocumentCategory$v
Returns
Document The current object (for fluent API support)
Exceptions
PropelException
BaseDocument::setDocumentCategoryId (   $v)

Set the value of [document_category_id] column.

Parameters
int$vnew value
Returns
Document The current object (for fluent API support)
BaseDocument::setDocumentData ( DocumentData  $v = null)

Declares an association between this object and a DocumentData object.

Parameters
DocumentData$v
Returns
Document The current object (for fluent API support)
Exceptions
PropelException
BaseDocument::setDocumentType ( DocumentType  $v = null)

Declares an association between this object and a DocumentType object.

Parameters
DocumentType$v
Returns
Document The current object (for fluent API support)
Exceptions
PropelException
BaseDocument::setDocumentTypeId (   $v)

Set the value of [document_type_id] column.

Parameters
int$vnew value
Returns
Document The current object (for fluent API support)
BaseDocument::setHash (   $v)

Set the value of [hash] column.

Parameters
string$vnew value
Returns
Document The current object (for fluent API support)
BaseDocument::setId (   $v)

Set the value of [id] column.

Parameters
int$vnew value
Returns
Document The current object (for fluent API support)
BaseDocument::setIsPrivate (   $v)

Sets the value of the [is_private] column. Non-boolean arguments are converted using the following rules:

  • 1, '1', 'true', 'on', and 'yes' are converted to boolean true
  • 0, '0', 'false', 'off', and 'no' are converted to boolean false Check on string values is case insensitive (so 'FaLsE' is seen as 'false').
Parameters
boolean | integer | string$vThe new value
Returns
Document The current object (for fluent API support)
BaseDocument::setIsProtected (   $v)

Sets the value of the [is_protected] column. Non-boolean arguments are converted using the following rules:

  • 1, '1', 'true', 'on', and 'yes' are converted to boolean true
  • 0, '0', 'false', 'off', and 'no' are converted to boolean false Check on string values is case insensitive (so 'FaLsE' is seen as 'false').
Parameters
boolean | integer | string$vThe new value
Returns
Document The current object (for fluent API support)
BaseDocument::setLanguage ( Language  $v = null)

Declares an association between this object and a Language object.

Parameters
Language$v
Returns
Document The current object (for fluent API support)
Exceptions
PropelException
BaseDocument::setLanguageId (   $v)

Set the value of [language_id] column.

Parameters
string$vnew value
Returns
Document The current object (for fluent API support)
BaseDocument::setLicense (   $v)

Set the value of [license] column.

Parameters
string$vnew value
Returns
Document The current object (for fluent API support)
BaseDocument::setName (   $v)

Set the value of [name] column.

Parameters
string$vnew value
Returns
Document The current object (for fluent API support)
BaseDocument::setOriginalName (   $v)

Set the value of [original_name] column.

Parameters
string$vnew value
Returns
Document The current object (for fluent API support)
BaseDocument::setOwnerId (   $v)

Set the value of [owner_id] column.

Parameters
int$vnew value
Returns
Document The current object (for fluent API support)
BaseDocument::setPrimaryKey (   $key)

Generic method to set the primary key (id column).

Parameters
int$keyPrimary key.
Returns
void
BaseDocument::setSort (   $v)

Set the value of [sort] column.

Parameters
int$vnew value
Returns
Document The current object (for fluent API support)
BaseDocument::setUpdatedAt (   $v)

Sets the value of [updated_at] column to a normalized version of the date/time value specified.

Parameters
mixed$vstring, integer (timestamp), or DateTime value. Empty strings are treated as null.
Returns
Document The current object (for fluent API support)
BaseDocument::setUpdatedBy (   $v)

Set the value of [updated_by] column.

Parameters
int$vnew value
Returns
Document The current object (for fluent API support)
BaseDocument::setUserRelatedByCreatedBy ( User  $v = null)

Declares an association between this object and a User object.

Parameters
User$v
Returns
Document The current object (for fluent API support)
Exceptions
PropelException
BaseDocument::setUserRelatedByOwnerId ( User  $v = null)

Declares an association between this object and a User object.

Parameters
User$v
Returns
Document The current object (for fluent API support)
Exceptions
PropelException
BaseDocument::setUserRelatedByUpdatedBy ( User  $v = null)

Declares an association between this object and a User object.

Parameters
User$v
Returns
Document The current object (for fluent API support)
Exceptions
PropelException
BaseDocument::tags (   $sReturn = 'tag')
Returns
All tags for the current Document
static BaseDocument::tagsFor (   $sDocumentId = null,
  $sReturn = 'tag' 
)
static
Returns
All tags for the Document given by the id
BaseDocument::toArray (   $keyType = BasePeer::TYPE_PHPNAME,
  $includeLazyLoadColumns = true,
  $alreadyDumpedObjects = array(),
  $includeForeignObjects = false 
)

Exports the object as an array.

You can specify the key type of the array by passing one of the class type constants.

Parameters
string$keyType(optional) One of the class type constants BasePeer::TYPE_PHPNAME, BasePeer::TYPE_STUDLYPHPNAME, BasePeer::TYPE_COLNAME, BasePeer::TYPE_FIELDNAME, BasePeer::TYPE_NUM. Defaults to BasePeer::TYPE_PHPNAME.
boolean$includeLazyLoadColumns(optional) Whether to include lazy loaded columns. Defaults to true.
array$alreadyDumpedObjectsList of objects to skip to avoid recursion
boolean$includeForeignObjects(optional) Whether to include hydrated related objects. Default to FALSE.
Returns
array an associative array containing the field names (as keys) and field values
BaseDocument::validate (   $columns = null)

Validates the objects modified field values and all objects related to this table.

If $columns is either a column name or an array of column names only those columns are validated.

Parameters
mixed$columnsColumn name or an array of column names.
Returns
boolean Whether all columns pass validation.
See also
doValidate()
getValidationFailures()

Member Data Documentation

const BaseDocument::PEER = 'DocumentPeer'

Peer class name


The documentation for this class was generated from the following file: