Re: ApiGenerator plugin: Exclude plugins directory... and some other questions. --psybear

2011-01-19 Thread Joshua Muheim
Thank you, Mark!

On Tue, Jan 18, 2011 at 3:00 PM, mark_story  wrote:
> Indented code blocks don't work.  You need to use fenced code blocks.
>
> {{{
> This should be code
> }}}
>
> -Mark
>
> On Jan 13, 4:22 am, Joshua Muheim  wrote:
>> And another question:
>>
>> I'd like to have code examples in my method descriptions. I know that
>> I can put them into back ticks for inline code, but it seems I can't
>> create blocks of code using 4 spaces?!
>>
>>   /**
>>    * Constructor.
>>    *
>>    *    This should be code
>>    */
>>
>> Thanks for informations.
>>
>>
>>
>>
>>
>>
>>
>> On Thu, Jan 13, 2011 at 9:32 AM, psybear83  wrote:
>> > Hey everybody
>>
>> > I'm trying to get the ApiGenerator plugin to do what I want. I have
>> > placed it in myapp/app/plugins, and built the index using
>>
>> > cake api_index update
>>
>> > Now I have some problems...
>>
>> > 1) I don't want the ApiGenerator to generate the API for the myapp/
>> > plugins directory, because in there is the ApiGenerator itself, and I
>> > don't want my generated API to be cluttered up with ApiGenerator's
>> > API. I tried moving the plugin to myapp/plugins, but then when running
>>
>> > cake api_index update
>>
>> > it doesn't find the database configuration anymore. I guess I haven't
>> > really understood how myapp/plugins and myapp/app/plugins differ in
>> > what they really are meant to be...?
>>
>> > 2) I'm writing a custom library in OOP PHP5 that is placed in myapp/
>> > app/libs. Some of these files are found by ApiGenerator, but others
>> > aren't, and I'm not able to find the reason.
>>
>> > For example, Einsatz class is found:
>>
>> > myapp/app/libs/einsatz.php
>> > > > /**
>> >  * Einsatz File.
>> >  *
>> >  * PHP version 5
>> >  * CakePHP version 1.3
>> >  *
>> >  * @package    zivisim
>> >  * @subpackage zivisim.libs
>> >  */
>>
>> > /**
>> >  * Included libs
>> >  */
>> > App::import('Lib', array('OptionsSetter'));
>>
>> > /**
>> >  * Einsatz Class.
>> >  *
>> >  * @package    zivisim
>> >  * @subpackage zivisim.libs
>> >  */
>> > class Einsatz extends OptionsSetter {
>> >  ...
>> > }
>> > ?>
>>
>> > But DiensttageCalculator isn't:
>> > myapp/app/libs/diensttage_calculator.php
>> > > > /**
>> >  * DiensttageCalculator File.
>> >  *
>> >  * PHP version 5
>> >  * CakePHP version 1.3
>> >  *
>> >  * @package    zivisim
>> >  * @subpackage zivisim.libs
>> >  */
>>
>> > /**
>> >  * Included libs
>> >  */
>> > App::import('Lib', array('OptionsSetter'));
>>
>> > /**
>> >  * DiensttageCalculator Class.
>> >  *
>> >  * @package    zivisim
>> >  * @subpackage zivisim.libs
>> >  */
>> > abstract class DiensttageCalculator extends OptionsSetter {
>> >  ...
>> > }
>> > ?>
>>
>> > I can't see any significant difference between the two files and their
>> > content. Maybe someone of you can point me into the right direction?
>>
>> > Thanks
>> > Josh
>>
>> > Check out the new CakePHP Questions sitehttp://cakeqs.organd help others 
>> > with their CakePHP related questions.
>>
>> > You received this message because you are subscribed to the Google Groups 
>> > "CakePHP" group.
>> > To post to this group, send email to cake-php@googlegroups.com
>> > To unsubscribe from this group, send email to
>> > cake-php+unsubscr...@googlegroups.com For more options, visit this group 
>> > athttp://groups.google.com/group/cake-php?hl=en
>
> Check out the new CakePHP Questions site http://cakeqs.org and help others 
> with their CakePHP related questions.
>
> You received this message because you are subscribed to the Google Groups 
> "CakePHP" group.
> To post to this group, send email to cake-php@googlegroups.com
> To unsubscribe from this group, send email to
> cake-php+unsubscr...@googlegroups.com For more options, visit this group at 
> http://groups.google.com/group/cake-php?hl=en
>

-- 
Our newest site for the community: CakePHP Video Tutorials 
http://tv.cakephp.org 
Check out the new CakePHP Questions site http://ask.cakephp.org and help others 
with their CakePHP related questions.


To unsubscribe from this group, send email to
cake-php+unsubscr...@googlegroups.com For more options, visit this group at 
http://groups.google.com/group/cake-php


Re: ApiGenerator plugin: Exclude plugins directory... and some other questions. --psybear

2011-01-18 Thread mark_story
Indented code blocks don't work.  You need to use fenced code blocks.

{{{
This should be code
}}}

-Mark

On Jan 13, 4:22 am, Joshua Muheim  wrote:
> And another question:
>
> I'd like to have code examples in my method descriptions. I know that
> I can put them into back ticks for inline code, but it seems I can't
> create blocks of code using 4 spaces?!
>
>   /**
>    * Constructor.
>    *
>    *    This should be code
>    */
>
> Thanks for informations.
>
>
>
>
>
>
>
> On Thu, Jan 13, 2011 at 9:32 AM, psybear83  wrote:
> > Hey everybody
>
> > I'm trying to get the ApiGenerator plugin to do what I want. I have
> > placed it in myapp/app/plugins, and built the index using
>
> > cake api_index update
>
> > Now I have some problems...
>
> > 1) I don't want the ApiGenerator to generate the API for the myapp/
> > plugins directory, because in there is the ApiGenerator itself, and I
> > don't want my generated API to be cluttered up with ApiGenerator's
> > API. I tried moving the plugin to myapp/plugins, but then when running
>
> > cake api_index update
>
> > it doesn't find the database configuration anymore. I guess I haven't
> > really understood how myapp/plugins and myapp/app/plugins differ in
> > what they really are meant to be...?
>
> > 2) I'm writing a custom library in OOP PHP5 that is placed in myapp/
> > app/libs. Some of these files are found by ApiGenerator, but others
> > aren't, and I'm not able to find the reason.
>
> > For example, Einsatz class is found:
>
> > myapp/app/libs/einsatz.php
> >  > /**
> >  * Einsatz File.
> >  *
> >  * PHP version 5
> >  * CakePHP version 1.3
> >  *
> >  * @package    zivisim
> >  * @subpackage zivisim.libs
> >  */
>
> > /**
> >  * Included libs
> >  */
> > App::import('Lib', array('OptionsSetter'));
>
> > /**
> >  * Einsatz Class.
> >  *
> >  * @package    zivisim
> >  * @subpackage zivisim.libs
> >  */
> > class Einsatz extends OptionsSetter {
> >  ...
> > }
> > ?>
>
> > But DiensttageCalculator isn't:
> > myapp/app/libs/diensttage_calculator.php
> >  > /**
> >  * DiensttageCalculator File.
> >  *
> >  * PHP version 5
> >  * CakePHP version 1.3
> >  *
> >  * @package    zivisim
> >  * @subpackage zivisim.libs
> >  */
>
> > /**
> >  * Included libs
> >  */
> > App::import('Lib', array('OptionsSetter'));
>
> > /**
> >  * DiensttageCalculator Class.
> >  *
> >  * @package    zivisim
> >  * @subpackage zivisim.libs
> >  */
> > abstract class DiensttageCalculator extends OptionsSetter {
> >  ...
> > }
> > ?>
>
> > I can't see any significant difference between the two files and their
> > content. Maybe someone of you can point me into the right direction?
>
> > Thanks
> > Josh
>
> > Check out the new CakePHP Questions sitehttp://cakeqs.organd help others 
> > with their CakePHP related questions.
>
> > You received this message because you are subscribed to the Google Groups 
> > "CakePHP" group.
> > To post to this group, send email to cake-php@googlegroups.com
> > To unsubscribe from this group, send email to
> > cake-php+unsubscr...@googlegroups.com For more options, visit this group 
> > athttp://groups.google.com/group/cake-php?hl=en

Check out the new CakePHP Questions site http://cakeqs.org and help others with 
their CakePHP related questions.

You received this message because you are subscribed to the Google Groups 
"CakePHP" group.
To post to this group, send email to cake-php@googlegroups.com
To unsubscribe from this group, send email to
cake-php+unsubscr...@googlegroups.com For more options, visit this group at 
http://groups.google.com/group/cake-php?hl=en


Re: ApiGenerator plugin: Exclude plugins directory... and some other questions. --psybear

2011-01-18 Thread Joshua Muheim
OK, the problem why the generator didn't seem to find all the needed
files, was that I didn't use the correct folder structure convention.

class A // needs to be in e.g. libs/a.php
class B extends A // needs to be in libs/a/b.php

If you do that, all the App::import() calls still seem to work, which
is very nice.

I'm learning a lot about clean coding and obeying the "convention
rules" by trying to document properly - it's a bit of the crux of
loosely regulated languages like PHP, that one can hack stuff together
quickly and dirty, and this way one really has to force oneself to
learn about clean coding and leave old "dirty" roads... :-)

I can suggest to everyone to use api generator, it is a very useful tool.

On Mon, Jan 17, 2011 at 4:54 PM, Joshua Muheim  wrote:
> Thanks, Mikek, this already helps a lot!
>
> On Mon, Jan 17, 2011 at 4:46 PM,   wrote:
>>> Isn't there anybody using ApiGenerator?
>>
>> there is.
>>
>> to exclude various stuff. make sure you have an [exclude] added to your
>> api_config.ini in api_generator/config/
>>
>> mine is below:
>>
>> [exclude]
>> properties = private
>> methods = private
>> directories = webroot, tmp, static, locale, vendors, .svn, plugins
>> files = index.php, empty
>>
>> I dont know the answers to your other questions.
>>
>> regards
>> mikek
>>
>>
>>
>>
>>> On Thu, Jan 13, 2011 at 11:28 AM, Joshua Muheim 
>>> wrote:
 Another one:

 I have constants in my classes like so:

  /**
   * Grenze, nach welchem Lebensjahr der Zivi höchstens noch 26
 Diensttage pro Folgejahr bis Dienstende aufweisen darf.
   *
   * @var int
   */
  const AUFRAEUM_ALTER_IN_JAHREN = 27;

 But they don't seem to be considered in the documentation. Is this
 normal? Aren't constants added to the API documentation?

 On Thu, Jan 13, 2011 at 10:22 AM, Joshua Muheim 
 wrote:
> And another question:
>
> I'd like to have code examples in my method descriptions. I know that
> I can put them into back ticks for inline code, but it seems I can't
> create blocks of code using 4 spaces?!
>
>  /**
>   * Constructor.
>   *
>   *    This should be code
>   */
>
> Thanks for informations.
>
> On Thu, Jan 13, 2011 at 9:32 AM, psybear83  wrote:
>> Hey everybody
>>
>> I'm trying to get the ApiGenerator plugin to do what I want. I have
>> placed it in myapp/app/plugins, and built the index using
>>
>> cake api_index update
>>
>> Now I have some problems...
>>
>> 1) I don't want the ApiGenerator to generate the API for the myapp/
>> plugins directory, because in there is the ApiGenerator itself, and I
>> don't want my generated API to be cluttered up with ApiGenerator's
>> API. I tried moving the plugin to myapp/plugins, but then when running
>>
>> cake api_index update
>>
>> it doesn't find the database configuration anymore. I guess I haven't
>> really understood how myapp/plugins and myapp/app/plugins differ in
>> what they really are meant to be...?
>>
>> 2) I'm writing a custom library in OOP PHP5 that is placed in myapp/
>> app/libs. Some of these files are found by ApiGenerator, but others
>> aren't, and I'm not able to find the reason.
>>
>> For example, Einsatz class is found:
>>
>> myapp/app/libs/einsatz.php
>> > /**
>>  * Einsatz File.
>>  *
>>  * PHP version 5
>>  * CakePHP version 1.3
>>  *
>>  * @package    zivisim
>>  * @subpackage zivisim.libs
>>  */
>>
>> /**
>>  * Included libs
>>  */
>> App::import('Lib', array('OptionsSetter'));
>>
>> /**
>>  * Einsatz Class.
>>  *
>>  * @package    zivisim
>>  * @subpackage zivisim.libs
>>  */
>> class Einsatz extends OptionsSetter {
>>  ...
>> }
>> ?>
>>
>> But DiensttageCalculator isn't:
>> myapp/app/libs/diensttage_calculator.php
>> > /**
>>  * DiensttageCalculator File.
>>  *
>>  * PHP version 5
>>  * CakePHP version 1.3
>>  *
>>  * @package    zivisim
>>  * @subpackage zivisim.libs
>>  */
>>
>> /**
>>  * Included libs
>>  */
>> App::import('Lib', array('OptionsSetter'));
>>
>> /**
>>  * DiensttageCalculator Class.
>>  *
>>  * @package    zivisim
>>  * @subpackage zivisim.libs
>>  */
>> abstract class DiensttageCalculator extends OptionsSetter {
>>  ...
>> }
>> ?>
>>
>> I can't see any significant difference between the two files and their
>> content. Maybe someone of you can point me into the right direction?
>>
>> Thanks
>> Josh
>>
>> Check out the new CakePHP Questions site http://cakeqs.org and help
>> others with their CakePHP related questions.
>>
>> You received this message because you are subscribed to the Google
>> Groups "CakePHP" group.
>> To p

