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

Public Member Functions

 applyDefaultValues ()
 
 __construct ()
 
 getId ()
 
 getName ()
 
 getSort ()
 
 getMaxWidth ()
 
 getIsExternallyManaged ()
 
 getCreatedAt ($format= 'Y-m-d H:i:s')
 
 getUpdatedAt ($format= 'Y-m-d H:i:s')
 
 getCreatedBy ()
 
 getUpdatedBy ()
 
 setId ($v)
 
 setName ($v)
 
 setSort ($v)
 
 setMaxWidth ($v)
 
 setIsExternallyManaged ($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 ()
 
 setUserRelatedByCreatedBy (User $v=null)
 
 getUserRelatedByCreatedBy (PropelPDO $con=null, $doQuery=true)
 
 setUserRelatedByUpdatedBy (User $v=null)
 
 getUserRelatedByUpdatedBy (PropelPDO $con=null, $doQuery=true)
 
 initRelation ($relationName)
 
 clearDocuments ()
 
 resetPartialDocuments ($v=true)
 
 initDocuments ($overrideExisting=true)
 
 getDocuments ($criteria=null, PropelPDO $con=null)
 
 setDocuments (PropelCollection $documents, PropelPDO $con=null)
 
 countDocuments (Criteria $criteria=null, $distinct=false, PropelPDO $con=null)
 
 addDocument (Document $l)
 
 removeDocument ($document)
 
 getDocumentsJoinLanguage ($criteria=null, $con=null, $join_behavior=Criteria::LEFT_JOIN)
 
 getDocumentsJoinUserRelatedByOwnerId ($criteria=null, $con=null, $join_behavior=Criteria::LEFT_JOIN)
 
 getDocumentsJoinDocumentType ($criteria=null, $con=null, $join_behavior=Criteria::LEFT_JOIN)
 
 getDocumentsJoinDocumentData ($criteria=null, $con=null, $join_behavior=Criteria::LEFT_JOIN)
 
 getDocumentsJoinUserRelatedByCreatedBy ($criteria=null, $con=null, $join_behavior=Criteria::LEFT_JOIN)
 
 getDocumentsJoinUserRelatedByUpdatedBy ($criteria=null, $con=null, $join_behavior=Criteria::LEFT_JOIN)
 
 clear ()
 
 clearAllReferences ($deep=false)
 
 __toString ()
 
 isAlreadyInSave ()
 
 getReferees ()
 
 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 ()
 

Public Attributes

const PEER = 'DocumentCategoryPeer'
 

Protected Member Functions

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

Protected Attributes

 $startCopy = false
 
 $id
 
 $name
 
 $sort
 
 $max_width
 
 $is_externally_managed
 
 $created_at
 
 $updated_at
 
 $created_by
 
 $updated_by
 
 $aUserRelatedByCreatedBy
 
 $aUserRelatedByUpdatedBy
 
 $collDocuments
 
 $collDocumentsPartial
 
 $alreadyInSave = false
 
 $alreadyInValidation = false
 
 $alreadyInClearAllReferencesDeep = false
 
 $documentsScheduledForDeletion = null
 
 $validationFailures = array()
 

Static Protected Attributes

static $peer
 

Constructor & Destructor Documentation

BaseDocumentCategory::__construct ( )

Initializes internal state of BaseDocumentCategory object.

See also
applyDefaults()

Member Function Documentation

BaseDocumentCategory::__toString ( )

return the string representation of this object

Returns
string
BaseDocumentCategory::addDocument ( Document  $l)

Method called to associate a Document object to this object through the Document foreign key attribute.

Parameters
Document$lDocument
Returns
DocumentCategory The current object (for fluent API support)
BaseDocumentCategory::applyDefaultValues ( )

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

See also
__construct()
BaseDocumentCategory::buildCriteria ( )

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

Returns
Criteria The Criteria object containing all modified values.
BaseDocumentCategory::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).
BaseDocumentCategory::clear ( )

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

BaseDocumentCategory::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.
BaseDocumentCategory::clearDocuments ( )

Clears out the collDocuments collection

This does not modify the database; however, it will remove any associated objects, causing them to be refetched by subsequent calls to accessor method.

