propelorm / propelorm.github.com

The Propel website and documentation.

The Propel Website

https://propelorm.org/

Written in Markdown, built using Jekyll.

propelorm.github.com's Issues

Add a licence page

Propel's licence (MIT) should be written in a page in the website, so that it can be linked from the outside (e.g. pear packages).

Describe additional installation way of behaviors through composer

=> propelorm/Propel2#511

When it's merged.

Offline documentation ?

Hi

Is there a way to build the documentation pages for offline use ?

Other than mirroring the main site ?

Thanks.

Move the blog from Posterous to Jekyll

Jekyll provides a migration script for that: https://github.com/mojombo/jekyll/wiki/blog-migrations

But it will take time to fix all bugs, mainly for code examples.
Comments will be lost but not the possibility to comment if we add Disqus (http://disqus.com/).

When using "select('AttributeName')->find()" one gets a PropelArrayCollection instead of an Array

In the section http://propelorm.org/reference/model-criteria.html#getting-columns-instead-of-objects the following is mentioned:

// When you need only one column, use a column name as the select() argument
$articles = ArticleQuery::create()
->join('Category')
->select('Title')
->find();
// returns array('foo', 'bar')

However, when doing a query like the above, a PropelArrayCollection rather than an Array is returned. I then have to use the PropelArrayCollection method "toArray()" to convert it to a simple array to be able to merge it with other arrays using array_merge(...). Therefore, it seems like the comment in the above explanation should say:

// returns PropelArrayCollection(
array('foo', 'bar')
)

Besides that correction, is there a way to directly get an array rather than a PropelArrayCollection to eliminate the need to then use "toArray()"?

Documentation. Сode example

In documentation on site http://www.propelorm.org/documentation/ code example is disappear... ;) Where is it?

"search" is broken

Everything is in the title...

Setup a link to the old documentation?

I was looking for the documentation of Propel 1.2 and, before Google it, I tried to find the link on the new website. No link.

Maybe it is not that bad to add the link somewhere, at the bottom of the documentation page. Don't know.

using-sql-schemas.html not up2date

We have simulated schema support in SQLite as well.

How to test with Propel & Symfony2

A quite important part in the documentation is missing, the testing chapter. How to test with propel and symfony? How to load schema and fixtures for the test from the whole project?

the tests in propel https://github.com/propelorm/PropelBundle/blob/1.1/Tests/DataFixtures/Loader/YamlDataLoaderTest.php#L48 gives a basic info on how to test with data, but a howto, cookbook or chapter in the documentation would be quite important.

Adding a link to the API doc

For the API doc, I suggest we use DocBlox

Fixing SVN links

svn.github.com is almost no more used: https://github.com/blog/966-improved-subversion-client-support

Missing Upgrade Wiki page

I'm unfortunately not sure if this is the appropriate place to post this (and I apologise if it isn't), but the 1.2 -> 1.3 upgrade wiki page at http://trac.propelorm.org/wiki/Documentation/1.3/Upgrading has gone missing some time over the weekend. It was working fine on Friday afternoon and I was planning on using it today, but alas, no page :-/ Any chance that someone can restore/repost it, or provide a link to an alternative guide?

Working with Silex recipe

In our cookbook, Working with Silex recipe still refers to Propel 1.x

I'll update it as soon as possible.

Add a homepage link on repo or a README with link

You shoud had an easy access way to make easiest openning the generated doc in browser

Symfony 2 Cookbook uses parameters.ini instead of the new parameters.yml

Seen in cookbook/symfony2/symfony2-and-propel-in-real-life.markdown.

I know that it's for symfony 2.1, but is the PropelBundle usable with Symfony 2.0?

Refactor layouts to avoir duplication by using include

CF https://github.com/mojombo/jekyll/wiki/Liquid-Extensions.

Might also be the time to merge the three links for documentation to a single one in the main nav bar.

Add CSS versioning

The CSS of the site remains cached for 86400s - that's a whole day. When we modify the CSS, we should also modify the way it's called in the layout, to enable cachebusting.

