Support

Home Forums Event Espresso Premium EE_Event class documentation errors?

EE_Event class documentation errors?

Posted: June 5, 2017 at 8:07 am

Viewing 6 reply threads


AmritYoga2015

June 5, 2017 at 8:07 am

Hi there,

there are some methods in EE_Event class that returns bool but they should be returning strings (there are more):

public boolean #phone( )
public boolean #name( )
public boolean #external_url( )

http://code.eventespresso.com/class-EE_Event.html

probably they are working ok but the documentation seams to be wrong?

thanks.


AmritYoga2015

June 5, 2017 at 9:25 am

also cant find methods to get “event start date” and “event end date”…

this might needs to be add?

/**
* @return EE_Datetime
*/
function start_date() {
return $this->get( ‘EVT_start_date’ );
}

/**
* @return EE_Datetime
*/
function end_date() {
return $this->get( ‘EVT_end_date’ );
}


Josh

  • Support Staff

June 5, 2017 at 9:40 am

Thanks for reporting. It turns out that code.eventespresso.com is out of date with the current codebase and we will be retiring it soon.

I can recommend you verify via the actual code in your IDE and/or use the code hosted on github as the reference.

You can post new issues for any further phpdoc issues you find (or even submit pull requests if you want to help) :
https://github.com/eventespresso/event-espresso-core/issues

We are currently in the midst of a slow process of verifying phpdocs and formatting of code is correct whenever we touch a file as a part of ongoing work.


AmritYoga2015

June 5, 2017 at 11:05 am

ok, looks like the github files are also out of date?

https://github.com/eventespresso/event-espresso-core/blob/c9795f12ee9c3128d0be136488446e06bce9a529/core/db_classes/EE_Event.class.php

missing methods start_date() and end_date(); documentation is also wrong like code.eventespresso.com


Josh

  • Support Staff

June 5, 2017 at 1:36 pm

No actually you’re looking at an older branch that’s out of sync with master.
You’ll need to look at either the Master branch or current release tag, those are up to date:

https://github.com/eventespresso/event-espresso-core/blob/master/core/db_classes/EE_Event.class.php


AmritYoga2015

June 8, 2017 at 12:47 pm

all this files looks the same here.

also here

https://github.com/eventespresso/event-espresso-core/blob/master/core/db_classes/EE_Event.class.php

i cant see methods to get the event start/end date…do you?


Josh

  • Support Staff

June 8, 2017 at 1:16 pm

Those are not methods within the EE_Event class. Those are methods you’ll find within the EE_Datetime class.

https://github.com/eventespresso/event-espresso-core/blob/master/core/db_classes/EE_Datetime.class.php

Viewing 6 reply threads

The support post ‘EE_Event class documentation errors?’ is closed to new replies.

Have a question about this support post? Create a new support post in our support forums and include a link to this existing support post so we can help you.

Event Espresso