Returns
DocumentCategory The current object (for fluent API support)
See also
addDocuments()
BaseDocumentCategory::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
DocumentCategory Clone of current object.
Exceptions
PropelException
BaseDocumentCategory::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 DocumentCategory (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
BaseDocumentCategory::countDocuments ( Criteria  $criteria = null,
  $distinct = false,
PropelPDO  $con = null 
)

Returns the number of related Document objects.

Parameters
Criteria$criteria
boolean$distinct
PropelPDO$con
Returns
int Count of related Document objects.
Exceptions
PropelException
BaseDocumentCategory::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()
BaseDocumentCategory::doAddDocument (   $document)
protected
Parameters
Document$documentThe document object to add.
BaseDocumentCategory::doInsert ( PropelPDO  $con)
protected

Insert the row in the database.

Parameters
PropelPDO$con
Exceptions
PropelException
See also
doSave()
BaseDocumentCategory::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()
BaseDocumentCategory::doUpdate ( PropelPDO  $con)
protected

Update the row in the database.

Parameters
PropelPDO$con
See also
doSave()
BaseDocumentCategory::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.
BaseDocumentCategory::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
BaseDocumentCategory::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
BaseDocumentCategory::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.
BaseDocumentCategory::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
BaseDocumentCategory::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.
BaseDocumentCategory::getCreatedAtFormatted (   $sLanguageId = null,
  $sFormatString = 'x' 
)
Returns
created_at formatted to the current locale
BaseDocumentCategory::getCreatedAtTimestamp ( )
Returns
created_at as int (timestamp)
BaseDocumentCategory::getCreatedBy ( )

Get the [created_by] column value.

Returns
int
BaseDocumentCategory::getDocuments (   $criteria = null,
PropelPDO  $con = null 
)

Gets an array of Document objects which contain a foreign key that references this object.

If the $criteria is not null, it is used to always fetch the results from the database. Otherwise the results are fetched from the database the first time, then cached. Next time the same method is called without $criteria, the cached collection is returned. If this DocumentCategory is new, it will return an empty collection or the current collection; the criteria is ignored on a new object.

Parameters
Criteria$criteriaoptional Criteria object to narrow the query
PropelPDO$conoptional connection object
Returns
PropelObjectCollection|Document[] List of Document objects
Exceptions
PropelException
BaseDocumentCategory::getDocumentsJoinDocumentData (   $criteria = null,
  $con = null,
  $join_behavior = Criteria::LEFT_JOIN 
)

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this DocumentCategory is new, it will return an empty collection; or if this DocumentCategory has previously been saved, it will retrieve related Documents from storage.

This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in DocumentCategory.

Parameters
Criteria$criteriaoptional Criteria object to narrow the query
PropelPDO$conoptional connection object
string$join_behavioroptional join type to use (defaults to Criteria::LEFT_JOIN)
Returns
PropelObjectCollection|Document[] List of Document objects
BaseDocumentCategory::getDocumentsJoinDocumentType (   $criteria = null,
  $con = null,
  $join_behavior = Criteria::LEFT_JOIN 
)

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this DocumentCategory is new, it will return an empty collection; or if this DocumentCategory has previously been saved, it will retrieve related Documents from storage.

This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in DocumentCategory.

Parameters
Criteria$criteriaoptional Criteria object to narrow the query
PropelPDO$conoptional connection object
string$join_behavioroptional join type to use (defaults to Criteria::LEFT_JOIN)
Returns
PropelObjectCollection|Document[] List of Document objects
BaseDocumentCategory::getDocumentsJoinLanguage (   $criteria = null,
  $con = null,
  $join_behavior = Criteria::LEFT_JOIN 
)

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this DocumentCategory is new, it will return an empty collection; or if this DocumentCategory has previously been saved, it will retrieve related Documents from storage.

This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in DocumentCategory.

Parameters
Criteria$criteriaoptional Criteria object to narrow the query
PropelPDO$conoptional connection object
string$join_behavioroptional join type to use (defaults to Criteria::LEFT_JOIN)
Returns
PropelObjectCollection|Document[] List of Document objects
BaseDocumentCategory::getDocumentsJoinUserRelatedByCreatedBy (   $criteria = null,
  $con = null,
  $join_behavior = Criteria::LEFT_JOIN 
)

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this DocumentCategory is new, it will return an empty collection; or if this DocumentCategory has previously been saved, it will retrieve related Documents from storage.

This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in DocumentCategory.

Parameters
Criteria$criteriaoptional Criteria object to narrow the query
PropelPDO$conoptional connection object
string$join_behavioroptional join type to use (defaults to Criteria::LEFT_JOIN)
Returns
PropelObjectCollection|Document[] List of Document objects
BaseDocumentCategory::getDocumentsJoinUserRelatedByOwnerId (   $criteria = null,
  $con = null,
  $join_behavior = Criteria::LEFT_JOIN 
)

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this DocumentCategory is new, it will return an empty collection; or if this DocumentCategory has previously been saved, it will retrieve related Documents from storage.

This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in DocumentCategory.

Parameters
Criteria$criteriaoptional Criteria object to narrow the query
PropelPDO$conoptional connection object
string$join_behavioroptional join type to use (defaults to Criteria::LEFT_JOIN)
Returns
PropelObjectCollection|Document[] List of Document objects
BaseDocumentCategory::getDocumentsJoinUserRelatedByUpdatedBy (   $criteria = null,
  $con = null,
  $join_behavior = Criteria::LEFT_JOIN 
)

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this DocumentCategory is new, it will return an empty collection; or if this DocumentCategory has previously been saved, it will retrieve related Documents from storage.

This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in DocumentCategory.

Parameters
Criteria$criteriaoptional Criteria object to narrow the query
PropelPDO$conoptional connection object
string$join_behavioroptional join type to use (defaults to Criteria::LEFT_JOIN)
Returns
PropelObjectCollection|Document[] List of Document objects
BaseDocumentCategory::getId ( )

Get the [id] column value.

Returns
int
BaseDocumentCategory::getIsExternallyManaged ( )

Get the [is_externally_managed] column value.

Returns
boolean
BaseDocumentCategory::getMaxWidth ( )

Get the [max_width] column value.

Returns
int
BaseDocumentCategory::getName ( )

Get the [name] column value.

Returns
string
BaseDocumentCategory::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
DocumentCategoryPeer
BaseDocumentCategory::getPKArray ( )
Returns
the primary key as an array (even for non-composite keys)
BaseDocumentCategory::getPKString ( )
Returns
the composite primary key as a string, separated by _
BaseDocumentCategory::getPrimaryKey ( )

Returns the primary key for this object (row).

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

Get the [sort] column value.

Returns
int
BaseDocumentCategory::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.
BaseDocumentCategory::getUpdatedAtFormatted (   $sLanguageId = null,
  $sFormatString = 'x' 
)
Returns
updated_at formatted to the current locale
BaseDocumentCategory::getUpdatedAtTimestamp ( )
Returns
updated_at as int (timestamp)
BaseDocumentCategory::getUpdatedBy ( )

Get the [updated_by] column value.

Returns
int
BaseDocumentCategory::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
BaseDocumentCategory::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
BaseDocumentCategory::getValidationFailures ( )

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

Returns
array ValidationFailed[]
See also
validate()
BaseDocumentCategory::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.
BaseDocumentCategory::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.
BaseDocumentCategory::initDocuments (   $overrideExisting = true)

Initializes the collDocuments collection.

By default this just sets the collDocuments collection to an empty array (like clearcollDocuments()); however, you may wish to override this method in your stub class to provide setting appropriate to your application – for example, setting the initial array to the values stored in database.

Parameters
boolean$overrideExistingIf set to true, the method call initializes the collection even if it is not empty
Returns
void
BaseDocumentCategory::initRelation (   $relationName)

Initializes a collection based on the name of a relation. Avoids crafting an 'init[$relationName]s' method name that wouldn't work when StandardEnglishPluralizer is used.

Parameters
string$relationNameThe name of the relation to initialize
Returns
void
BaseDocumentCategory::isAlreadyInSave ( )

return true is the object is in saving state

Returns
boolean
BaseDocumentCategory::isPrimaryKeyNull ( )

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

Returns
boolean
BaseDocumentCategory::keepUpdateDateUnchanged ( )

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

Returns
DocumentCategory The current object (for fluent API support)
BaseDocumentCategory::keepUpdateUserUnchanged ( )

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

Returns
DocumentCategory The current object (for fluent API support)
BaseDocumentCategory::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
BaseDocumentCategory::removeDocument (   $document)
Parameters
Document$documentThe document object to remove.
Returns
DocumentCategory The current object (for fluent API support)
BaseDocumentCategory::resetPartialDocuments (   $v = true)

reset is the collDocuments collection loaded partially

Returns
void
BaseDocumentCategory::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()
BaseDocumentCategory::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
BaseDocumentCategory::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
BaseDocumentCategory::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
DocumentCategory The current object (for fluent API support)
BaseDocumentCategory::setCreatedBy (   $v)

Set the value of [created_by] column.

Parameters
int$vnew value
Returns
DocumentCategory The current object (for fluent API support)
BaseDocumentCategory::setDocuments ( PropelCollection  $documents,
PropelPDO  $con = null 
)

Sets a collection of Document objects related by a one-to-many relationship to the current object. It will also schedule objects for deletion based on a diff between old objects (aka persisted) and new objects from the given Propel collection.

Parameters
PropelCollection$documentsA Propel collection.
PropelPDO$conOptional connection object
Returns
DocumentCategory The current object (for fluent API support)
BaseDocumentCategory::setId (   $v)

Set the value of [id] column.

Parameters
int$vnew value
Returns
DocumentCategory The current object (for fluent API support)
BaseDocumentCategory::setIsExternallyManaged (   $v)

Sets the value of the [is_externally_managed] 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
DocumentCategory The current object (for fluent API support)
BaseDocumentCategory::setMaxWidth (   $v)

Set the value of [max_width] column.

Parameters
int$vnew value
Returns
DocumentCategory The current object (for fluent API support)
BaseDocumentCategory::setName (   $v)

Set the value of [name] column.

Parameters
string$vnew value
Returns
DocumentCategory The current object (for fluent API support)
BaseDocumentCategory::setPrimaryKey (   $key)

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

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

Set the value of [sort] column.

Parameters
int$vnew value
Returns
DocumentCategory The current object (for fluent API support)
BaseDocumentCategory::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
DocumentCategory The current object (for fluent API support)
BaseDocumentCategory::setUpdatedBy (   $v)

Set the value of [updated_by] column.

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

Declares an association between this object and a User object.

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

Declares an association between this object and a User object.

Parameters
User$v
Returns
DocumentCategory The current object (for fluent API support)
Exceptions
PropelException
BaseDocumentCategory::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
BaseDocumentCategory::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 BaseDocumentCategory::PEER = 'DocumentCategoryPeer'

Peer class name


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