Maybe there is a way to automate that.

Sync Symfony2 documentation with the bundle's documentation

I reworked the PropelBundle documentation in the bundle itself: https://github.com/propelorm/PropelBundle/blob/1.1/Resources/doc.

We need someone to update changes in this repository, by copying the doc from the bundle.

ping @robin850

[Symfony2] Chapter on FOSUserBundle

Thanks to @cedriclombardot, Propel is well integrated in FOSUserBundle.
It should be cool to have a chapter dedicated on it in the Propel documentation.

William

propelorm.org redirect to www.propelorm.org which redirect to propelorm.org, etc ...

There seems to be an Apache/nginx configuration problem.

• Apache wants propelorm.org -> www.propelorm.org
• Nginx wants www.propelorm.org -> propelorm.org

Wow nice infinite loop :-)

Adding a link to the plain old TRAC documentation

This issue needs Benjamin news for the server part..

Got some 403 errors on http://api.propelorm.org/ when viewing "Files".

While I was looking into olds propel version, I was getting some 403 on api.propelorm.org when I try to see Files.

Go there (for example) and click on any links beside Files: on the sidebar.

italic title with namespace

in the propel2 documentation there is some namespaces in italic, in that case the namespaces separator \ look like | I think it could be confusing.

maybe we shouldn't use italic for classname.

blog rss feed

any chance to get an rss feed with this simple blogging solution?

defaultExpr on (mysql) varchar columns

Hi,
looks like SQL generation is partially broken.

schema:
column name="foobar" type="VARCHAR" size="16" required="true" defaultValue="barfoo" defaultExpr="barfoo"

results in SQL:
foobar VARCHAR(16) DEFAULT '' NOT NULL,

on mysql platform with propel 1.6.2 from git.
Upgraded from propel 1.5.x.
Before even default="disabled" worked flawless, now neither of both seems to work.
defaultValue seems to work, though.

[RFC] Documentation, Propel & Propel2

Heya!

@robin850 and I are about to merge the Propel2 documentation, and I have one question.

A while ago, we decided to use this repository to maintain the "up to date" documentation. Also, we decided to put the Propel2 documentation into its repository.

Now, the Propel2 documentation still lives in the Propel2 repository, however this MUST change. The Propel2 documentation SHOULD live in this repository, not in the Propel2 repository.

The Propel (read 1.x) documentation lives in this repository but this SHOULD change as the upcoming major version is Propel2. So, what we suggested was to move the Propel2 documentation here, and to move the Propel documentation to the Propel repository, in a gh-pages branch, so that we can still update both documentations without any problem (well...).

Note that the Propel documentation already lives into a gh-pages branch.

Also, the Propel2 documentation will be merged soon.

I will move the Propel2 documentation/ folder to this repository if we all agree.

We will probably loose some links in the battle... I don't know how to "fix" that. All the Propel 1.x documentation is available at: http://propelorm.org/Propel. There should not be any problem as all links are relative.

@propelorm Question is: good to go for everyone?

Docu for propelorm/Propel2#476

propelorm/Propel2#476

Add a note that we change the signature of generated relations methods when we have more than two primary keys in the cross table.

whats-new.html

• PostgreSQL and SQLite migration support
• SQLite schema support
• M2N relations with more than two PKs support (PR is in work)

Adding a "support" page

Sluggable and aggregate-colum behaviors pages missing

See yourself:

• http://www.propelorm.org/behaviors/aggregate-colum
• http://www.propelorm.org/behaviors/sluggable

09-migrations.html not up2date

Propel only supports migrations in MySQL for now. for example.

Writing a real 404 page

Actually, the 404 page is used to redirect old links to trac.propelorm.org.
If there is a real "unknown link" we get a blank page... It should be cool to have a real 404 page.

Broken link in Working with Symfony2 docs

Hi

I'm working through the page here to install Propel in Symfony2:
http://www.propelorm.org/cookbook/symfony2/working-with-symfony2.html

There appears to be a broken link, near the top in the line "Jump to the Symfony2 vendor management section". There doesn't seem to be a corresponding anchor.

Cheers,
Al

$script = _;

Hello.
I found this little mistake while browsing the documentation page, in : cookbook / writing-behavior.markdown

there's

  public function objectMethods()
  {
    $script = _;
    $script .= $this->addUpdateAggregateColumn();
    return $script;
  }

I think it should be

  public function objectMethods()
  {
    $script = '';
    $script .= $this->addUpdateAggregateColumn();
    return $script;
  }

(or without '' & .=)

[Symfony2] Chapter on Validation

trac.propelorm.org is broken

It seems that there is a configuration problem on http://trac.propelorm.org/.

Add a search Engine

The main template should contain a search box, and probably use the same Google search engine as the old site.

[Symfony2][2.1] forms collection and transformer

Hi,

We need to write doc about forms collection :

if we create a form with a collection of Propel object. we need to set the CollectionToArrayTransformer for this to work with the new propel add/remove methods.

I could write it, juste need to find some time ;)

How to deal with the Propel2 documentation?

Big question that we need to think right now to be ready when we'll need to write some documentation on Propel2.

Adding a chapter on getters/setters for collections

Propel 1.6.3 is released but some documentation on the new cool feature is missing… We need to write few lines about it.

User contributed behaviours

In the old documentation, you have a page with user contributed behaviours (http://trac.propelorm.org/wiki/UsersContributedBehaviors) that does not appear on the new documentation.

Currently I'm using one of them (sfPropel15TaggableBehaviorPlugin) and works fine with Propel 1.6.2. Can this page added again to the documentation?

How can I help to add this page?

Regards

Adding a link to the blog

Remove references to old subversion repository

Example: http://www.propelorm.org/documentation/01-installation.html

Adding a Google Analytics tracker

following the official doc (working with sf2) leads to fatal error

propelorm/PropelBundle#93

Try: version=origin/2.0

thank you, that worked for me.

i would vote for adding "version=oringin/2.0" to http://www.propelorm.org/cookbook/symfony2/working-with-symfony2.html section "via Symfony2 vendor management" to make it easier for newcommers.

or even better add both to the doc, like if you use symfony from the master branch add this .... if you use stable add that.

[Website] Title section too big

On the website http://www.propelorm.org/, I find that the title section on the home page is way too big.

I propose to :

• Simply put the Propel logo at the top like the previous site design
• Keep the huge
  ...
  for SEO, but hide it to humans with CSS
• Remove the big sentence "Welcome to Propel website!" which looks like wasted space (it even reminds me some late '90s websites with their "Click here" links etc. :))

He's a proposal: http://frosty.free.fr/images/propel/header_proposal.png
Given a logo with a correct image resolution, would it be convenient?
In that case, can someone provide a hi-res Propel logo? I can't find any.

(reopened from propelorm/Propel#195)

Reverse command wrong documentation

Example: https://groups.google.com/forum/#!topic/propel-users/cREU9X9-FFk

Roadmap to Propel 2

Hello world!

I open this issue to put the roadmap to make the site efficient for Propel 2. I'm currently resolving each task (except the upgrade guide since Cristiano is on it).

• Fix the buidltime guide : The user won't be able to create the SQL structure following the different steps in the given order since the database credentials aren't yet provided.
• Bring back the Silex documentation : Commit propelorm/Propel2@1d891f0 didn't ship with the Silex documentation and it hasn't been pulled in the repository
• Update all commands' output : Note a vital issue, we can deploy without this change since it's only in few chapters.
• Write a guide to upgrade from Propel 1.x to 2.0 : Write a guide widely based on the UPDATE.md file and with the new stuff (e.g. new folder's structure).
• Check the whole documentation for deprecated mentions/code/features/anything.

ConcreteInheritanceBehavior missing "excluded_parent_behavior" parameter

There is a missing documentation for the behavior "ConcreteInheritanceBehavior" related to this issue (merged to master branch) : propelorm/Propel#664

The missed parameter is : excluded_parent_behavior, that allow you to exclude inheritance from selected behavior.