|
| __construct ($dbName=null, $modelName=null, $modelAlias=null) |
|
| findPk ($key, $con=null) |
|
| findOneByHash ($key, $con=null) |
|
| findPks ($keys, $con=null) |
|
| filterByPrimaryKey ($key) |
|
| filterByPrimaryKeys ($keys) |
|
| filterByHash ($hash=null, $comparison=null) |
|
| filterByData ($data=null, $comparison=null) |
|
| filterByDataSize ($dataSize=null, $comparison=null) |
|
| filterByCreatedAt ($createdAt=null, $comparison=null) |
|
| filterByUpdatedAt ($updatedAt=null, $comparison=null) |
|
| filterByCreatedBy ($createdBy=null, $comparison=null) |
|
| filterByUpdatedBy ($updatedBy=null, $comparison=null) |
|
| filterByUserRelatedByCreatedBy ($user, $comparison=null) |
|
| joinUserRelatedByCreatedBy ($relationAlias=null, $joinType=Criteria::LEFT_JOIN) |
|
| useUserRelatedByCreatedByQuery ($relationAlias=null, $joinType=Criteria::LEFT_JOIN) |
|
| filterByUserRelatedByUpdatedBy ($user, $comparison=null) |
|
| joinUserRelatedByUpdatedBy ($relationAlias=null, $joinType=Criteria::LEFT_JOIN) |
|
| useUserRelatedByUpdatedByQuery ($relationAlias=null, $joinType=Criteria::LEFT_JOIN) |
|
| filterByDocument ($document, $comparison=null) |
|
| joinDocument ($relationAlias=null, $joinType=Criteria::INNER_JOIN) |
|
| useDocumentQuery ($relationAlias=null, $joinType=Criteria::INNER_JOIN) |
|
| prune ($documentData=null) |
|
| recentlyUpdated ($nbDays=7) |
|
| lastUpdatedFirst () |
|
| firstUpdatedFirst () |
|
| recentlyCreated ($nbDays=7) |
|
| lastCreatedFirst () |
|
| firstCreatedFirst () |
|
| findMostRecentUpdate ($bAsTimestamp=false) |
|
| filterByPKArray ($pkArray) |
|
| filterByPKString ($pkString) |
|
|
static | create ($modelAlias=null, $criteria=null) |
|
BaseDocumentDataQuery::__construct |
( |
|
$dbName = null , |
|
|
|
$modelName = null , |
|
|
|
$modelAlias = null |
|
) |
| |
Initializes internal state of BaseDocumentDataQuery object.
- Parameters
-
string | $dbName | The dabase name |
string | $modelName | The phpName of a model, e.g. 'Book' |
string | $modelAlias | The alias for the model in this query, e.g. 'b' |
static BaseDocumentDataQuery::create |
( |
|
$modelAlias = null , |
|
|
|
$criteria = null |
|
) |
| |
|
static |
BaseDocumentDataQuery::filterByCreatedAt |
( |
|
$createdAt = null , |
|
|
|
$comparison = null |
|
) |
| |
Filter the query on the created_at column
Example usage: $query->filterByCreatedAt('2011-03-14'); // WHERE created_at = '2011-03-14' $query->filterByCreatedAt('now'); // WHERE created_at = '2011-03-14' $query->filterByCreatedAt(array('max' => 'yesterday')); // WHERE created_at < '2011-03-13'
- Parameters
-
mixed | $createdAt | The value to use as filter. Values can be integers (unix timestamps), DateTime objects, or strings. Empty strings are treated as NULL. Use scalar values for equality. Use array values for in_array() equivalent. Use associative array('min' => $minValue, 'max' => $maxValue) for intervals. |
string | $comparison | Operator to use for the column comparison, defaults to Criteria::EQUAL |
- Returns
- DocumentDataQuery The current query, for fluid interface
BaseDocumentDataQuery::filterByCreatedBy |
( |
|
$createdBy = null , |
|
|
|
$comparison = null |
|
) |
| |
Filter the query on the created_by column
Example usage: $query->filterByCreatedBy(1234); // WHERE created_by = 1234 $query->filterByCreatedBy(array(12, 34)); // WHERE created_by IN (12, 34) $query->filterByCreatedBy(array('min' => 12)); // WHERE created_by >= 12 $query->filterByCreatedBy(array('max' => 12)); // WHERE created_by <= 12
- See also
- filterByUserRelatedByCreatedBy()
- Parameters
-
mixed | $createdBy | The value to use as filter. Use scalar values for equality. Use array values for in_array() equivalent. Use associative array('min' => $minValue, 'max' => $maxValue) for intervals. |
string | $comparison | Operator to use for the column comparison, defaults to Criteria::EQUAL |
- Returns
- DocumentDataQuery The current query, for fluid interface
BaseDocumentDataQuery::filterByData |
( |
|
$data = null , |
|
|
|
$comparison = null |
|
) |
| |
Filter the query on the data column
- Parameters
-
mixed | $data | The value to use as filter |
string | $comparison | Operator to use for the column comparison, defaults to Criteria::EQUAL |
- Returns
- DocumentDataQuery The current query, for fluid interface
BaseDocumentDataQuery::filterByDataSize |
( |
|
$dataSize = null , |
|
|
|
$comparison = null |
|
) |
| |
Filter the query on the data_size column
Example usage: $query->filterByDataSize(1234); // WHERE data_size = 1234 $query->filterByDataSize(array(12, 34)); // WHERE data_size IN (12, 34) $query->filterByDataSize(array('min' => 12)); // WHERE data_size >= 12 $query->filterByDataSize(array('max' => 12)); // WHERE data_size <= 12
- Parameters
-
mixed | $dataSize | The value to use as filter. Use scalar values for equality. Use array values for in_array() equivalent. Use associative array('min' => $minValue, 'max' => $maxValue) for intervals. |
string | $comparison | Operator to use for the column comparison, defaults to Criteria::EQUAL |
- Returns
- DocumentDataQuery The current query, for fluid interface
BaseDocumentDataQuery::filterByDocument |
( |
|
$document, |
|
|
|
$comparison = null |
|
) |
| |
Filter the query by a related Document object
- Parameters
-
Document | PropelObjectCollection | $document | the related object to use as filter |
string | $comparison | Operator to use for the column comparison, defaults to Criteria::EQUAL |
- Returns
- DocumentDataQuery The current query, for fluid interface
- Exceptions
-
PropelException | - if the provided filter is invalid. |
BaseDocumentDataQuery::filterByHash |
( |
|
$hash = null , |
|
|
|
$comparison = null |
|
) |
| |
Filter the query on the hash column
Example usage: $query->filterByHash('fooValue'); // WHERE hash = 'fooValue' $query->filterByHash('fooValue'); // WHERE hash LIKE 'fooValue'
- Parameters
-
string | $hash | The value to use as filter. Accepts wildcards (* and % trigger a LIKE) |
string | $comparison | Operator to use for the column comparison, defaults to Criteria::EQUAL |
- Returns
- DocumentDataQuery The current query, for fluid interface
BaseDocumentDataQuery::filterByPrimaryKey |
( |
|
$key | ) |
|
Filter the query by primary key
- Parameters
-
mixed | $key | Primary key to use for the query |
- Returns
- DocumentDataQuery The current query, for fluid interface
BaseDocumentDataQuery::filterByPrimaryKeys |
( |
|
$keys | ) |
|
Filter the query by a list of primary keys
- Parameters
-
array | $keys | The list of primary key to use for the query |
- Returns
- DocumentDataQuery The current query, for fluid interface
BaseDocumentDataQuery::filterByUpdatedAt |
( |
|
$updatedAt = null , |
|
|
|
$comparison = null |
|
) |
| |
Filter the query on the updated_at column
Example usage: $query->filterByUpdatedAt('2011-03-14'); // WHERE updated_at = '2011-03-14' $query->filterByUpdatedAt('now'); // WHERE updated_at = '2011-03-14' $query->filterByUpdatedAt(array('max' => 'yesterday')); // WHERE updated_at < '2011-03-13'
- Parameters
-
mixed | $updatedAt | The value to use as filter. Values can be integers (unix timestamps), DateTime objects, or strings. Empty strings are treated as NULL. Use scalar values for equality. Use array values for in_array() equivalent. Use associative array('min' => $minValue, 'max' => $maxValue) for intervals. |
string | $comparison | Operator to use for the column comparison, defaults to Criteria::EQUAL |
- Returns
- DocumentDataQuery The current query, for fluid interface
BaseDocumentDataQuery::filterByUpdatedBy |
( |
|
$updatedBy = null , |
|
|
|
$comparison = null |
|
) |
| |
Filter the query on the updated_by column
Example usage: $query->filterByUpdatedBy(1234); // WHERE updated_by = 1234 $query->filterByUpdatedBy(array(12, 34)); // WHERE updated_by IN (12, 34) $query->filterByUpdatedBy(array('min' => 12)); // WHERE updated_by >= 12 $query->filterByUpdatedBy(array('max' => 12)); // WHERE updated_by <= 12
- See also
- filterByUserRelatedByUpdatedBy()
- Parameters
-
mixed | $updatedBy | The value to use as filter. Use scalar values for equality. Use array values for in_array() equivalent. Use associative array('min' => $minValue, 'max' => $maxValue) for intervals. |
string | $comparison | Operator to use for the column comparison, defaults to Criteria::EQUAL |
- Returns
- DocumentDataQuery The current query, for fluid interface
BaseDocumentDataQuery::filterByUserRelatedByCreatedBy |
( |
|
$user, |
|
|
|
$comparison = null |
|
) |
| |
Filter the query by a related User object
- Parameters
-
User | PropelObjectCollection | $user | The related object(s) to use as filter |
string | $comparison | Operator to use for the column comparison, defaults to Criteria::EQUAL |
- Returns
- DocumentDataQuery The current query, for fluid interface
- Exceptions
-
PropelException | - if the provided filter is invalid. |
BaseDocumentDataQuery::filterByUserRelatedByUpdatedBy |
( |
|
$user, |
|
|
|
$comparison = null |
|
) |
| |
Filter the query by a related User object
- Parameters
-
User | PropelObjectCollection | $user | The related object(s) to use as filter |
string | $comparison | Operator to use for the column comparison, defaults to Criteria::EQUAL |
- Returns
- DocumentDataQuery The current query, for fluid interface
- Exceptions
-
PropelException | - if the provided filter is invalid. |
BaseDocumentDataQuery::findOneByHash |
( |
|
$key, |
|
|
|
$con = null |
|
) |
| |
Alias of findPk to use instance pooling
- Parameters
-
mixed | $key | Primary key to use for the query |
PropelPDO | $con | A connection object |
- Returns
- DocumentData A model object, or null if the key is not found
- Exceptions
-
BaseDocumentDataQuery::findPk |
( |
|
$key, |
|
|
|
$con = null |
|
) |
| |
Find object by primary key. Propel uses the instance pool to skip the database if the object exists. Go fast if the query is untouched.
$obj = $c->findPk(12, $con);
- Parameters
-
mixed | $key | Primary key to use for the query |
PropelPDO | $con | an optional connection object |
- Returns
- DocumentData|DocumentData[]|mixed the result, formatted by the current formatter
BaseDocumentDataQuery::findPkComplex |
( |
|
$key, |
|
|
|
$con |
|
) |
| |
|
protected |
Find object by primary key.
- Parameters
-
mixed | $key | Primary key to use for the query |
PropelPDO | $con | A connection object |
- Returns
- DocumentData|DocumentData[]|mixed the result, formatted by the current formatter
BaseDocumentDataQuery::findPks |
( |
|
$keys, |
|
|
|
$con = null |
|
) |
| |
Find objects by primary key $objs = $c->findPks(array(12, 56, 832), $con);
- Parameters
-
array | $keys | Primary keys to use for the query |
PropelPDO | $con | an optional connection object |
- Returns
- PropelObjectCollection|DocumentData[]|mixed the list of results, formatted by the current formatter
BaseDocumentDataQuery::findPkSimple |
( |
|
$key, |
|
|
|
$con |
|
) |
| |
|
protected |
Find object by primary key using raw SQL to go fast. Bypass doSelect() and the object formatter by using generated code.
- Parameters
-
mixed | $key | Primary key to use for the query |
PropelPDO | $con | A connection object |
- Returns
- DocumentData A model object, or null if the key is not found
- Exceptions
-
BaseDocumentDataQuery::firstCreatedFirst |
( |
| ) |
|
Order by create date asc
- Returns
- DocumentDataQuery The current query, for fluid interface
BaseDocumentDataQuery::firstUpdatedFirst |
( |
| ) |
|
Order by update date asc
- Returns
- DocumentDataQuery The current query, for fluid interface
BaseDocumentDataQuery::joinDocument |
( |
|
$relationAlias = null , |
|
|
|
$joinType = Criteria::INNER_JOIN |
|
) |
| |
Adds a JOIN clause to the query using the Document relation
- Parameters
-
string | $relationAlias | optional alias for the relation |
string | $joinType | Accepted values are null, 'left join', 'right join', 'inner join' |
- Returns
- DocumentDataQuery The current query, for fluid interface
BaseDocumentDataQuery::joinUserRelatedByCreatedBy |
( |
|
$relationAlias = null , |
|
|
|
$joinType = Criteria::LEFT_JOIN |
|
) |
| |
Adds a JOIN clause to the query using the UserRelatedByCreatedBy relation
- Parameters
-
string | $relationAlias | optional alias for the relation |
string | $joinType | Accepted values are null, 'left join', 'right join', 'inner join' |
- Returns
- DocumentDataQuery The current query, for fluid interface
BaseDocumentDataQuery::joinUserRelatedByUpdatedBy |
( |
|
$relationAlias = null , |
|
|
|
$joinType = Criteria::LEFT_JOIN |
|
) |
| |
Adds a JOIN clause to the query using the UserRelatedByUpdatedBy relation
- Parameters
-
string | $relationAlias | optional alias for the relation |
string | $joinType | Accepted values are null, 'left join', 'right join', 'inner join' |
- Returns
- DocumentDataQuery The current query, for fluid interface
BaseDocumentDataQuery::lastCreatedFirst |
( |
| ) |
|
Order by create date desc
- Returns
- DocumentDataQuery The current query, for fluid interface
BaseDocumentDataQuery::lastUpdatedFirst |
( |
| ) |
|
Order by update date desc
- Returns
- DocumentDataQuery The current query, for fluid interface
BaseDocumentDataQuery::prune |
( |
|
$documentData = null | ) |
|
Exclude object from result
- Parameters
-
DocumentData | $documentData | Object to remove from the list of results |
- Returns
- DocumentDataQuery The current query, for fluid interface
BaseDocumentDataQuery::recentlyCreated |
( |
|
$nbDays = 7 | ) |
|
Filter by the latest created
- Parameters
-
int | $nbDays | Maximum age of in days |
- Returns
- DocumentDataQuery The current query, for fluid interface
BaseDocumentDataQuery::recentlyUpdated |
( |
|
$nbDays = 7 | ) |
|
Filter by the latest updated
- Parameters
-
int | $nbDays | Maximum age of the latest update in days |
- Returns
- DocumentDataQuery The current query, for fluid interface
BaseDocumentDataQuery::useDocumentQuery |
( |
|
$relationAlias = null , |
|
|
|
$joinType = Criteria::INNER_JOIN |
|
) |
| |
Use the Document relation Document object
- See also
- useQuery()
- Parameters
-
string | $relationAlias | optional alias for the relation, to be used as main alias in the secondary query |
string | $joinType | Accepted values are null, 'left join', 'right join', 'inner join' |
- Returns
- DocumentQuery A secondary query class using the current class as primary query
BaseDocumentDataQuery::useUserRelatedByCreatedByQuery |
( |
|
$relationAlias = null , |
|
|
|
$joinType = Criteria::LEFT_JOIN |
|
) |
| |
Use the UserRelatedByCreatedBy relation User object
- See also
- useQuery()
- Parameters
-
string | $relationAlias | optional alias for the relation, to be used as main alias in the secondary query |
string | $joinType | Accepted values are null, 'left join', 'right join', 'inner join' |
- Returns
- UserQuery A secondary query class using the current class as primary query
BaseDocumentDataQuery::useUserRelatedByUpdatedByQuery |
( |
|
$relationAlias = null , |
|
|
|
$joinType = Criteria::LEFT_JOIN |
|
) |
| |
Use the UserRelatedByUpdatedBy relation User object
- See also
- useQuery()
- Parameters
-
string | $relationAlias | optional alias for the relation, to be used as main alias in the secondary query |
string | $joinType | Accepted values are null, 'left join', 'right join', 'inner join' |
- Returns
- UserQuery A secondary query class using the current class as primary query
The documentation for this class was generated from the following file:
- cms-full/base/lib/model/om/BaseDocumentDataQuery.php