Re: ApiGenerator plugin: Exclude plugins directory... and some other questions. --psybear

2011-01-17 Thread Joshua Muheim
Thanks, Mikek, this already helps a lot!

On Mon, Jan 17, 2011 at 4:46 PM,   wrote:
>> Isn't there anybody using ApiGenerator?
>
> there is.
>
> to exclude various stuff. make sure you have an [exclude] added to your
> api_config.ini in api_generator/config/
>
> mine is below:
>
> [exclude]
> properties = private
> methods = private
> directories = webroot, tmp, static, locale, vendors, .svn, plugins
> files = index.php, empty
>
> I dont know the answers to your other questions.
>
> regards
> mikek
>
>
>
>
>> On Thu, Jan 13, 2011 at 11:28 AM, Joshua Muheim 
>> wrote:
>>> Another one:
>>>
>>> I have constants in my classes like so:
>>>
>>>  /**
>>>   * Grenze, nach welchem Lebensjahr der Zivi höchstens noch 26
>>> Diensttage pro Folgejahr bis Dienstende aufweisen darf.
>>>   *
>>>   * @var int
>>>   */
>>>  const AUFRAEUM_ALTER_IN_JAHREN = 27;
>>>
>>> But they don't seem to be considered in the documentation. Is this
>>> normal? Aren't constants added to the API documentation?
>>>
>>> On Thu, Jan 13, 2011 at 10:22 AM, Joshua Muheim 
>>> wrote:
 And another question:

 I'd like to have code examples in my method descriptions. I know that
 I can put them into back ticks for inline code, but it seems I can't
 create blocks of code using 4 spaces?!

  /**
   * Constructor.
   *
   *    This should be code
   */

 Thanks for informations.

 On Thu, Jan 13, 2011 at 9:32 AM, psybear83  wrote:
> Hey everybody
>
> I'm trying to get the ApiGenerator plugin to do what I want. I have
> placed it in myapp/app/plugins, and built the index using
>
> cake api_index update
>
> Now I have some problems...
>
> 1) I don't want the ApiGenerator to generate the API for the myapp/
> plugins directory, because in there is the ApiGenerator itself, and I
> don't want my generated API to be cluttered up with ApiGenerator's
> API. I tried moving the plugin to myapp/plugins, but then when running
>
> cake api_index update
>
> it doesn't find the database configuration anymore. I guess I haven't
> really understood how myapp/plugins and myapp/app/plugins differ in
> what they really are meant to be...?
>
> 2) I'm writing a custom library in OOP PHP5 that is placed in myapp/
> app/libs. Some of these files are found by ApiGenerator, but others
> aren't, and I'm not able to find the reason.
>
> For example, Einsatz class is found:
>
> myapp/app/libs/einsatz.php
>  /**
>  * Einsatz File.
>  *
>  * PHP version 5
>  * CakePHP version 1.3
>  *
>  * @package    zivisim
>  * @subpackage zivisim.libs
>  */
>
> /**
>  * Included libs
>  */
> App::import('Lib', array('OptionsSetter'));
>
> /**
>  * Einsatz Class.
>  *
>  * @package    zivisim
>  * @subpackage zivisim.libs
>  */
> class Einsatz extends OptionsSetter {
>  ...
> }
> ?>
>
> But DiensttageCalculator isn't:
> myapp/app/libs/diensttage_calculator.php
>  /**
>  * DiensttageCalculator File.
>  *
>  * PHP version 5
>  * CakePHP version 1.3
>  *
>  * @package    zivisim
>  * @subpackage zivisim.libs
>  */
>
> /**
>  * Included libs
>  */
> App::import('Lib', array('OptionsSetter'));
>
> /**
>  * DiensttageCalculator Class.
>  *
>  * @package    zivisim
>  * @subpackage zivisim.libs
>  */
> abstract class DiensttageCalculator extends OptionsSetter {
>  ...
> }
> ?>
>
> I can't see any significant difference between the two files and their
> content. Maybe someone of you can point me into the right direction?
>
> Thanks
> Josh
>
> Check out the new CakePHP Questions site http://cakeqs.org and help
> others with their CakePHP related questions.
>
> You received this message because you are subscribed to the Google
> Groups "CakePHP" group.
> To post to this group, send email to cake-php@googlegroups.com
> To unsubscribe from this group, send email to
> cake-php+unsubscr...@googlegroups.com For more options, visit this
> group at http://groups.google.com/group/cake-php?hl=en
>

