Methods

__construct()

__construct(string $dbName, string $modelName, string $modelAlias)

Initializes internal state of \Thelia\Model\Base\FolderDocumentQuery object.

Parameters

string $dbName

The database name

string $modelName

The phpName of a model, e.g. 'Book'

string $modelAlias

The alias for the model in this query, e.g. 'b'

create()

create(string $modelAlias, \Propel\Runtime\ActiveQuery\Criteria $criteria) : \Thelia\Model\FolderDocumentQuery

Returns a new ChildFolderDocumentQuery object.

Parameters

string $modelAlias

The alias of a model in the query

\Propel\Runtime\ActiveQuery\Criteria $criteria

Optional Criteria to build the query from

Returns

\Thelia\Model\FolderDocumentQuery

findPk()

findPk(mixed $key, \Propel\Runtime\Connection\ConnectionInterface $con) : \Thelia\Model\FolderDocument|array|mixed

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

\Propel\Runtime\Connection\ConnectionInterface $con

an optional connection object

Returns

\Thelia\Model\FolderDocument|array|mixed —

the result, formatted by the current formatter

findPks()

findPks(array $keys, \Propel\Runtime\Connection\ConnectionInterface $con) : \Propel\Runtime\Collection\ObjectCollection|array|mixed

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

Parameters

array $keys

Primary keys to use for the query

\Propel\Runtime\Connection\ConnectionInterface $con

an optional connection object

Returns

\Propel\Runtime\Collection\ObjectCollection|array|mixed —

the list of results, formatted by the current formatter

filterByPrimaryKey()

filterByPrimaryKey(mixed $key) : \Thelia\Model\FolderDocumentQuery

Filter the query by primary key

Parameters

mixed $key

Primary key to use for the query

Returns

\Thelia\Model\FolderDocumentQuery

The current query, for fluid interface

filterByPrimaryKeys()

filterByPrimaryKeys(array $keys) : \Thelia\Model\FolderDocumentQuery

Filter the query by a list of primary keys

Parameters

array $keys

The list of primary key to use for the query

Returns

\Thelia\Model\FolderDocumentQuery

The current query, for fluid interface

filterById()

filterById(mixed $id, string $comparison) : \Thelia\Model\FolderDocumentQuery

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

Parameters

mixed $id

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

\Thelia\Model\FolderDocumentQuery

The current query, for fluid interface

filterByFolderId()

filterByFolderId(mixed $folderId, string $comparison) : \Thelia\Model\FolderDocumentQuery

Filter the query on the folder_id column

Example usage: $query->filterByFolderId(1234); // WHERE folder_id = 1234 $query->filterByFolderId(array(12, 34)); // WHERE folder_id IN (12, 34) $query->filterByFolderId(array('min' => 12)); // WHERE folder_id > 12

Parameters

mixed $folderId

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

\Thelia\Model\FolderDocumentQuery

The current query, for fluid interface

filterByFile()

filterByFile(string $file, string $comparison) : \Thelia\Model\FolderDocumentQuery

Filter the query on the file column

Example usage: $query->filterByFile('fooValue'); // WHERE file = 'fooValue' $query->filterByFile('%fooValue%'); // WHERE file LIKE '%fooValue%'

Parameters

string $file

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

\Thelia\Model\FolderDocumentQuery

The current query, for fluid interface

filterByPosition()

filterByPosition(mixed $position, string $comparison) : \Thelia\Model\FolderDocumentQuery

Filter the query on the position column

Example usage: $query->filterByPosition(1234); // WHERE position = 1234 $query->filterByPosition(array(12, 34)); // WHERE position IN (12, 34) $query->filterByPosition(array('min' => 12)); // WHERE position > 12

Parameters

mixed $position

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

\Thelia\Model\FolderDocumentQuery

The current query, for fluid interface

filterByCreatedAt()

filterByCreatedAt(mixed $createdAt, string $comparison) : \Thelia\Model\FolderDocumentQuery

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

