rapila
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
BasePagePropertyQuery Class Reference
Inheritance diagram for BasePagePropertyQuery:
PagePropertyQuery

Public Member Functions

 __construct ($dbName=null, $modelName=null, $modelAlias=null)
 
 findPk ($key, $con=null)
 
 findOneById ($key, $con=null)
 
 findPks ($keys, $con=null)
 
 filterByPrimaryKey ($key)
 
 filterByPrimaryKeys ($keys)
 
 filterById ($id=null, $comparison=null)
 
 filterByPageId ($pageId=null, $comparison=null)
 
 filterByName ($name=null, $comparison=null)
 
 filterByValue ($value=null, $comparison=null)
 
 filterByCreatedAt ($createdAt=null, $comparison=null)
 
 filterByUpdatedAt ($updatedAt=null, $comparison=null)
 
 filterByCreatedBy ($createdBy=null, $comparison=null)
 
 filterByUpdatedBy ($updatedBy=null, $comparison=null)
 
 filterByPage ($page, $comparison=null)
 
 joinPage ($relationAlias=null, $joinType=Criteria::INNER_JOIN)
 
 usePageQuery ($relationAlias=null, $joinType=Criteria::INNER_JOIN)
 
 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)
 
 prune ($pageProperty=null)
 
 recentlyUpdated ($nbDays=7)
 
 lastUpdatedFirst ()
 
 firstUpdatedFirst ()
 
 recentlyCreated ($nbDays=7)
 
 lastCreatedFirst ()
 
 firstCreatedFirst ()
 
 findMostRecentUpdate ($bAsTimestamp=false)
 
 filterByPKArray ($pkArray)
 
 filterByPKString ($pkString)
 

Static Public Member Functions

static create ($modelAlias=null, $criteria=null)
 

Protected Member Functions

 findPkSimple ($key, $con)
 
 findPkComplex ($key, $con)
 

Constructor & Destructor Documentation

BasePagePropertyQuery::__construct (   $dbName = null,
  $modelName = null,
  $modelAlias = null 
)

Initializes internal state of BasePagePropertyQuery object.

Parameters
string$dbNameThe dabase name
string$modelNameThe phpName of a model, e.g. 'Book'
string$modelAliasThe alias for the model in this query, e.g. 'b'

Member Function Documentation

static BasePagePropertyQuery::create (   $modelAlias = null,
  $criteria = null 
)
static

Returns a new PagePropertyQuery object.

Parameters
string$modelAliasThe alias of a model in the query
PagePropertyQuery | Criteria$criteriaOptional Criteria to build the query from
Returns
PagePropertyQuery
BasePagePropertyQuery::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$createdAtThe 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$comparisonOperator to use for the column comparison, defaults to Criteria::EQUAL
Returns
PagePropertyQuery The current query, for fluid interface
BasePagePropertyQuery::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$createdByThe 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$comparisonOperator to use for the column comparison, defaults to Criteria::EQUAL
Returns
PagePropertyQuery The current query, for fluid interface
BasePagePropertyQuery::filterById (   $id = null,
  $comparison = null 
)

Filter the query on the id column

Example usage: $query->filterById(1234); // WHERE id = 1234 $query->filterById(array(12, 34)); // WHERE id IN (12, 34) $query->filterById(array('min' => 12)); // WHERE id >= 12 $query->filterById(array('max' => 12)); // WHERE id <= 12

Parameters
mixed$idThe 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$comparisonOperator to use for the column comparison, defaults to Criteria::EQUAL
Returns
PagePropertyQuery The current query, for fluid interface
BasePagePropertyQuery::filterByName (   $name = null,
  $comparison = null 
)

Filter the query on the name column

Example usage: $query->filterByName('fooValue'); // WHERE name = 'fooValue' $query->filterByName('fooValue'); // WHERE name LIKE 'fooValue'

Parameters
string$nameThe value to use as filter. Accepts wildcards (* and % trigger a LIKE)
string$comparisonOperator to use for the column comparison, defaults to Criteria::EQUAL
Returns
PagePropertyQuery The current query, for fluid interface
BasePagePropertyQuery::filterByPage (   $page,
  $comparison = null 
)

