Class BaseSynonymQuery

Base class that represents a query for the 'synonym' table.

ModelCriteria

cli_db\propel\om\BaseSynonymQuery

Direct known subclasses

Abstract
Namespace: cli_db\propel\om
Package: propel\generator\cli\db\om
Located at src/cli/db/propel-classes/cli_db/om/BaseSynonymQuery.php

Methods summary
`public`	# `__construct( string $dbName = 'cli_db', string $modelName = 'cli_db\\propel\\Synonym', string $modelAlias = null )` Initializes internal state of BaseSynonymQuery object. Initializes internal state of BaseSynonymQuery object. Parameters `$dbName` `string` $dbName The dabase name `$modelName` `string` $modelName The phpName of a model, e.g. 'Book' `$modelAlias` `string` $modelAlias The alias for the model in this query, e.g. 'b'
`public static cli_db\propel\SynonymQuery`	# `create( string $modelAlias = null, cli_db\propel\SynonymQuery\|Criteria $criteria = null )` Returns a new SynonymQuery object. Returns a new SynonymQuery object. Parameters `$modelAlias` `string` $modelAlias The alias of a model in the query `$criteria` `cli_db\propel\SynonymQuery\|Criteria` $criteria Optional Criteria to build the query from Returns `cli_db\propel\SynonymQuery`
`public cli_db\propel\Synonym\|cli_db\propel\Synonym[]\|mixed`	# `findPk( mixed $key, PropelPDO $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. 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 `$key` `mixed` $key Primary key to use for the query `$con` `PropelPDO` $con an optional connection object Returns `cli_db\propel\Synonym\|cli_db\propel\Synonym[]\|mixed` the result, formatted by the current formatter
`public cli_db\propel\Synonym`	# `findOneBySynonymId( mixed $key, PropelPDO $con = null )` Alias of findPk to use instance pooling Alias of findPk to use instance pooling Parameters `$key` `mixed` $key Primary key to use for the query `$con` `PropelPDO` $con A connection object Returns `cli_db\propel\Synonym` A model object, or null if the key is not found Throws `PropelException`
`protected cli_db\propel\Synonym`	# `findPkSimple( mixed $key, PropelPDO $con )` Find object by primary key using raw SQL to go fast. Bypass doSelect() and the object formatter by using generated code. Find object by primary key using raw SQL to go fast. Bypass doSelect() and the object formatter by using generated code. Parameters `$key` `mixed` $key Primary key to use for the query `$con` `PropelPDO` $con A connection object Returns `cli_db\propel\Synonym` A model object, or null if the key is not found Throws `PropelException`
`protected cli_db\propel\Synonym\|cli_db\propel\Synonym[]\|mixed`	# `findPkComplex( mixed $key, PropelPDO $con )` Find object by primary key. Find object by primary key. Parameters `$key` `mixed` $key Primary key to use for the query `$con` `PropelPDO` $con A connection object Returns `cli_db\propel\Synonym\|cli_db\propel\Synonym[]\|mixed` the result, formatted by the current formatter
`public PropelObjectCollection\|cli_db\propel\Synonym[]\|mixed`	# `findPks( array $keys, PropelPDO $con = null )` Find objects by primary key $objs = $c->findPks(array(12, 56, 832), $con); Find objects by primary key $objs = $c->findPks(array(12, 56, 832), $con); Parameters `$keys` `array` $keys Primary keys to use for the query `$con` `PropelPDO` $con an optional connection object Returns `PropelObjectCollection\|cli_db\propel\Synonym[]\|mixed` the list of results, formatted by the current formatter
`public cli_db\propel\SynonymQuery`	# `filterByPrimaryKey( mixed $key )` Filter the query by primary key Filter the query by primary key Parameters `$key` `mixed` $key Primary key to use for the query Returns `cli_db\propel\SynonymQuery` The current query, for fluid interface
`public cli_db\propel\SynonymQuery`	# `filterByPrimaryKeys( array $keys )` Filter the query by a list of primary keys Filter the query by a list of primary keys Parameters `$keys` `array` $keys The list of primary key to use for the query Returns `cli_db\propel\SynonymQuery` The current query, for fluid interface
`public cli_db\propel\SynonymQuery`	# `filterBySynonymId( mixed $synonymId = null, string $comparison = null )` Filter the query on the synonym_id column Filter the query on the synonym_id column Example usage: $query->filterBySynonymId(1234); // WHERE synonym_id = 1234 $query->filterBySynonymId(array(12, 34)); // WHERE synonym_id IN (12, 34) $query->filterBySynonymId(array('min' => 12)); // WHERE synonym_id >= 12 $query->filterBySynonymId(array('max' => 12)); // WHERE synonym_id <= 12 Parameters `$synonymId` `mixed` $synonymId 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. `$comparison` `string` $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL Returns `cli_db\propel\SynonymQuery` The current query, for fluid interface
`public cli_db\propel\SynonymQuery`	# `filterByName( string $name = null, string $comparison = null )` Filter the query on the name column Filter the query on the name column Example usage: $query->filterByName('fooValue'); // WHERE name = 'fooValue' $query->filterByName('%fooValue%'); // WHERE name LIKE '%fooValue%' Parameters `$name` `string` $name The value to use as filter. Accepts wildcards (* and % trigger a LIKE) `$comparison` `string` $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL Returns `cli_db\propel\SynonymQuery` The current query, for fluid interface
`public cli_db\propel\SynonymQuery`	# `filterByTypeId( mixed $typeId = null, string $comparison = null )` Filter the query on the type_id column Filter the query on the type_id column Example usage: $query->filterByTypeId(1234); // WHERE type_id = 1234 $query->filterByTypeId(array(12, 34)); // WHERE type_id IN (12, 34) $query->filterByTypeId(array('min' => 12)); // WHERE type_id >= 12 $query->filterByTypeId(array('max' => 12)); // WHERE type_id <= 12 Parameters `$typeId` `mixed` $typeId 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. `$comparison` `string` $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL Returns `cli_db\propel\SynonymQuery` The current query, for fluid interface See `cli_db\propel\om\BaseSynonymQuery::filterByCvterm()`
`public cli_db\propel\SynonymQuery`	# `filterBySynonymSgml( string $synonymSgml = null, string $comparison = null )` Filter the query on the synonym_sgml column Filter the query on the synonym_sgml column Example usage: $query->filterBySynonymSgml('fooValue'); // WHERE synonym_sgml = 'fooValue' $query->filterBySynonymSgml('%fooValue%'); // WHERE synonym_sgml LIKE '%fooValue%' Parameters `$synonymSgml` `string` $synonymSgml The value to use as filter. Accepts wildcards (* and % trigger a LIKE) `$comparison` `string` $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL Returns `cli_db\propel\SynonymQuery` The current query, for fluid interface
`public cli_db\propel\SynonymQuery`	# `filterByCvterm( cli_db\propel\Cvterm\|PropelObjectCollection $cvterm, string $comparison = null )` Filter the query by a related Cvterm object Filter the query by a related Cvterm object Parameters `$cvterm` `cli_db\propel\Cvterm\|PropelObjectCollection` $cvterm The related object(s) to use as filter `$comparison` `string` $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL Returns `cli_db\propel\SynonymQuery` The current query, for fluid interface Throws `PropelException` - if the provided filter is invalid.
`public cli_db\propel\SynonymQuery`	# `joinCvterm( string $relationAlias = null, string $joinType = cli_db\propel\om\Criteria::INNER_JOIN )` Adds a JOIN clause to the query using the Cvterm relation Adds a JOIN clause to the query using the Cvterm relation Parameters `$relationAlias` `string` $relationAlias optional alias for the relation `$joinType` `string` $joinType Accepted values are null, 'left join', 'right join', 'inner join' Returns `cli_db\propel\SynonymQuery` The current query, for fluid interface
`public cli_db\propel\CvtermQuery`	# `useCvtermQuery( string $relationAlias = null, string $joinType = cli_db\propel\om\Criteria::INNER_JOIN )` Use the Cvterm relation Cvterm object Use the Cvterm relation Cvterm object Parameters `$relationAlias` `string` $relationAlias optional alias for the relation, to be used as main alias in the secondary query `$joinType` `string` $joinType Accepted values are null, 'left join', 'right join', 'inner join' Returns `cli_db\propel\CvtermQuery` A secondary query class using the current class as primary query See useQuery()
`public cli_db\propel\SynonymQuery`	# `filterByFeatureSynonym( cli_db\propel\FeatureSynonym\|PropelObjectCollection $featureSynonym, string $comparison = null )` Filter the query by a related FeatureSynonym object Filter the query by a related FeatureSynonym object Parameters `$featureSynonym` `cli_db\propel\FeatureSynonym\|PropelObjectCollection` $featureSynonym the related object to use as filter `$comparison` `string` $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL Returns `cli_db\propel\SynonymQuery` The current query, for fluid interface Throws `PropelException` - if the provided filter is invalid.
`public cli_db\propel\SynonymQuery`	# `joinFeatureSynonym( string $relationAlias = null, string $joinType = cli_db\propel\om\Criteria::INNER_JOIN )` Adds a JOIN clause to the query using the FeatureSynonym relation Adds a JOIN clause to the query using the FeatureSynonym relation Parameters `$relationAlias` `string` $relationAlias optional alias for the relation `$joinType` `string` $joinType Accepted values are null, 'left join', 'right join', 'inner join' Returns `cli_db\propel\SynonymQuery` The current query, for fluid interface
`public cli_db\propel\FeatureSynonymQuery`	# `useFeatureSynonymQuery( string $relationAlias = null, string $joinType = cli_db\propel\om\Criteria::INNER_JOIN )` Use the FeatureSynonym relation FeatureSynonym object Use the FeatureSynonym relation FeatureSynonym object Parameters `$relationAlias` `string` $relationAlias optional alias for the relation, to be used as main alias in the secondary query `$joinType` `string` $joinType Accepted values are null, 'left join', 'right join', 'inner join' Returns `cli_db\propel\FeatureSynonymQuery` A secondary query class using the current class as primary query See useQuery()
`public cli_db\propel\SynonymQuery`	# `prune( cli_db\propel\Synonym $synonym = null )` Exclude object from result Exclude object from result Parameters `$synonym` `cli_db\propel\Synonym` $synonym Object to remove from the list of results Returns `cli_db\propel\SynonymQuery` The current query, for fluid interface