\Thelia\Model\FolderDocumentQuery

The current query, for fluid interface

filterByUpdatedAt()

filterByUpdatedAt(mixed $updatedAt, string $comparison) : \Thelia\Model\FolderDocumentQuery

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

\Thelia\Model\FolderDocumentQuery

The current query, for fluid interface

filterByFolder()

filterByFolder(\Thelia\Model\Folder|\Propel\Runtime\Collection\ObjectCollection $folder, string $comparison) : \Thelia\Model\FolderDocumentQuery

Filter the query by a related \Thelia\Model\Folder object

Parameters

\Thelia\Model\Folder|\Propel\Runtime\Collection\ObjectCollection $folder

The related object(s) to use as filter

string $comparison

Operator to use for the column comparison, defaults to Criteria::EQUAL

Returns

\Thelia\Model\FolderDocumentQuery

The current query, for fluid interface

joinFolder()

joinFolder(string $relationAlias, string $joinType) : \Thelia\Model\FolderDocumentQuery

Adds a JOIN clause to the query using the Folder relation

Parameters

string $relationAlias

optional alias for the relation

string $joinType

Accepted values are null, 'left join', 'right join', 'inner join'

Returns

\Thelia\Model\FolderDocumentQuery

The current query, for fluid interface

useFolderQuery()

useFolderQuery(string $relationAlias, string $joinType) : \Thelia\Model\FolderQuery

Use the Folder relation Folder object

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

\Thelia\Model\FolderQuery

A secondary query class using the current class as primary query

filterByFolderDocumentI18n()

filterByFolderDocumentI18n(\Thelia\Model\FolderDocumentI18n|\Propel\Runtime\Collection\ObjectCollection $folderDocumentI18n, string $comparison) : \Thelia\Model\FolderDocumentQuery

Filter the query by a related \Thelia\Model\FolderDocumentI18n object

Parameters

\Thelia\Model\FolderDocumentI18n|\Propel\Runtime\Collection\ObjectCollection $folderDocumentI18n

the related object to use as filter

string $comparison

Operator to use for the column comparison, defaults to Criteria::EQUAL

Returns

\Thelia\Model\FolderDocumentQuery

The current query, for fluid interface

joinFolderDocumentI18n()

joinFolderDocumentI18n(string $relationAlias, string $joinType) : \Thelia\Model\FolderDocumentQuery

Adds a JOIN clause to the query using the FolderDocumentI18n relation

Parameters

string $relationAlias

optional alias for the relation

string $joinType

Accepted values are null, 'left join', 'right join', 'inner join'

Returns

\Thelia\Model\FolderDocumentQuery

The current query, for fluid interface

useFolderDocumentI18nQuery()

useFolderDocumentI18nQuery(string $relationAlias, string $joinType) : \Thelia\Model\FolderDocumentI18nQuery

Use the FolderDocumentI18n relation FolderDocumentI18n object

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

\Thelia\Model\FolderDocumentI18nQuery

A secondary query class using the current class as primary query

prune()

prune(\Thelia\Model\FolderDocument $folderDocument) : \Thelia\Model\FolderDocumentQuery

Exclude object from result

Parameters

\Thelia\Model\FolderDocument $folderDocument

Object to remove from the list of results

Returns

\Thelia\Model\FolderDocumentQuery

The current query, for fluid interface

doDeleteAll()

doDeleteAll(\Propel\Runtime\Connection\ConnectionInterface $con) : int

Deletes all rows from the folder_document table.

Parameters

\Propel\Runtime\Connection\ConnectionInterface $con

the connection to use

Returns

int —

The number of affected rows (if supported by underlying database driver).

delete()

delete(\Propel\Runtime\Connection\ConnectionInterface $con) : int

Performs a DELETE on the database, given a ChildFolderDocument or Criteria object OR a primary key value.

Parameters

\Propel\Runtime\Connection\ConnectionInterface $con