Filter the query by a related Page object

Parameters
Page | PropelObjectCollection$pageThe related object(s) to use as filter
string$comparisonOperator to use for the column comparison, defaults to Criteria::EQUAL
Returns
PagePropertyQuery The current query, for fluid interface
Exceptions
PropelException- if the provided filter is invalid.
BasePagePropertyQuery::filterByPageId (   $pageId = null,
  $comparison = null 
)

Filter the query on the page_id column

Example usage: $query->filterByPageId(1234); // WHERE page_id = 1234 $query->filterByPageId(array(12, 34)); // WHERE page_id IN (12, 34) $query->filterByPageId(array('min' => 12)); // WHERE page_id >= 12 $query->filterByPageId(array('max' => 12)); // WHERE page_id <= 12

See also
filterByPage()
Parameters
mixed$pageIdThe 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$comparisonOperator to use for the column comparison, defaults to Criteria::EQUAL
Returns
PagePropertyQuery The current query, for fluid interface
BasePagePropertyQuery::filterByPrimaryKey (   $key)

Filter the query by primary key

Parameters
mixed$keyPrimary key to use for the query
Returns
PagePropertyQuery The current query, for fluid interface
BasePagePropertyQuery::filterByPrimaryKeys (   $keys)

Filter the query by a list of primary keys

Parameters
array$keysThe list of primary key to use for the query
Returns
PagePropertyQuery The current query, for fluid interface
BasePagePropertyQuery::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$updatedAtThe 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$comparisonOperator to use for the column comparison, defaults to Criteria::EQUAL
Returns
PagePropertyQuery The current query, for fluid interface
BasePagePropertyQuery::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$updatedByThe 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$comparisonOperator to use for the column comparison, defaults to Criteria::EQUAL
Returns
PagePropertyQuery The current query, for fluid interface
BasePagePropertyQuery::filterByUserRelatedByCreatedBy (   $user,
  $comparison = null 
)

Filter the query by a related User object

Parameters
User | PropelObjectCollection$userThe related object(s) to use as filter
string$comparisonOperator to use for the column comparison, defaults to Criteria::EQUAL
Returns
PagePropertyQuery The current query, for fluid interface
Exceptions
PropelException- if the provided filter is invalid.
BasePagePropertyQuery::filterByUserRelatedByUpdatedBy (   $user,
  $comparison = null 
)

Filter the query by a related User object

Parameters
User | PropelObjectCollection$userThe related object(s) to use as filter
string$comparisonOperator to use for the column comparison, defaults to Criteria::EQUAL
Returns
PagePropertyQuery The current query, for fluid interface
Exceptions
PropelException- if the provided filter is invalid.
BasePagePropertyQuery::filterByValue (   $value = null,
  $comparison = null 
)

Filter the query on the value column

Example usage: $query->filterByValue('fooValue'); // WHERE value = 'fooValue' $query->filterByValue('fooValue'); // WHERE value LIKE 'fooValue'

Parameters
string$valueThe value to use as filter. Accepts wildcards (* and % trigger a LIKE)
string$comparisonOperator to use for the column comparison, defaults to Criteria::EQUAL
Returns
PagePropertyQuery The current query, for fluid interface
BasePagePropertyQuery::findOneById (   $key,
  $con = null 
)

Alias of findPk to use instance pooling

Parameters
mixed$keyPrimary key to use for the query
PropelPDO$conA connection object
Returns
PageProperty A model object, or null if the key is not found
Exceptions
PropelException
BasePagePropertyQuery::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$keyPrimary key to use for the query
PropelPDO$conan optional connection object
Returns
PageProperty|PageProperty[]|mixed the result, formatted by the current formatter
BasePagePropertyQuery::findPkComplex (   $key,
  $con 
)
protected

Find object by primary key.

Parameters
mixed$keyPrimary key to use for the query
PropelPDO$conA connection object
Returns
PageProperty|PageProperty[]|mixed the result, formatted by the current formatter
BasePagePropertyQuery::findPks (   $keys,
  $con = null 
)

Find objects by primary key $objs = $c->findPks(array(12, 56, 832), $con);