>>>
>>
>> Check out the new CakePHP Questions site http://cakeqs.org and help others
>> with their CakePHP related questions.
>>
>> You received this message because you are subscribed to the Google Groups
>> "CakePHP" group.
>> To post to this group, send email to cake-php@googlegroups.com
>> To unsubscribe from this group, send email to
>> cake-php+unsubscr...@googlegroups.com For more options, visit this group
>> at http://groups.google.com/group/cake-php?hl=en
>>
>>
>
>
> Check out the new CakePHP Questions site http://cakeqs.org and help others 
> with their CakePHP related questions.
>
> You received this message because you are subscribed to the Google Groups 
> "

Re: ApiGenerator plugin: Exclude plugins directory... and some other questions. --psybear

2011-01-17 Thread mikek
> Isn't there anybody using ApiGenerator?

there is.

to exclude various stuff. make sure you have an [exclude] added to your
api_config.ini in api_generator/config/

mine is below:

[exclude]
properties = private
methods = private
directories = webroot, tmp, static, locale, vendors, .svn, plugins
files = index.php, empty

I dont know the answers to your other questions.

regards
mikek




> On Thu, Jan 13, 2011 at 11:28 AM, Joshua Muheim 
> wrote:
>> Another one:
>>
>> I have constants in my classes like so:
>>
>>  /**
>>   * Grenze, nach welchem Lebensjahr der Zivi höchstens noch 26
>> Diensttage pro Folgejahr bis Dienstende aufweisen darf.
>>   *
>>   * @var int
>>   */
>>  const AUFRAEUM_ALTER_IN_JAHREN = 27;
>>
>> But they don't seem to be considered in the documentation. Is this
>> normal? Aren't constants added to the API documentation?
>>
>> On Thu, Jan 13, 2011 at 10:22 AM, Joshua Muheim 
>> wrote:
>>> And another question:
>>>
>>> I'd like to have code examples in my method descriptions. I know that
>>> I can put them into back ticks for inline code, but it seems I can't
>>> create blocks of code using 4 spaces?!
>>>
>>>  /**
>>>   * Constructor.
>>>   *
>>>   *    This should be code
>>>   */
>>>
>>> Thanks for informations.
>>>
>>> On Thu, Jan 13, 2011 at 9:32 AM, psybear83  wrote:
 Hey everybody

 I'm trying to get the ApiGenerator plugin to do what I want. I have
 placed it in myapp/app/plugins, and built the index using

 cake api_index update

 Now I have some problems...

 1) I don't want the ApiGenerator to generate the API for the myapp/
 plugins directory, because in there is the ApiGenerator itself, and I
 don't want my generated API to be cluttered up with ApiGenerator's
 API. I tried moving the plugin to myapp/plugins, but then when running

 cake api_index update

 it doesn't find the database configuration anymore. I guess I haven't
 really understood how myapp/plugins and myapp/app/plugins differ in
 what they really are meant to be...?

 2) I'm writing a custom library in OOP PHP5 that is placed in myapp/
 app/libs. Some of these files are found by ApiGenerator, but others
 aren't, and I'm not able to find the reason.

 For example, Einsatz class is found:

 myapp/app/libs/einsatz.php
 >>> /**
  * Einsatz File.
  *
  * PHP version 5
  * CakePHP version 1.3
  *
  * @package    zivisim
  * @subpackage zivisim.libs
  */

 /**
  * Included libs
  */
 App::import('Lib', array('OptionsSetter'));

 /**
  * Einsatz Class.
  *
  * @package    zivisim
  * @subpackage zivisim.libs
  */
 class Einsatz extends OptionsSetter {
  ...
 }
 ?>

 But DiensttageCalculator isn't:
 myapp/app/libs/diensttage_calculator.php
 >>> /**
  * DiensttageCalculator File.
  *
  * PHP version 5
  * CakePHP version 1.3
  *
  * @package    zivisim
  * @subpackage zivisim.libs
  */

 /**
  * Included libs
  */
 App::import('Lib', array('OptionsSetter'));

 /**
  * DiensttageCalculator Class.
  *
  * @package    zivisim
  * @subpackage zivisim.libs
  */
 abstract class DiensttageCalculator extends OptionsSetter {
  ...
 }
 ?>

 I can't see any significant difference between the two files and their
 content. Maybe someone of you can point me into the right direction?

 Thanks
 Josh

 Check out the new CakePHP Questions site http://cakeqs.org and help
 others with their CakePHP related questions.

 You received this message because you are subscribed to the Google
 Groups "CakePHP" group.
 To post to this group, send email to cake-php@googlegroups.com
 To unsubscribe from this group, send email to
 cake-php+unsubscr...@googlegroups.com For more options, visit this
 group at http://groups.google.com/group/cake-php?hl=en

>>>
>>
>
> Check out the new CakePHP Questions site http://cakeqs.org and help others
> with their CakePHP related questions.
>
> You received this message because you are subscribed to the Google Groups
> "CakePHP" group.
> To post to this group, send email to cake-php@googlegroups.com
> To unsubscribe from this group, send email to
> cake-php+unsubscr...@googlegroups.com For more options, visit this group
> at http://groups.google.com/group/cake-php?hl=en
>
>


Check out the new CakePHP Questions site http://cakeqs.org and help others with 
their CakePHP related questions.

You received this message because you are subscribed to the Google Groups 
"CakePHP" group.
To post to this group, send email to cake-php@googlegroups.com
To unsubscribe from this group, send email to
cake-php+unsubscr...@googlegroups.com For more options, visit this group at 
http://groups.google.com/group/cake-php?hl=en


Re: ApiGenerator plugin: Exclude plugins directory... and some other questions. --psybear

2011-01-17 Thread Joshua Muheim
Isn't there anybody using ApiGenerator?

On Thu, Jan 13, 2011 at 11:28 AM, Joshua Muheim  wrote:
> Another one:
>
> I have constants in my classes like so:
>
>  /**
>   * Grenze, nach welchem Lebensjahr der Zivi höchstens noch 26
> Diensttage pro Folgejahr bis Dienstende aufweisen darf.
>   *
>   * @var int
>   */
>  const AUFRAEUM_ALTER_IN_JAHREN = 27;
>
> But they don't seem to be considered in the documentation. Is this
> normal? Aren't constants added to the API documentation?
>
> On Thu, Jan 13, 2011 at 10:22 AM, Joshua Muheim  wrote:
>> And another question:
>>
>> I'd like to have code examples in my method descriptions. I know that
>> I can put them into back ticks for inline code, but it seems I can't
>> create blocks of code using 4 spaces?!
>>
>>  /**
>>   * Constructor.
>>   *
>>   *    This should be code
>>   */
>>
>> Thanks for informations.
>>
>> On Thu, Jan 13, 2011 at 9:32 AM, psybear83  wrote:
>>> Hey everybody
>>>
>>> I'm trying to get the ApiGenerator plugin to do what I want. I have
>>> placed it in myapp/app/plugins, and built the index using
>>>
>>> cake api_index update
>>>
>>> Now I have some problems...
>>>
>>> 1) I don't want the ApiGenerator to generate the API for the myapp/
>>> plugins directory, because in there is the ApiGenerator itself, and I
>>> don't want my generated API to be cluttered up with ApiGenerator's
>>> API. I tried moving the plugin to myapp/plugins, but then when running
>>>
>>> cake api_index update
>>>
>>> it doesn't find the database configuration anymore. I guess I haven't
>>> really understood how myapp/plugins and myapp/app/plugins differ in
>>> what they really are meant to be...?
>>>
>>> 2) I'm writing a custom library in OOP PHP5 that is placed in myapp/
>>> app/libs. Some of these files are found by ApiGenerator, but others
>>> aren't, and I'm not able to find the reason.
>>>
>>> For example, Einsatz class is found:
>>>
>>> myapp/app/libs/einsatz.php
>>> >> /**
>>>  * Einsatz File.
>>>  *
>>>  * PHP version 5
>>>  * CakePHP version 1.3
>>>  *
>>>  * @package    zivisim
>>>  * @subpackage zivisim.libs
>>>  */
>>>
>>> /**
>>>  * Included libs
>>>  */
>>> App::import('Lib', array('OptionsSetter'));
>>>
>>> /**
>>>  * Einsatz Class.
>>>  *
>>>  * @package    zivisim
>>>  * @subpackage zivisim.libs
>>>  */
>>> class Einsatz extends OptionsSetter {
>>>  ...
>>> }
>>> ?>
>>>
>>> But DiensttageCalculator isn't:
>>> myapp/app/libs/diensttage_calculator.php
>>> >> /**
>>>  * DiensttageCalculator File.
>>>  *
>>>  * PHP version 5
>>>  * CakePHP version 1.3
>>>  *
>>>  * @package    zivisim
>>>  * @subpackage zivisim.libs
>>>  */
>>>
>>> /**
>>>  * Included libs
>>>  */
>>> App::import('Lib', array('OptionsSetter'));
>>>
>>> /**
>>>  * DiensttageCalculator Class.
>>>  *
>>>  * @package    zivisim
>>>  * @subpackage zivisim.libs
>>>  */
>>> abstract class DiensttageCalculator extends OptionsSetter {
>>>  ...
>>> }
>>> ?>
>>>
>>> I can't see any significant difference between the two files and their
>>> content. Maybe someone of you can point me into the right direction?
>>>
>>> Thanks
>>> Josh
>>>
>>> Check out the new CakePHP Questions site http://cakeqs.org and help others 
>>> with their CakePHP related questions.
>>>
>>> You received this message because you are subscribed to the Google Groups 
>>> "CakePHP" group.
>>> To post to this group, send email to cake-php@googlegroups.com
>>> To unsubscribe from this group, send email to
>>> cake-php+unsubscr...@googlegroups.com For more options, visit this group at 
>>> http://groups.google.com/group/cake-php?hl=en
>>>
>>
>

Check out the new CakePHP Questions site http://cakeqs.org and help others with 
their CakePHP related questions.

You received this message because you are subscribed to the Google Groups 
"CakePHP" group.
To post to this group, send email to cake-php@googlegroups.com
To unsubscribe from this group, send email to
cake-php+unsubscr...@googlegroups.com For more options, visit this group at 
http://groups.google.com/group/cake-php?hl=en


Re: ApiGenerator plugin: Exclude plugins directory... and some other questions. --psybear

2011-01-13 Thread Joshua Muheim
Another one:

I have constants in my classes like so:

  /**
   * Grenze, nach welchem Lebensjahr der Zivi höchstens noch 26
Diensttage pro Folgejahr bis Dienstende aufweisen darf.
   *
   * @var int
   */
  const AUFRAEUM_ALTER_IN_JAHREN = 27;

But they don't seem to be considered in the documentation. Is this
normal? Aren't constants added to the API documentation?

On Thu, Jan 13, 2011 at 10:22 AM, Joshua Muheim  wrote:
> And another question:
>
> I'd like to have code examples in my method descriptions. I know that
> I can put them into back ticks for inline code, but it seems I can't
> create blocks of code using 4 spaces?!
>
>  /**
>   * Constructor.
>   *
>   *    This should be code
>   */
>
> Thanks for informations.
>
> On Thu, Jan 13, 2011 at 9:32 AM, psybear83  wrote:
>> Hey everybody
>>
>> I'm trying to get the ApiGenerator plugin to do what I want. I have
>> placed it in myapp/app/plugins, and built the index using
>>
>> cake api_index update
>>
>> Now I have some problems...
>>
>> 1) I don't want the ApiGenerator to generate the API for the myapp/
>> plugins directory, because in there is the ApiGenerator itself, and I
>> don't want my generated API to be cluttered up with ApiGenerator's
>> API. I tried moving the plugin to myapp/plugins, but then when running
>>
>> cake api_index update
>>
>> it doesn't find the database configuration anymore. I guess I haven't
>> really understood how myapp/plugins and myapp/app/plugins differ in
>> what they really are meant to be...?
>>
>> 2) I'm writing a custom library in OOP PHP5 that is placed in myapp/
>> app/libs. Some of these files are found by ApiGenerator, but others
>> aren't, and I'm not able to find the reason.
>>
>> For example, Einsatz class is found:
>>
>> myapp/app/libs/einsatz.php
>> > /**
>>  * Einsatz File.
>>  *
>>  * PHP version 5
>>  * CakePHP version 1.3
>>  *
>>  * @package    zivisim
>>  * @subpackage zivisim.libs
>>  */
>>
>> /**
>>  * Included libs
>>  */
>> App::import('Lib', array('OptionsSetter'));
>>
>> /**
>>  * Einsatz Class.
>>  *
>>  * @package    zivisim
>>  * @subpackage zivisim.libs
>>  */
>> class Einsatz extends OptionsSetter {
>>  ...
>> }
>> ?>
>>
>> But DiensttageCalculator isn't:
>> myapp/app/libs/diensttage_calculator.php
>> > /**
>>  * DiensttageCalculator File.
>>  *
>>  * PHP version 5
>>  * CakePHP version 1.3
>>  *
>>  * @package    zivisim
>>  * @subpackage zivisim.libs
>>  */
>>
>> /**
>>  * Included libs
>>  */
>> App::import('Lib', array('OptionsSetter'));
>>
>> /**
>>  * DiensttageCalculator Class.
>>  *
>>  * @package    zivisim
>>  * @subpackage zivisim.libs
>>  */
>> abstract class DiensttageCalculator extends OptionsSetter {
>>  ...
>> }
>> ?>
>>
>> I can't see any significant difference between the two files and their
>> content. Maybe someone of you can point me into the right direction?
>>
>> Thanks
>> Josh
>>
>> Check out the new CakePHP Questions site http://cakeqs.org and help others 
>> with their CakePHP related questions.
>>
>> You received this message because you are subscribed to the Google Groups 
>> "CakePHP" group.
>> To post to this group, send email to cake-php@googlegroups.com
>> To unsubscribe from this group, send email to
>> cake-php+unsubscr...@googlegroups.com For more options, visit this group at 
>> http://groups.google.com/group/cake-php?hl=en
>>
>