the connection to use

Throws

\Propel\Runtime\Exception\PropelException

Any exceptions caught during processing will be rethrown wrapped into a PropelException.

Returns

int —

The number of affected rows (if supported by underlying database driver). This includes CASCADE-related rows if supported by native driver or if emulated using Propel.

recentlyUpdated()

recentlyUpdated(int $nbDays) : \Thelia\Model\FolderDocumentQuery

Filter by the latest updated

Parameters

int $nbDays

Maximum age of the latest update in days

Returns

\Thelia\Model\FolderDocumentQuery

The current query, for fluid interface

recentlyCreated()

recentlyCreated(int $nbDays) : \Thelia\Model\FolderDocumentQuery

Filter by the latest created

Parameters

int $nbDays

Maximum age of in days

Returns

\Thelia\Model\FolderDocumentQuery

The current query, for fluid interface

lastUpdatedFirst()

lastUpdatedFirst() : \Thelia\Model\FolderDocumentQuery

Order by update date desc

Returns

\Thelia\Model\FolderDocumentQuery

The current query, for fluid interface

firstUpdatedFirst()

firstUpdatedFirst() : \Thelia\Model\FolderDocumentQuery

Order by update date asc

Returns

\Thelia\Model\FolderDocumentQuery

The current query, for fluid interface

lastCreatedFirst()

lastCreatedFirst() : \Thelia\Model\FolderDocumentQuery

Order by create date desc

Returns

\Thelia\Model\FolderDocumentQuery

The current query, for fluid interface

firstCreatedFirst()

firstCreatedFirst() : \Thelia\Model\FolderDocumentQuery

Order by create date asc

Returns

\Thelia\Model\FolderDocumentQuery

The current query, for fluid interface

joinI18n()

joinI18n(string $locale, string $relationAlias, string $joinType) : \Thelia\Model\FolderDocumentQuery

Adds a JOIN clause to the query using the i18n relation

Parameters

string $locale

Locale to use for the join condition, e.g. 'fr_FR'

string $relationAlias

optional alias for the relation

string $joinType

Accepted values are null, 'left join', 'right join', 'inner join'. Defaults to left join.

Returns

\Thelia\Model\FolderDocumentQuery

The current query, for fluid interface

joinWithI18n()

joinWithI18n(string $locale, string $joinType) : \Thelia\Model\FolderDocumentQuery

Adds a JOIN clause to the query and hydrates the related I18n object.

Shortcut for $c->joinI18n($locale)->with()

Parameters

string $locale

Locale to use for the join condition, e.g. 'fr_FR'

string $joinType

Accepted values are null, 'left join', 'right join', 'inner join'. Defaults to left join.

Returns

\Thelia\Model\FolderDocumentQuery

The current query, for fluid interface

useI18nQuery()

useI18nQuery(string $locale, string $relationAlias, string $joinType) : \Thelia\Model\FolderDocumentI18nQuery

Use the I18n relation query object

Parameters

string $locale

Locale to use for the join condition, e.g. 'fr_FR'

string $relationAlias

optional alias for the relation

string $joinType

Accepted values are null, 'left join', 'right join', 'inner join'. Defaults to left join.

Returns

\Thelia\Model\FolderDocumentI18nQuery

A secondary query class using the current class as primary query

orderById()

orderById($order =) : \Thelia\Model\FolderDocumentQuery

Order by the id column

Parameters

$order =

Returns

\Thelia\Model\FolderDocumentQuery

orderByFolderId()

orderByFolderId($order =) : \Thelia\Model\FolderDocumentQuery

Order by the folder_id column

Parameters

$order =

Returns

\Thelia\Model\FolderDocumentQuery

orderByFile()

orderByFile($order =) : \Thelia\Model\FolderDocumentQuery

Order by the file column

Parameters

$order =

Returns

\Thelia\Model\FolderDocumentQuery

orderByPosition()

orderByPosition($order =) : \Thelia\Model\FolderDocumentQuery

Order by the position column

Parameters

$order =

Returns

\Thelia\Model\FolderDocumentQuery

orderByCreatedAt()

orderByCreatedAt($order =) : \Thelia\Model\FolderDocumentQuery

Order by the created_at column

Parameters

$order =

Returns

\Thelia\Model\FolderDocumentQuery

orderByUpdatedAt()

orderByUpdatedAt($order =) : \Thelia\Model\FolderDocumentQuery

Order by the updated_at column

Parameters

$order =

Returns

\Thelia\Model\FolderDocumentQuery

groupById()

groupById() : \Thelia\Model\FolderDocumentQuery

Group by the id column

Returns

\Thelia\Model\FolderDocumentQuery

groupByFolderId()

groupByFolderId() : \Thelia\Model\FolderDocumentQuery

Group by the folder_id column

Returns

\Thelia\Model\FolderDocumentQuery

groupByFile()

groupByFile() : \Thelia\Model\FolderDocumentQuery

Group by the file column

Returns

\Thelia\Model\FolderDocumentQuery

groupByPosition()

groupByPosition() : \Thelia\Model\FolderDocumentQuery

Group by the position column

Returns

\Thelia\Model\FolderDocumentQuery

groupByCreatedAt()

groupByCreatedAt() : \Thelia\Model\FolderDocumentQuery

Group by the created_at column

Returns

\Thelia\Model\FolderDocumentQuery

groupByUpdatedAt()

groupByUpdatedAt() : \Thelia\Model\FolderDocumentQuery

Group by the updated_at column

Returns

\Thelia\Model\FolderDocumentQuery

leftJoin()

leftJoin(mixed $relation) : \Thelia\Model\FolderDocumentQuery

Adds a LEFT JOIN clause to the query

Parameters

mixed $relation

Returns

\Thelia\Model\FolderDocumentQuery

rightJoin()

rightJoin(mixed $relation) : \Thelia\Model\FolderDocumentQuery

Adds a RIGHT JOIN clause to the query

Parameters

mixed $relation

Returns

\Thelia\Model\FolderDocumentQuery

innerJoin()

innerJoin(mixed $relation) : \Thelia\Model\FolderDocumentQuery

Adds a INNER JOIN clause to the query

Parameters

mixed $relation

Returns

\Thelia\Model\FolderDocumentQuery

leftJoinFolder()

leftJoinFolder($relationAlias =) : \Thelia\Model\FolderDocumentQuery

Adds a LEFT JOIN clause to the query using the Folder relation

Parameters

$relationAlias =

Returns

\Thelia\Model\FolderDocumentQuery

rightJoinFolder()

rightJoinFolder($relationAlias =) : \Thelia\Model\FolderDocumentQuery

Adds a RIGHT JOIN clause to the query using the Folder relation

Parameters

$relationAlias =

Returns

\Thelia\Model\FolderDocumentQuery

innerJoinFolder()

innerJoinFolder($relationAlias =) : \Thelia\Model\FolderDocumentQuery

Adds a INNER JOIN clause to the query using the Folder relation

Parameters

$relationAlias =

Returns

\Thelia\Model\FolderDocumentQuery

leftJoinFolderDocumentI18n()

leftJoinFolderDocumentI18n($relationAlias =) : \Thelia\Model\FolderDocumentQuery

Adds a LEFT JOIN clause to the query using the FolderDocumentI18n relation

Parameters

$relationAlias =

Returns

\Thelia\Model\FolderDocumentQuery

rightJoinFolderDocumentI18n()

rightJoinFolderDocumentI18n($relationAlias =) : \Thelia\Model\FolderDocumentQuery

Adds a RIGHT JOIN clause to the query using the FolderDocumentI18n relation

Parameters

$relationAlias =

Returns

\Thelia\Model\FolderDocumentQuery

innerJoinFolderDocumentI18n()

innerJoinFolderDocumentI18n($relationAlias =) : \Thelia\Model\FolderDocumentQuery

Adds a INNER JOIN clause to the query using the FolderDocumentI18n relation

Parameters

$relationAlias =

Returns

\Thelia\Model\FolderDocumentQuery

findOne()

findOne(ConnectionInterface $con) : \Thelia\Model\FolderDocument

Return the first ChildFolderDocument matching the query

Parameters

ConnectionInterface $con

Returns

\Thelia\Model\FolderDocument

findOneOrCreate()

findOneOrCreate(ConnectionInterface $con) : \Thelia\Model\FolderDocument

Return the first ChildFolderDocument matching the query, or a new ChildFolderDocument object populated from the query conditions when no match is found

Parameters

ConnectionInterface $con

Returns

\Thelia\Model\FolderDocument

findOneById()

findOneById(int $id) : \Thelia\Model\FolderDocument

Return the first ChildFolderDocument filtered by the id column

Parameters

int $id

Returns

\Thelia\Model\FolderDocument

findOneByFolderId()

findOneByFolderId(int $folder_id) : \Thelia\Model\FolderDocument

Return the first ChildFolderDocument filtered by the folder_id column

Parameters

int $folder_id

Returns

\Thelia\Model\FolderDocument

findOneByFile()

findOneByFile(string $file) : \Thelia\Model\FolderDocument

Return the first ChildFolderDocument filtered by the file column

Parameters

string $file

Returns

\Thelia\Model\FolderDocument

findOneByPosition()

findOneByPosition(int $position) : \Thelia\Model\FolderDocument

Return the first ChildFolderDocument filtered by the position column

Parameters

int $position

Returns

\Thelia\Model\FolderDocument

findOneByCreatedAt()

findOneByCreatedAt(string $created_at) : \Thelia\Model\FolderDocument

Return the first ChildFolderDocument filtered by the created_at column

Parameters

string $created_at

Returns

\Thelia\Model\FolderDocument

findOneByUpdatedAt()

findOneByUpdatedAt(string $updated_at) : \Thelia\Model\FolderDocument

Return the first ChildFolderDocument filtered by the updated_at column

Parameters

string $updated_at

Returns

\Thelia\Model\FolderDocument

findById()

findById(int $id) : array

Return ChildFolderDocument objects filtered by the id column

Parameters

int $id

Returns

array

findByFolderId()

findByFolderId(int $folder_id) : array

Return ChildFolderDocument objects filtered by the folder_id column

Parameters

int $folder_id

Returns

array

findByFile()

findByFile(string $file) : array

Return ChildFolderDocument objects filtered by the file column

Parameters

string $file

Returns

array

findByPosition()

findByPosition(int $position) : array

Return ChildFolderDocument objects filtered by the position column

Parameters

int $position

Returns

array

findByCreatedAt()

findByCreatedAt(string $created_at) : array

Return ChildFolderDocument objects filtered by the created_at column

Parameters

string $created_at

Returns

array

findByUpdatedAt()

findByUpdatedAt(string $updated_at) : array

Return ChildFolderDocument objects filtered by the updated_at column

Parameters

string $updated_at

Returns

array

findPkSimple()

findPkSimple(mixed $key, \Propel\Runtime\Connection\ConnectionInterface $con) : \Thelia\Model\FolderDocument

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

\Propel\Runtime\Connection\ConnectionInterface $con

A connection object

Returns

\Thelia\Model\FolderDocument

A model object, or null if the key is not found

findPkComplex()

findPkComplex(mixed $key, \Propel\Runtime\Connection\ConnectionInterface $con) : \Thelia\Model\FolderDocument|array|mixed

Find object by primary key.

Parameters

mixed $key

Primary key to use for the query

\Propel\Runtime\Connection\ConnectionInterface $con

A connection object

Returns

\Thelia\Model\FolderDocument|array|mixed —

the result, formatted by the current formatter