Magic methods summary
`public cli_db\propel\SynonymQuery`	# `orderBySynonymId( mixed $order = cli_db\propel\om\Criteria::ASC )` Order by the synonym_id column Order by the synonym_id column Parameters `$order` `mixed` $order Returns `cli_db\propel\SynonymQuery`
`public cli_db\propel\SynonymQuery`	# `orderByName( mixed $order = cli_db\propel\om\Criteria::ASC )` Order by the name column Order by the name column Parameters `$order` `mixed` $order Returns `cli_db\propel\SynonymQuery`
`public cli_db\propel\SynonymQuery`	# `orderByTypeId( mixed $order = cli_db\propel\om\Criteria::ASC )` Order by the type_id column Order by the type_id column Parameters `$order` `mixed` $order Returns `cli_db\propel\SynonymQuery`
`public cli_db\propel\SynonymQuery`	# `orderBySynonymSgml( mixed $order = cli_db\propel\om\Criteria::ASC )` Order by the synonym_sgml column Order by the synonym_sgml column Parameters `$order` `mixed` $order Returns `cli_db\propel\SynonymQuery`
`public cli_db\propel\SynonymQuery`	# `groupBySynonymId( )` Group by the synonym_id column Group by the synonym_id column Returns `cli_db\propel\SynonymQuery`
`public cli_db\propel\SynonymQuery`	# `groupByName( )` Group by the name column Group by the name column Returns `cli_db\propel\SynonymQuery`
`public cli_db\propel\SynonymQuery`	# `groupByTypeId( )` Group by the type_id column Group by the type_id column Returns `cli_db\propel\SynonymQuery`
`public cli_db\propel\SynonymQuery`	# `groupBySynonymSgml( )` Group by the synonym_sgml column Group by the synonym_sgml column Returns `cli_db\propel\SynonymQuery`
`public cli_db\propel\SynonymQuery`	# `leftJoin( mixed $relation = )` Adds a LEFT JOIN clause to the query Adds a LEFT JOIN clause to the query Parameters `$relation` `mixed` $relation Returns `cli_db\propel\SynonymQuery`
`public cli_db\propel\SynonymQuery`	# `rightJoin( mixed $relation = )` Adds a RIGHT JOIN clause to the query Adds a RIGHT JOIN clause to the query Parameters `$relation` `mixed` $relation Returns `cli_db\propel\SynonymQuery`
`public cli_db\propel\SynonymQuery`	# `innerJoin( mixed $relation = )` Adds a INNER JOIN clause to the query Adds a INNER JOIN clause to the query Parameters `$relation` `mixed` $relation Returns `cli_db\propel\SynonymQuery`
`public cli_db\propel\SynonymQuery`	# `leftJoinCvterm( mixed $relationAlias = null )` Adds a LEFT JOIN clause to the query using the Cvterm relation Adds a LEFT JOIN clause to the query using the Cvterm relation Parameters `$relationAlias` `mixed` $relationAlias Returns `cli_db\propel\SynonymQuery`
`public cli_db\propel\SynonymQuery`	# `rightJoinCvterm( mixed $relationAlias = null )` Adds a RIGHT JOIN clause to the query using the Cvterm relation Adds a RIGHT JOIN clause to the query using the Cvterm relation Parameters `$relationAlias` `mixed` $relationAlias Returns `cli_db\propel\SynonymQuery`
`public cli_db\propel\SynonymQuery`	# `innerJoinCvterm( mixed $relationAlias = null )` Adds a INNER JOIN clause to the query using the Cvterm relation Adds a INNER JOIN clause to the query using the Cvterm relation Parameters `$relationAlias` `mixed` $relationAlias Returns `cli_db\propel\SynonymQuery`
`public cli_db\propel\SynonymQuery`	# `leftJoinFeatureSynonym( mixed $relationAlias = null )` Adds a LEFT JOIN clause to the query using the FeatureSynonym relation Adds a LEFT JOIN clause to the query using the FeatureSynonym relation Parameters `$relationAlias` `mixed` $relationAlias Returns `cli_db\propel\SynonymQuery`
`public cli_db\propel\SynonymQuery`	# `rightJoinFeatureSynonym( mixed $relationAlias = null )` Adds a RIGHT JOIN clause to the query using the FeatureSynonym relation Adds a RIGHT JOIN clause to the query using the FeatureSynonym relation Parameters `$relationAlias` `mixed` $relationAlias Returns `cli_db\propel\SynonymQuery`
`public cli_db\propel\SynonymQuery`	# `innerJoinFeatureSynonym( mixed $relationAlias = null )` Adds a INNER JOIN clause to the query using the FeatureSynonym relation Adds a INNER JOIN clause to the query using the FeatureSynonym relation Parameters `$relationAlias` `mixed` $relationAlias Returns `cli_db\propel\SynonymQuery`
`public cli_db\propel\Synonym`	# `findOne( PropelPDO $con = null )` Return the first Synonym matching the query Return the first Synonym matching the query Parameters `$con` `PropelPDO` $con Returns `cli_db\propel\Synonym`
`public cli_db\propel\Synonym`	# `findOneOrCreate( PropelPDO $con = null )` Return the first Synonym matching the query, or a new Synonym object populated from the query conditions when no match is found Return the first Synonym matching the query, or a new Synonym object populated from the query conditions when no match is found Parameters `$con` `PropelPDO` $con Returns `cli_db\propel\Synonym`
`public cli_db\propel\Synonym`	# `findOneByName( string $name = )` Return the first Synonym filtered by the name column Return the first Synonym filtered by the name column Parameters `$name` `string` $name Returns `cli_db\propel\Synonym`
`public cli_db\propel\Synonym`	# `findOneByTypeId( integer $type_id = )` Return the first Synonym filtered by the type_id column Return the first Synonym filtered by the type_id column Parameters `$type_id` `integer` $type_id Returns `cli_db\propel\Synonym`
`public cli_db\propel\Synonym`	# `findOneBySynonymSgml( string $synonym_sgml = )` Return the first Synonym filtered by the synonym_sgml column Return the first Synonym filtered by the synonym_sgml column Parameters `$synonym_sgml` `string` $synonym_sgml Returns `cli_db\propel\Synonym`
`public array`	# `findBySynonymId( integer $synonym_id = )` Return Synonym objects filtered by the synonym_id column Return Synonym objects filtered by the synonym_id column Parameters `$synonym_id` `integer` $synonym_id Returns `array`
`public array`	# `findByName( string $name = )` Return Synonym objects filtered by the name column Return Synonym objects filtered by the name column Parameters `$name` `string` $name Returns `array`
`public array`	# `findByTypeId( integer $type_id = )` Return Synonym objects filtered by the type_id column Return Synonym objects filtered by the type_id column Parameters `$type_id` `integer` $type_id Returns `array`
`public array`	# `findBySynonymSgml( string $synonym_sgml = )` Return Synonym objects filtered by the synonym_sgml column Return Synonym objects filtered by the synonym_sgml column Parameters `$synonym_sgml` `string` $synonym_sgml Returns `array`

Namespaces

Classes

Class BaseSynonymQuery

Direct known subclasses

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

See

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

See

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

See

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns