ApiQuery
class ApiQuery extends ApiQuery
Skeleton subclass for performing query and update operations on the 'api' table.
You should add additional methods to this class to meet the application requirements. This class will only be generated as long as it does not already exist in the output directory.
Methods
Initializes internal state of \Thelia\Model\Base\ApiQuery object.
Returns a new ChildApiQuery object.
Find object by primary key.
Find objects by primary key
$objs = $c->findPks(array(12, 56, 832), $con);
Filter the query on the id column
Filter the query on the label column
Filter the query on the api_key column
Filter the query on the profile_id column
Filter the query on the created_at column
Filter the query on the updated_at column
Filter the query by a related \Thelia\Model\Profile object
Adds a JOIN clause to the query using the Profile relation
Use the Profile relation Profile object
Deletes all rows from the api table.
Performs a DELETE on the database, given a ChildApi or Criteria object OR a primary key value.
Adds a LEFT JOIN clause to the query using the Profile relation
Adds a RIGHT JOIN clause to the query using the Profile relation
Adds a INNER JOIN clause to the query using the Profile relation
Return the first ChildApi matching the query
Return the first ChildApi matching the query, or a new ChildApi object populated from the query conditions when no match is found
Return the first ChildApi filtered by the label column
Return the first ChildApi filtered by the api_key column
Return the first ChildApi filtered by the profile_id column
Return the first ChildApi filtered by the created_at column
Return the first ChildApi filtered by the updated_at column
Return ChildApi objects filtered by the label column
Return ChildApi objects filtered by the api_key column
Return ChildApi objects filtered by the profile_id column
Return ChildApi objects filtered by the created_at column
Return ChildApi objects filtered by the updated_at column
Details
in
ApiQuery at line 74
__construct(
string $dbName = 'thelia',
string $modelName = '\\Thelia\\Model\\Api',
string $modelAlias = null)
Initializes internal state of \Thelia\Model\Base\ApiQuery object.
in
ApiQuery at line 87
static
ApiQuery
create(
string $modelAlias = null,
Criteria $criteria = null)
Returns a new ChildApiQuery object.
in
ApiQuery at line 117
Api|array|mixed
findPk(
mixed $key,
ConnectionInterface $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);
in
ApiQuery at line 199
ObjectCollection|array|mixed
findPks(
array $keys,
ConnectionInterface $con = null)
Find objects by primary key
$objs = $c->findPks(array(12, 56, 832), $con);
in
ApiQuery at line 233
ApiQuery
filterByPrimaryKeys(
array $keys)
Filter the query by a list of primary keys
in
ApiQuery at line 257
ApiQuery
filterById(
mixed $id = null,
string $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
in
ApiQuery at line 295
ApiQuery
filterByLabel(
string $label = null,
string $comparison = null)
Filter the query on the label column
Example usage:
$query->filterByLabel('fooValue'); // WHERE label = 'fooValue'
$query->filterByLabel('%fooValue%'); // WHERE label LIKE '%fooValue%'
in
ApiQuery at line 324
ApiQuery
filterByApiKey(
string $apiKey = null,
string $comparison = null)
Filter the query on the api_key column
Example usage:
$query->filterByApiKey('fooValue'); // WHERE apikey = 'fooValue'
$query->filterByApiKey('%fooValue%'); // WHERE apikey LIKE '%fooValue%'
in
ApiQuery at line 358
ApiQuery
filterByProfileId(
mixed $profileId = null,
string $comparison = null)
Filter the query on the profile_id column
Example usage:
$query->filterByProfileId(1234); // WHERE profileid = 1234
$query->filterByProfileId(array(12, 34)); // WHERE profileid IN (12, 34)
$query->filterByProfileId(array('min' => 12)); // WHERE profile_id > 12
in
ApiQuery at line 401
ApiQuery
filterByCreatedAt(
mixed $createdAt = null,
string $comparison = null)
Filter the query on the created_at column
Example usage:
$query->filterByCreatedAt('2011-03-14'); // WHERE createdat = '2011-03-14'
$query->filterByCreatedAt('now'); // WHERE createdat = '2011-03-14'
$query->filterByCreatedAt(array('max' => 'yesterday')); // WHERE created_at > '2011-03-13'
in
ApiQuery at line 444
ApiQuery
filterByUpdatedAt(
mixed $updatedAt = null,
string $comparison = null)
Filter the query on the updated_at column
Example usage:
$query->filterByUpdatedAt('2011-03-14'); // WHERE updatedat = '2011-03-14'
$query->filterByUpdatedAt('now'); // WHERE updatedat = '2011-03-14'
$query->filterByUpdatedAt(array('max' => 'yesterday')); // WHERE updated_at > '2011-03-13'
in
ApiQuery at line 475
ApiQuery
filterByProfile(
Profile|ObjectCollection $profile,
string $comparison = null)
Filter the query by a related \Thelia\Model\Profile object
in
ApiQuery at line 500
ApiQuery
joinProfile(
string $relationAlias = null,
string $joinType = Criteria::LEFT_JOIN)
Adds a JOIN clause to the query using the Profile relation
in
ApiQuery at line 535
ProfileQuery
useProfileQuery(
string $relationAlias = null,
string $joinType = Criteria::LEFT_JOIN)
Use the Profile relation Profile object
in
ApiQuery at line 564
int
doDeleteAll(
ConnectionInterface $con = null)
Deletes all rows from the api table.
in
ApiQuery at line 601
int
delete(
ConnectionInterface $con = null)
Performs a DELETE on the database, given a ChildApi or Criteria object OR a primary key value.
in
ApiQuery at line 64
ChildApiQuery
orderById($order = Criteria::ASC)
Order by the id column
in
ApiQuery at line 64
ChildApiQuery
orderByLabel($order = Criteria::ASC)
Order by the label column
in
ApiQuery at line 64
ChildApiQuery
orderByApiKey($order = Criteria::ASC)
Order by the api_key column
in
ApiQuery at line 64
ChildApiQuery
orderByProfileId($order = Criteria::ASC)
Order by the profile_id column
in
ApiQuery at line 64
ChildApiQuery
orderByCreatedAt($order = Criteria::ASC)
Order by the created_at column
in
ApiQuery at line 64
ChildApiQuery
orderByUpdatedAt($order = Criteria::ASC)
Order by the updated_at column
in
ApiQuery at line 64
ChildApiQuery
groupById()
Group by the id column
in
ApiQuery at line 64
ChildApiQuery
groupByLabel()
Group by the label column
in
ApiQuery at line 64
ChildApiQuery
groupByApiKey()
Group by the api_key column
in
ApiQuery at line 64
ChildApiQuery
groupByProfileId()
Group by the profile_id column
in
ApiQuery at line 64
ChildApiQuery
groupByCreatedAt()
Group by the created_at column
in
ApiQuery at line 64
ChildApiQuery
groupByUpdatedAt()
Group by the updated_at column
in
ApiQuery at line 64
ChildApiQuery
leftJoin($relation)
Adds a LEFT JOIN clause to the query
in
ApiQuery at line 64
ChildApiQuery
rightJoin($relation)
Adds a RIGHT JOIN clause to the query
in
ApiQuery at line 64
ChildApiQuery
innerJoin($relation)
Adds a INNER JOIN clause to the query
in
ApiQuery at line 64
ChildApiQuery
leftJoinProfile($relationAlias = null)
Adds a LEFT JOIN clause to the query using the Profile relation
in
ApiQuery at line 64
ChildApiQuery
rightJoinProfile($relationAlias = null)
Adds a RIGHT JOIN clause to the query using the Profile relation
in
ApiQuery at line 64
ChildApiQuery
innerJoinProfile($relationAlias = null)
Adds a INNER JOIN clause to the query using the Profile relation
in
ApiQuery at line 64
ChildApi
findOne(
ConnectionInterface $con = null)
Return the first ChildApi matching the query
in
ApiQuery at line 64
ChildApi
findOneOrCreate(
ConnectionInterface $con = null)
Return the first ChildApi matching the query, or a new ChildApi object populated from the query conditions when no match is found
in
ApiQuery at line 64
ChildApi
findOneById(
int $id)
Return the first ChildApi filtered by the id column
in
ApiQuery at line 64
ChildApi
findOneByLabel(
string $label)
Return the first ChildApi filtered by the label column
in
ApiQuery at line 64
ChildApi
findOneByApiKey(
string $api_key)
Return the first ChildApi filtered by the api_key column
in
ApiQuery at line 64
ChildApi
findOneByProfileId(
int $profile_id)
Return the first ChildApi filtered by the profile_id column
in
ApiQuery at line 64
ChildApi
findOneByCreatedAt(
string $created_at)
Return the first ChildApi filtered by the created_at column
in
ApiQuery at line 64
ChildApi
findOneByUpdatedAt(
string $updated_at)
Return the first ChildApi filtered by the updated_at column
in
ApiQuery at line 64
array
findById(
int $id)
Return ChildApi objects filtered by the id column
in
ApiQuery at line 64
array
findByLabel(
string $label)
Return ChildApi objects filtered by the label column
in
ApiQuery at line 64
array
findByApiKey(
string $api_key)
Return ChildApi objects filtered by the api_key column
in
ApiQuery at line 64
array
findByProfileId(
int $profile_id)
Return ChildApi objects filtered by the profile_id column
in
ApiQuery at line 64
array
findByCreatedAt(
string $created_at)
Return ChildApi objects filtered by the created_at column
in
ApiQuery at line 64
array
findByUpdatedAt(
string $updated_at)
Return ChildApi objects filtered by the updated_at column