Parameters
array$keysPrimary keys to use for the query
PropelPDO$conan optional connection object
Returns
PropelObjectCollection|PageProperty[]|mixed the list of results, formatted by the current formatter
BasePagePropertyQuery::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$keyPrimary key to use for the query
PropelPDO$conA connection object
Returns
PageProperty A model object, or null if the key is not found
Exceptions
PropelException
BasePagePropertyQuery::firstCreatedFirst ( )

Order by create date asc

Returns
PagePropertyQuery The current query, for fluid interface
BasePagePropertyQuery::firstUpdatedFirst ( )

Order by update date asc

Returns
PagePropertyQuery The current query, for fluid interface
BasePagePropertyQuery::joinPage (   $relationAlias = null,
  $joinType = Criteria::INNER_JOIN 
)

Adds a JOIN clause to the query using the Page relation

Parameters
string$relationAliasoptional alias for the relation
string$joinTypeAccepted values are null, 'left join', 'right join', 'inner join'
Returns
PagePropertyQuery The current query, for fluid interface
BasePagePropertyQuery::joinUserRelatedByCreatedBy (   $relationAlias = null,
  $joinType = Criteria::LEFT_JOIN 
)

Adds a JOIN clause to the query using the UserRelatedByCreatedBy relation

Parameters
string$relationAliasoptional alias for the relation
string$joinTypeAccepted values are null, 'left join', 'right join', 'inner join'
Returns
PagePropertyQuery The current query, for fluid interface
BasePagePropertyQuery::joinUserRelatedByUpdatedBy (   $relationAlias = null,
  $joinType = Criteria::LEFT_JOIN 
)

Adds a JOIN clause to the query using the UserRelatedByUpdatedBy relation

Parameters
string$relationAliasoptional alias for the relation
string$joinTypeAccepted values are null, 'left join', 'right join', 'inner join'
Returns
PagePropertyQuery The current query, for fluid interface
BasePagePropertyQuery::lastCreatedFirst ( )

Order by create date desc

Returns
PagePropertyQuery The current query, for fluid interface
BasePagePropertyQuery::lastUpdatedFirst ( )

Order by update date desc

Returns
PagePropertyQuery The current query, for fluid interface
BasePagePropertyQuery::prune (   $pageProperty = null)

Exclude object from result

Parameters
PageProperty$pagePropertyObject to remove from the list of results
Returns
PagePropertyQuery The current query, for fluid interface
BasePagePropertyQuery::recentlyCreated (   $nbDays = 7)

Filter by the latest created

Parameters
int$nbDaysMaximum age of in days
Returns
PagePropertyQuery The current query, for fluid interface
BasePagePropertyQuery::recentlyUpdated (   $nbDays = 7)

Filter by the latest updated

Parameters
int$nbDaysMaximum age of the latest update in days
Returns
PagePropertyQuery The current query, for fluid interface
BasePagePropertyQuery::usePageQuery (   $relationAlias = null,
  $joinType = Criteria::INNER_JOIN 
)

Use the Page relation Page object

See also
useQuery()
Parameters
string$relationAliasoptional alias for the relation, to be used as main alias in the secondary query
string$joinTypeAccepted values are null, 'left join', 'right join', 'inner join'
Returns
PageQuery A secondary query class using the current class as primary query
BasePagePropertyQuery::useUserRelatedByCreatedByQuery (   $relationAlias = null,
  $joinType = Criteria::LEFT_JOIN 
)

Use the UserRelatedByCreatedBy relation User object

See also
useQuery()
Parameters
string$relationAliasoptional alias for the relation, to be used as main alias in the secondary query
string$joinTypeAccepted values are null, 'left join', 'right join', 'inner join'
Returns
UserQuery A secondary query class using the current class as primary query
BasePagePropertyQuery::useUserRelatedByUpdatedByQuery (   $relationAlias = null,
  $joinType = Criteria::LEFT_JOIN 
)

Use the UserRelatedByUpdatedBy relation User object

See also
useQuery()
Parameters
string$relationAliasoptional alias for the relation, to be used as main alias in the secondary query
string$joinTypeAccepted 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: