Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation typos #3

Closed
mailopl opened this issue Apr 6, 2012 · 11 comments
Closed

Documentation typos #3

mailopl opened this issue Apr 6, 2012 · 11 comments

Comments

@mailopl
Copy link

mailopl commented Apr 6, 2012

I create this ticket to report documentation typos.
#1: http://phalconphp.com/documentation/controllers

function beforeDispatch(){
    if (Phalcon_Session::get("hasAuth") == true) {
      //Check whether user is authenticated and forwards him to login if not
      $this->_forward("session/login");
      return false;
    }
  }

If User has Authorization, then... redirect him to the login page :) ? If i correctly get it, should be false.
#2 http://phalconphp.com/documentation/models

'By default model "Robots" will refers to table "robots"' (refers -> refer)
As long as:
function initialize(){
$this->setSource("the_robots");
}
And comment: 'The model Robots now maps to table "the_birds"' (does it :D ?)

@phalcon
Copy link
Collaborator

phalcon commented Apr 6, 2012

Hi, you're right is now fixed ;)

@mailopl
Copy link
Author

mailopl commented Apr 6, 2012

#3 http://phalconphp.com/documentation/views
Transfer values from​the controller to views - missing space

#4 CSS -> the .source-code class
Is by default max-width: 550px; which causes horizontal scroll bar which we all do not like, thou text width appears to be significantly more than 550px. Maybe using "em", "pt" or "%" would reduce the different resolution problem and remove the horz scrolling bar.

#5 http://phalconphp.com/documentation/tags
If I correctly understand displayTo() method will set color to blue, for use by default in the selectStatic() method, which means that this code:
` Yellow Blue Red ` Is not correct -> it lacks selected="selected" attribute.

@mailopl
Copy link
Author

mailopl commented Apr 6, 2012

#6 Just an idea. http://phalconphp.com/documentation/models
It would be helpful for beginers to see an example of Model::beforeSave() which uses Phalcon_Filter(), like:

        $filter = new Phalcon_Filter();
        $filter->sanitize($this->email, "email");
        $filter->sanitize($this->some_id, "int");
        return true;
    }

@phalcon
Copy link
Collaborator

phalcon commented Apr 8, 2012

Thanks mailopl for your feedback, all of those were fixed :)

@klaussilveira
Copy link
Contributor

In which markup language is the documentation written? Maybe if you put it up on Github, we can contribute and enrich the framework documentation. And also fix bugs. :)

@phalcon
Copy link
Collaborator

phalcon commented May 9, 2012

That sounds very nice!, we are not using any sophisticated method to write documentation, it is plain php+html

@klaussilveira
Copy link
Contributor

It would be great if Phalcon could use some setup similar to this: http://readthedocs.org. The documentation could be written using RST: http://en.wikipedia.org/wiki/ReStructuredText and compiled with http://sphinx.pocoo.org/

@mailopl
Copy link
Author

mailopl commented May 11, 2012

Another one :P
http://phalconphp.com/api/class/Phalcon_Model_Base

Phalcon_Model_Resulset public static find([array $parameters=null]) -> should be Phalcon_Model_Resultset

@mailopl
Copy link
Author

mailopl commented May 11, 2012

And another (code on the top of the page):
http://phalconphp.com/api/class/Phalcon_Model_Message
$type = "InvalidValue";
$message = new Phalcon_Model_Message($text, $field, "InvalidValue");

@mailopl
Copy link
Author

mailopl commented May 11, 2012

Another one:
http://phalconphp.com/api/class/Phalcon_Model_Query
There's cut of foreach($query->get) .

@phalcon
Copy link
Collaborator

phalcon commented May 13, 2012

Thanks, those were fixed :)

@phalcon phalcon closed this as completed May 19, 2012
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants