Navigation Menu

Skip to content

Commit

Permalink
Fixed typos
Browse files Browse the repository at this point in the history
  • Loading branch information
pborreli committed Jul 17, 2012
1 parent 56d0be9 commit e39b741
Show file tree
Hide file tree
Showing 100 changed files with 228 additions and 228 deletions.
2 changes: 1 addition & 1 deletion documentation/behaviors/nested-set.markdown
Expand Up @@ -7,7 +7,7 @@ title: NestedSet Behavior

The `nested_set` behavior allows a model to become a tree structure, and provides numerous methods to traverse the tree in an efficient way.

Many applications need to store hierarchical data in the model. For instance, a forum stores a tree of messages for each discussion. A CMS sees sections and subsections as a navigation tree. In a business organization chart, each person is a leaf of the organization tree. [Nested sets](http://en.wikipedia.org/wiki/Nested_set_model) are the best way to store such hierachical data in a relational database and manipulate it. The name "nested sets" describes the algorithm used to store the position of a model in the tree ; it is also known as "modified preorder tree traversal".
Many applications need to store hierarchical data in the model. For instance, a forum stores a tree of messages for each discussion. A CMS sees sections and subsections as a navigation tree. In a business organization chart, each person is a leaf of the organization tree. [Nested sets](http://en.wikipedia.org/wiki/Nested_set_model) are the best way to store such hierarchical data in a relational database and manipulate it. The name "nested sets" describes the algorithm used to store the position of a model in the tree ; it is also known as "modified preorder tree traversal".

## Basic Usage ##

Expand Down
2 changes: 1 addition & 1 deletion documentation/behaviors/validate.markdown
Expand Up @@ -34,7 +34,7 @@ Then add validation rules via `<parameter>` tag.

Let's now see the properties of `<parameter>` tag:
* The `name` of each parameter is arbitrary.
* The `value` of the parameters is an array in YAML format, in wich we need to specify 3 values:
* The `value` of the parameters is an array in YAML format, in which we need to specify 3 values:
`column`: the column to validate
`validator`: the name of [Validator Constraint](http://symfony.com/doc/current/reference/constraints.html)
`options`: (optional)an array of optional values to pass to the validator constraint class, according to its reference documentation
Expand Down
2 changes: 1 addition & 1 deletion documentation/behaviors/versionable.markdown
Expand Up @@ -254,7 +254,7 @@ The audit log abilities need to be enabled in the schema as well:
* `string getVersionCreatedBy()`: Gets the author name for the revision
* `mixed getVersionCreatedAt()`: Gets the creation date for the revision (the behavior takes care of setting it)
* `BaseObject setVersionComment(string $comment)`: Defines the comment for the revision
* `string getVersioneComment()`: Gets the comment for the revision
* `string getVersionComment()`: Gets the comment for the revision

### Peer class ###

Expand Down
2 changes: 1 addition & 1 deletion documentation/cookbook/multi-component-data-model.markdown
Expand Up @@ -13,7 +13,7 @@ You can use as many `schema.xml` files as you want. Schema files have to be name

Each schema file has to contain a `<database>` element with a `name` attribute. This name references the connection settings to be used for this database (and configured in the `runtime-conf.xml`), so separated schemas can share a common database name.

Whenever you call a propel build taks, Propel will consider all these schema files and build the classes (or the SQL) for all the tables.
Whenever you call a propel build tasks, Propel will consider all these schema files and build the classes (or the SQL) for all the tables.

## Understanding Packages ##

Expand Down
Expand Up @@ -89,7 +89,7 @@ echo $book->getStyle(); // novel
// Trying to set a value not in the valueSet throws an exception

// ENUM columns are also searchable, using the generated filterByXXX() method
// or other ModelCritera methods (like where(), condition())
// or other ModelCriteria methods (like where(), condition())
$books = BookQuery::create()
->filterByStyle('novel')
->find();
Expand Down
4 changes: 2 additions & 2 deletions documentation/documentation/07-behaviors.markdown
Expand Up @@ -114,7 +114,7 @@ Propel offers three ways to achieve the refactoring of the common behavior. The

Behaviors are special objects that use events called during the build process to enhance the generated model classes. Behaviors can add attributes and methods to both the Peer and model classes, they can modify the course of some of the generated methods, and they can even modify the structure of a database by adding columns or tables.

For instance, Propel bundles a behavior called `timestampable`, which does exatcly the same thing as described above. But instead of adding columns and methods by hand, all you have to do is to declare it in a `<behavior>` tag in your `schema.xml`, as follows:
For instance, Propel bundles a behavior called `timestampable`, which does exactly the same thing as described above. But instead of adding columns and methods by hand, all you have to do is to declare it in a `<behavior>` tag in your `schema.xml`, as follows:

{% highlight xml %}
<table name="book">
Expand Down Expand Up @@ -189,7 +189,7 @@ As a Propel behavior can be packaged into a single class, behaviors are quite ea
# ----------------------------------

propel.behavior.timestampable.class = propel.engine.behavior.timestampable.TimestampableBehavior
# Add your custom behavior pathes here
# Add your custom behavior paths here
propel.behavior.formidable.class = path.to.FormidableBehavior
{% endhighlight %}

Expand Down
2 changes: 1 addition & 1 deletion documentation/documentation/09-inheritance.markdown
Expand Up @@ -120,7 +120,7 @@ If you wish to enforce using subclasses of an entity, you may declare a table "a
...
{% endhighlight %}

That way users will only be able to instanciate `Essay` or `Comic` books, but not `Book`.
That way users will only be able to instantiate `Essay` or `Comic` books, but not `Book`.

## Class Table Inheritance ##

Expand Down
4 changes: 2 additions & 2 deletions documentation/documentation/whats-new.markdown
Expand Up @@ -35,7 +35,7 @@ Starting with Propel 1.6, the `sql`-`insert-sql` sequence is replaced by the `di

Migrations are a fantastic way to work on complex projects with always evolving models ; they are also a great tool for team work, since migration classes can be shared among all developers. That way, when a developer adds a table to the model, a second developer just needs to run the related migration to have the table added to the table.

Propel migrations can also be executed incrementally - the new `up` and `down` tasks are there for that. And when you're lost in migration, call the `status` task to chack which migrations were already executed, and which ones should be executed to update the database structure.
Propel migrations can also be executed incrementally - the new `up` and `down` tasks are there for that. And when you're lost in migration, call the `status` task to check which migrations were already executed, and which ones should be executed to update the database structure.

The Propel documentation offers [an entire chapter on Migrations](10-migrations.html) to explain how to use them and how they work.

Expand Down Expand Up @@ -556,7 +556,7 @@ echo BookPeer::STYLE_POETRY; // 'poetry'
print_r(BookPeer::getValueSet(BookPeer::STYLE)); // array('novel', 'essay', 'poetry')

// ENUM columns are also searchable, using the generated filterByXXX() method
// or other ModelCritera methods (like where(), orWhere(), condition())
// or other ModelCriteria methods (like where(), orWhere(), condition())
$books = BookQuery::create()
->filterByStyle('novel')
->find();
Expand Down
4 changes: 2 additions & 2 deletions documentation/reference/active-record.markdown
Expand Up @@ -82,8 +82,8 @@ abstract class BaseBook extends BaseObject implements Persistent
// BaseObject and Persistent are classes bundled by Propel
// Do not alter the code of the Base- classes, as your modifications will be overriden
// each time you rebuild the model. Instead, add your cutom code to the stub slass
// Do not alter the code of the Base- classes, as your modifications will be overridden
// each time you rebuild the model. Instead, add your custom code to the stub class
class Book extends BaseBook
{
public function getCapitalTitle()
Expand Down
2 changes: 1 addition & 1 deletion documentation/reference/buildtime-configuration.markdown
Expand Up @@ -90,7 +90,7 @@ propel.schema.transform = true|{false}
# the SQL DDL, the PHP classes, etc.
propel.database = pgsql|mysql|sqlite|mssql|oracle

# The database PDO connection settings at builtime.
# The database PDO connection settings at buildtime.
# This setting is required for the sql, reverse, and datasql tasks.
# Note that some drivers (e.g. mysql, oracle) require that you specify the
# username and password separately from the DSN, which is why they are
Expand Down
4 changes: 2 additions & 2 deletions documentation/reference/model-criteria.markdown
Expand Up @@ -43,7 +43,7 @@ $stmt->bind(':p1', time() - 30 * 24 * 60 * 60, PDO::PARAM_INT);
$res = $stmt->execute();
{% endhighlight %}

The final `find()` doesn't just execute the SQL query above, it also instanciates `Book` objects and populates them with the results of the query. Eventually, it returns a `PropelCollection` object with these `Book` objects inside. For the sake of clarity, you can consider this collection object as an array. In fact, you can use it as if it were a true PHP array and iterate over the result list the usual way:
The final `find()` doesn't just execute the SQL query above, it also instantiates `Book` objects and populates them with the results of the query. Eventually, it returns a `PropelCollection` object with these `Book` objects inside. For the sake of clarity, you can consider this collection object as an array. In fact, you can use it as if it were a true PHP array and iterate over the result list the usual way:

{% highlight php %}
<?php
Expand Down Expand Up @@ -778,7 +778,7 @@ $author = $book->getAuthor(); // No additional query needed
$publisher = $book->getPublisher(); // No additional query needed
{% endhighlight %}

So `joinWith()` is very useful to minimize the number of database queries. As soon as you see that the number of queries necessary to perform an action is proportional to the number of results, adding `With` after `join()` calls is the trick to get down to a more reasonnable query count.
So `joinWith()` is very useful to minimize the number of database queries. As soon as you see that the number of queries necessary to perform an action is proportional to the number of results, adding `With` after `join()` calls is the trick to get down to a more reasonable query count.

### Adding Columns ###

Expand Down
2 changes: 1 addition & 1 deletion documentation/reference/schema.markdown
Expand Up @@ -354,7 +354,7 @@ For example:

### Adding Vendor Info ###

Propel supports database-specific elements in the schema (currently only for MySQL). This "vendor" parameters affect the generated SQL. To add vendor data, add a `<vendor>` tag with a `type` attribute specifying the target database vendor. In the `<vendor>` tag, add `<parameter>` tags with a `name` and a `value` attribue. For instance:
Propel supports database-specific elements in the schema (currently only for MySQL). This "vendor" parameters affect the generated SQL. To add vendor data, add a `<vendor>` tag with a `type` attribute specifying the target database vendor. In the `<vendor>` tag, add `<parameter>` tags with a `name` and a `value` attribute. For instance:

{% highlight xml %}
<table name="book">
Expand Down
Expand Up @@ -415,7 +415,7 @@ protected function addIsInTree(&$script)
{
$script .= "
/**
* Tests if onbject is a node, i.e. if it is inserted in the tree
* Tests if object is a node, i.e. if it is inserted in the tree
*
* @return bool
*/
Expand Down
Expand Up @@ -325,7 +325,7 @@ protected function addToVersion(&$script)
$ARclassName = $this->getActiveRecordClassName();
$script .= "
/**
* Sets the properties of the curent object to the value they had at a specific version
* Sets the properties of the current object to the value they had at a specific version
*
* @param integer \$versionNumber The version number to read
* @param ConnectionInterface \$con the connection to use
Expand Down Expand Up @@ -355,7 +355,7 @@ protected function addPopulateFromVersion(&$script)
$primaryKeyName = $tablePKs[0]->getPhpName();
$script .= "
/**
* Sets the properties of the curent object to the value they had at a specific version
* Sets the properties of the current object to the value they had at a specific version
*
* @param {$versionARClassName} \$version The version object to use
* @param ConnectionInterface \$con the connection to use
Expand Down
Expand Up @@ -110,7 +110,7 @@ protected function addOrderByVersion(&$script)
{
$script .= "
/**
* Wrap the order on the version volumn
* Wrap the order on the version column
*
* @param string \$order The sorting order. Criteria::ASC by default, also accepts Criteria::DESC
* @return " . $this->builder->getQueryClassName() . " The current query, for fluid interface
Expand Down
8 changes: 4 additions & 4 deletions src/Propel/Generator/Builder/Om/AbstractOMBuilder.php
Expand Up @@ -229,7 +229,7 @@ public function getNamespace()
}

/**
* This decare the class use and get the correct name to use (short classname, Alias, or FQCN)
* This declare the class use and get the correct name to use (short classname, Alias, or FQCN)
*
* @param AbstractOMBuilder $builder
* @param boolean $fqcn true to return the $fqcn classname
Expand Down Expand Up @@ -257,7 +257,7 @@ public function getClassNameFromBuilder($builder, $fqcn = false)
*
* @param string $class the class name
* @param string $namespace the namespace
* @param string|boolean $alias the alias wanted, if set to True, it automaticaly add an alias when needed
* @param string|boolean $alias the alias wanted, if set to True, it automatically adds an alias when needed
* @return string the class name or it's alias
*/
public function declareClassNamespace($class, $namespace = '', $alias = false)
Expand Down Expand Up @@ -346,7 +346,7 @@ protected function needAliasForClassName($class, $namespace)
*
* @param string $class the class
* @param string $namespace the namespace
* @param mixed $aliasPrefix optionaly an alias or True to force an automatic alias prefix (Base or Child)
* @param mixed $aliasPrefix optionally an alias or True to force an automatic alias prefix (Base or Child)
* @return string the short ClassName or an alias
*/
public function declareClassNamespacePrefix($class, $namespace = '', $aliasPrefix = false)
Expand All @@ -365,7 +365,7 @@ public function declareClassNamespacePrefix($class, $namespace = '', $aliasPrefi
* This return the short ClassName to use or an alias
*
* @param string $fullyQualifiedClassName the fully qualified classname
* @param mixed $aliasPrefix optionaly an alias or True to force an automatic alias prefix (Base or Child)
* @param mixed $aliasPrefix optionally an alias or True to force an automatic alias prefix (Base or Child)
* @return string the short ClassName or an alias
*/
public function declareClass($fullyQualifiedClassName, $aliasPrefix = false)
Expand Down
4 changes: 2 additions & 2 deletions src/Propel/Generator/Builder/Om/AbstractObjectBuilder.php
Expand Up @@ -38,7 +38,7 @@ abstract protected function addClassBody(&$script);
/**
* Adds the getter methods for the column values.
* This is here because it is probably generic enough to apply to templates being generated
* in different langauges (e.g. PHP4 and PHP5).
* in different languages (e.g. PHP4 and PHP5).
* @param string &$script The script will be modified in this method.
*/
protected function addColumnAccessorMethods(&$script)
Expand Down Expand Up @@ -75,7 +75,7 @@ protected function addColumnAccessorMethods(&$script)
/**
* Adds the mutator (setter) methods for setting column values.
* This is here because it is probably generic enough to apply to templates being generated
* in different langauges (e.g. PHP4 and PHP5).
* in different languages (e.g. PHP4 and PHP5).
* @param string &$script The script will be modified in this method.
*/
protected function addColumnMutatorMethods(&$script)
Expand Down
2 changes: 1 addition & 1 deletion src/Propel/Generator/Builder/Om/ExtensionObjectBuilder.php
Expand Up @@ -31,7 +31,7 @@ public function getUnprefixedClassName()
}

/**
* Adds class phpdoc comment and openning of class.
* Adds class phpdoc comment and opening of class.
* @param string &$script The script will be modified in this method.
*/
protected function addClassOpen(&$script)
Expand Down
2 changes: 1 addition & 1 deletion src/Propel/Generator/Builder/Om/ExtensionPeerBuilder.php
Expand Up @@ -31,7 +31,7 @@ public function getUnprefixedClassName()
}

/**
* Adds class phpdoc comment and openning of class.
* Adds class phpdoc comment and opening of class.
* @param string &$script The script will be modified in this method.
*/
protected function addClassOpen(&$script)
Expand Down
2 changes: 1 addition & 1 deletion src/Propel/Generator/Builder/Om/ExtensionQueryBuilder.php
Expand Up @@ -31,7 +31,7 @@ public function getUnprefixedClassName()
}

/**
* Adds class phpdoc comment and openning of class.
* Adds class phpdoc comment and opening of class.
* @param string &$script The script will be modified in this method.
*/
protected function addClassOpen(&$script)
Expand Down
Expand Up @@ -50,7 +50,7 @@ public function getPackage()
}

/**
* Set the child object that we're operating on currrently.
* Set the child object that we're operating on currently.
*
* @param Inheritance $child Inheritance
*/
Expand All @@ -75,7 +75,7 @@ public function getChild()
}

/**
* Adds class phpdoc comment and openning of class.
* Adds class phpdoc comment and opening of class.
*
* @param string $script
*/
Expand Down
2 changes: 1 addition & 1 deletion src/Propel/Generator/Builder/Om/InterfaceBuilder.php
Expand Up @@ -31,7 +31,7 @@ public function getUnprefixedClassName()
}

/**
* Adds class phpdoc comment and openning of class.
* Adds class phpdoc comment and opening of class.
* @param string &$script The script will be modified in this method.
*/
protected function addClassOpen(&$script)
Expand Down
4 changes: 2 additions & 2 deletions src/Propel/Generator/Builder/Om/MultiExtendObjectBuilder.php
Expand Up @@ -51,7 +51,7 @@ public function getPackage()
}

/**
* Sets the child object that we're operating on currrently.
* Sets the child object that we're operating on currently.
*
* @param Inheritance $child Inheritance
*/
Expand Down Expand Up @@ -110,7 +110,7 @@ protected function getParentClassFilePath()
}

/**
* Adds class phpdoc comment and openning of class.
* Adds class phpdoc comment and opening of class.
*
* @param string &$script
*/
Expand Down

0 comments on commit e39b741

Please sign in to comment.