Check out the new CakePHP Questions site http://cakeqs.org and help others with 
their CakePHP related questions.

You received this message because you are subscribed to the Google Groups 
"CakePHP" group.
To post to this group, send email to cake-php@googlegroups.com
To unsubscribe from this group, send email to
cake-php+unsubscr...@googlegroups.com For more options, visit this group at 
http://groups.google.com/group/cake-php?hl=en


Re: ApiGenerator plugin: Exclude plugins directory... and some other questions. --psybear

2011-01-13 Thread Joshua Muheim
And another question:

I'd like to have code examples in my method descriptions. I know that
I can put them into back ticks for inline code, but it seems I can't
create blocks of code using 4 spaces?!

  /**
   * Constructor.
   *
   *This should be code
   */

Thanks for informations.

On Thu, Jan 13, 2011 at 9:32 AM, psybear83  wrote:
> Hey everybody
>
> I'm trying to get the ApiGenerator plugin to do what I want. I have
> placed it in myapp/app/plugins, and built the index using
>
> cake api_index update
>
> Now I have some problems...
>
> 1) I don't want the ApiGenerator to generate the API for the myapp/
> plugins directory, because in there is the ApiGenerator itself, and I
> don't want my generated API to be cluttered up with ApiGenerator's
> API. I tried moving the plugin to myapp/plugins, but then when running
>
> cake api_index update
>
> it doesn't find the database configuration anymore. I guess I haven't
> really understood how myapp/plugins and myapp/app/plugins differ in
> what they really are meant to be...?
>
> 2) I'm writing a custom library in OOP PHP5 that is placed in myapp/
> app/libs. Some of these files are found by ApiGenerator, but others
> aren't, and I'm not able to find the reason.
>
> For example, Einsatz class is found:
>
> myapp/app/libs/einsatz.php
>  /**
>  * Einsatz File.
>  *
>  * PHP version 5
>  * CakePHP version 1.3
>  *
>  * @package    zivisim
>  * @subpackage zivisim.libs
>  */
>
> /**
>  * Included libs
>  */
> App::import('Lib', array('OptionsSetter'));
>
> /**
>  * Einsatz Class.
>  *
>  * @package    zivisim
>  * @subpackage zivisim.libs
>  */
> class Einsatz extends OptionsSetter {
>  ...
> }
> ?>
>
> But DiensttageCalculator isn't:
> myapp/app/libs/diensttage_calculator.php
>  /**
>  * DiensttageCalculator File.
>  *
>  * PHP version 5
>  * CakePHP version 1.3
>  *
>  * @package    zivisim
>  * @subpackage zivisim.libs
>  */
>
> /**
>  * Included libs
>  */
> App::import('Lib', array('OptionsSetter'));
>
> /**
>  * DiensttageCalculator Class.
>  *
>  * @package    zivisim
>  * @subpackage zivisim.libs
>  */
> abstract class DiensttageCalculator extends OptionsSetter {
>  ...
> }
> ?>
>
> I can't see any significant difference between the two files and their
> content. Maybe someone of you can point me into the right direction?
>
> Thanks
> Josh
>
> Check out the new CakePHP Questions site http://cakeqs.org and help others 
> with their CakePHP related questions.
>
> You received this message because you are subscribed to the Google Groups 
> "CakePHP" group.
> To post to this group, send email to cake-php@googlegroups.com
> To unsubscribe from this group, send email to
> cake-php+unsubscr...@googlegroups.com For more options, visit this group at 
> http://groups.google.com/group/cake-php?hl=en
>

Check out the new CakePHP Questions site http://cakeqs.org and help others with 
their CakePHP related questions.

You received this message because you are subscribed to the Google Groups 
"CakePHP" group.
To post to this group, send email to cake-php@googlegroups.com
To unsubscribe from this group, send email to
cake-php+unsubscr...@googlegroups.com For more options, visit this group at 
http://groups.google.com/group/cake-php?hl=en